 |
3.0.0.0R11
Software Development Kit |
|
 |
|
3.0.0.0R11
Software Development Kit |
|
|
Definitions related to Serial Lines. More...
Data Structures | |
| struct | ltrx_line_capabilities |
| Represents capabilities of a Serial Line. More... | |
| struct | ltrx_line_driver |
| API's for a serial line driver. More... | |
| struct | ltrx_line_protocol |
| Represents a line protocol for registration. More... | |
Macros | |
| #define | LINE_REGISTRATION_FAILED 0xff |
| Index out of range error code. More... | |
Functions | |
| void | ltrx_line_close (uint16_t zeroBasedLine) |
| Relinquish a line previously opened. More... | |
| const struct ltrx_line_capabilities * | ltrx_line_get_capabilities (uint16_t zeroBasedLine) |
| Gets the capabilities of the line. More... | |
| bool | ltrx_line_get_dsr (uint16_t zeroBasedLine, bool *dsr) |
| Get DSR status. More... | |
| uint8_t | ltrx_line_get_registered_count (void) |
| Get the count of registered lines. More... | |
| const char * | ltrx_line_get_registered_name (uint16_t zeroBasedLine) |
| Get the registered name of a Line. More... | |
| bool | ltrx_line_open (uint16_t zeroBasedLine, uint32_t blockTimeMsec) |
| Open a line for exclusive use. More... | |
| void | ltrx_line_purge (uint16_t zeroBasedLine) |
| Purge data. More... | |
| uint16_t | ltrx_line_read (uint16_t zeroBasedLine, uint8_t **dataPointerLocation, size_t max_size, bool *optBreakDetected, uint32_t blockTimeMsec) |
| Read data. More... | |
| uint16_t | ltrx_line_read_bytes_available (uint16_t zeroBasedLine, struct ltrx_trigger *optReadTrigger) |
| How many bytes are available? More... | |
| void | ltrx_line_register_protocol (const struct ltrx_line_protocol *llp) |
| Register a line protocol. More... | |
| void | ltrx_line_set_dtr (uint16_t zeroBasedLine, bool dtr) |
| Set DTR value. More... | |
| bool | ltrx_line_write (uint16_t zeroBasedLine, const void *data, size_t size, struct ltrx_trigger *optWriteTrigger) |
| Write data. More... | |
| uint8_t | ltrx_logical_line_driver_register (uint8_t numberOfLinesToRegister, const struct ltrx_line_driver *driver, const char **names) |
| Register a driver for one or more logical Lines. More... | |
Definitions related to Serial Lines.
| void ltrx_line_register_protocol | ( | const struct ltrx_line_protocol * | llp | ) |
Register a line protocol.
Registers procedures into the system for supporting another protocol on Serial Lines.
Registration must be done in early module initialization.
| [in] | llp | Designates the procedures to start and stop this protocol. |