le_tty.h

Go to the documentation of this file.

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------

#ifndef LEGATO_TTY_H_INCLUDE_GUARD
#define LEGATO_TTY_H_INCLUDE_GUARD

typedef enum
{
    LE_TTY_FLOW_CONTROL_NONE = 0,
    LE_TTY_FLOW_CONTROL_XON_XOFF = 1,
    LE_TTY_FLOW_CONTROL_HARDWARE = 2
}
tty_FlowControl_t;

//--------------------------------------------------------------------------------------------------
/*
 * Use Bxxxxxx constants from termbits.h to indicate baud rate.
 */
//--------------------------------------------------------------------------------------------------
typedef enum
{
    LE_TTY_SPEED_0 = 0,
    LE_TTY_SPEED_50,
    LE_TTY_SPEED_75,
    LE_TTY_SPEED_110,
    LE_TTY_SPEED_134,
    LE_TTY_SPEED_150,
    LE_TTY_SPEED_200,
    LE_TTY_SPEED_300,
    LE_TTY_SPEED_600,
    LE_TTY_SPEED_1200,
    LE_TTY_SPEED_1800,
    LE_TTY_SPEED_2400,
    LE_TTY_SPEED_4800,
    LE_TTY_SPEED_9600,
    LE_TTY_SPEED_19200,
    LE_TTY_SPEED_38400,
    LE_TTY_SPEED_57600,
    LE_TTY_SPEED_115200,
    LE_TTY_SPEED_230400,
    LE_TTY_SPEED_460800,
    LE_TTY_SPEED_500000,
    LE_TTY_SPEED_576000,
    LE_TTY_SPEED_921600,
    LE_TTY_SPEED_1000000,
    LE_TTY_SPEED_1152000,
    LE_TTY_SPEED_1500000,
    LE_TTY_SPEED_2000000,
    LE_TTY_SPEED_2500000,
    LE_TTY_SPEED_3000000,
    LE_TTY_SPEED_3500000,
    LE_TTY_SPEED_4000000
}
tty_Speed_t;

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
int le_tty_Open
(
    const char *ttyDev, 
    int flags           
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_tty_Close
(
    int fd  
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_tty_SetBaudRate
(
    int fd,                 
    tty_Speed_t ttyRate     
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_tty_GetBaudRate
(
    int fd,                     
    tty_Speed_t *ttyInRatePtr,  
    tty_Speed_t *ttyOutRatePtr  
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_tty_SetFraming
(
    int fd,         
    char parity,    
    int wordSize,   
    int stopBits    
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_tty_SetFlowControl
(
    int fd,                             
    tty_FlowControl_t ttyFlowControl    
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_tty_SetCanonical
(
    int fd  
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_tty_SetRaw
(
    int fd,         
    int numChars,   
    int timeout     
);

#endif // LEGATO_TTY_H_INCLUDE_GUARD