Tools C API

The public C API of Tools.

All kindsMacro56 symbols

• PDCOMM_VSERIAL_ABI_MAGIC Macro — Value of the header magic field (bytes 0x50 0x56, "PV").
• PDCOMM_VSERIAL_ABI_VERSION Macro — Frame and protocol version carried in the header and in ATTACH and HELLO.
• PDCOMM_VSERIAL_CAP_ERRORS Macro — Driver capability bit: per-character errors (#PDCOMM_VSERIAL_MSG_RX_CHARS) are supported.
• PDCOMM_VSERIAL_CAP_MODEM Macro — Driver capability bit: modem control lines are supported.
• PDCOMM_VSERIAL_CAP_RS485 Macro — Driver capability bit: RS-485 settings (#PDCOMM_VSERIAL_MSG_SET_RS485) are supported.
• PDCOMM_VSERIAL_ERR_BREAK Macro — Character error bit: break condition received.
• PDCOMM_VSERIAL_ERR_FRAMING Macro — Character error bit: framing error (missing stop bit).
• PDCOMM_VSERIAL_ERR_OVERRUN Macro — Character error bit: overrun; data was lost before this character.
• PDCOMM_VSERIAL_ERR_PARITY Macro — Character error bit: parity error.
• PDCOMM_VSERIAL_FLOW_NONE Macro — Flow-control code: none.
• PDCOMM_VSERIAL_FLOW_RTS_CTS Macro — Flow-control code: hardware handshake with RTS and CTS.
• PDCOMM_VSERIAL_FLOW_XON_XOFF Macro — Flow-control code: software handshake with XON and XOFF characters.
• PDCOMM_VSERIAL_HEADER_BYTES Macro — Size of the frame header in bytes.
• PDCOMM_VSERIAL_IN_CTS Macro — Modem input bit: CTS (Clear To Send).
• PDCOMM_VSERIAL_IN_DCD Macro — Modem input bit: DCD (Data Carrier Detect).
• PDCOMM_VSERIAL_IN_DSR Macro — Modem input bit: DSR (Data Set Ready).
• PDCOMM_VSERIAL_IN_RI Macro — Modem input bit: RI (Ring Indicator).
• PDCOMM_VSERIAL_MAX_PAYLOAD Macro — Largest payload a sender puts in one data frame; receivers accept up to twice this size.
• PDCOMM_VSERIAL_MAX_PORTS Macro — Largest number of ports one driver instance provides.
• PDCOMM_VSERIAL_MSG_ATTACH Macro — u16 version; the driver answers HELLO and replays state
• PDCOMM_VSERIAL_MSG_CLOSED Macro — the last application handle closed
• PDCOMM_VSERIAL_MSG_HELLO Macro — u16 version, u16 ports from the header port on, u32 caps
• PDCOMM_VSERIAL_MSG_MODEM_STATUS Macro — u8 inputs
• PDCOMM_VSERIAL_MSG_OPENED Macro — an application opened the port
• PDCOMM_VSERIAL_MSG_PURGE Macro — u8 purge bits
• PDCOMM_VSERIAL_MSG_RX_CHARS Macro — (u8 byte, u8 error bits) pairs
• PDCOMM_VSERIAL_MSG_RX_DATA Macro — error-free received bytes
• PDCOMM_VSERIAL_MSG_SET_BREAK Macro — u8 0 or 1
• PDCOMM_VSERIAL_MSG_SET_FLOW Macro — u8 flow
• PDCOMM_VSERIAL_MSG_SET_LINE Macro — u32 baud, u8 data bits, u8 parity, u8 stop, u8 0
• PDCOMM_VSERIAL_MSG_SET_MODEM Macro — u8 outputs
• PDCOMM_VSERIAL_MSG_SET_RS485 Macro — u32 RS-485 flags, u32 delay before us, u32 delay after us
• PDCOMM_VSERIAL_MSG_TX_DATA Macro — bytes the application wrote
• PDCOMM_VSERIAL_MSG_TX_DONE Macro — u32 written bytes now fully on the line
• PDCOMM_VSERIAL_OFFSET_FLAGS Macro — Byte offset of the u16 flags field (reserved, written as zero).
• PDCOMM_VSERIAL_OFFSET_LENGTH Macro — Byte offset of the u32 payload length field.
• PDCOMM_VSERIAL_OFFSET_MAGIC Macro — Byte offset of the u16 magic field.
• PDCOMM_VSERIAL_OFFSET_PORT Macro — Byte offset of the u16 zero-based port index.
• PDCOMM_VSERIAL_OFFSET_TYPE Macro — Byte offset of the u8 message type field.
• PDCOMM_VSERIAL_OFFSET_VERSION Macro — Byte offset of the u8 version field.
• PDCOMM_VSERIAL_OUT_DTR Macro — Modem output bit: DTR (Data Terminal Ready).
• PDCOMM_VSERIAL_OUT_RTS Macro — Modem output bit: RTS (Request To Send).
• PDCOMM_VSERIAL_PARITY_EVEN Macro — Parity code: even parity.
• PDCOMM_VSERIAL_PARITY_MARK Macro — Parity code: mark parity (parity bit always 1).
• PDCOMM_VSERIAL_PARITY_NONE Macro — Parity code: no parity bit.
• PDCOMM_VSERIAL_PARITY_ODD Macro — Parity code: odd parity.
• PDCOMM_VSERIAL_PARITY_SPACE Macro — Parity code: space parity (parity bit always 0).
• PDCOMM_VSERIAL_PURGE_RX Macro — Purge bit: discard received data that the application has not read.
• PDCOMM_VSERIAL_PURGE_TX Macro — Purge bit: discard written data that has not been transmitted.
• PDCOMM_VSERIAL_RS485_ENABLED Macro — RS-485 flag: RS-485 mode is enabled; the other flags apply only then.
• PDCOMM_VSERIAL_RS485_RTS_AFTER_SEND Macro — RS-485 flag: RTS is asserted after sending.
• PDCOMM_VSERIAL_RS485_RTS_ON_SEND Macro — RS-485 flag: RTS is asserted while sending.
• PDCOMM_VSERIAL_RS485_RX_DURING_TX Macro — RS-485 flag: keep receiving while sending (no echo suppression).
• PDCOMM_VSERIAL_STOP_ONE Macro — Stop-bit code: one stop bit.
• PDCOMM_VSERIAL_STOP_ONE_HALF Macro — Stop-bit code: one and a half stop bits.
• PDCOMM_VSERIAL_STOP_TWO Macro — Stop-bit code: two stop bits.