Structure Entries - Texas Instruments TMS320C6000 User Manual

www.ti.com
Field
PeerMap
Ticks
Baud
Mode
FlowCtrl
TxFree
PBMQ_tx
PBMQ_rx
hRxPend
pRxBuf
RxCount
RxCRC
RxFlag
hTxPend
pTxBuf
TxCount
SPRUES5A – January 2007 – Revised June 2008
Submit Documentation Feedback
Table 2. Structure Entries (continued)
Description
32-Bit Char Escape Map (for HDLC). The peer map is a 32-bit bitmap coded as
(1<<char) where char is an ASCII character 0 through 31. When the bit is set, an
outgoing HDLC frame must have the corresponding character escaped in a HDLC
frame transmission.
Track Timer Ticks. This field converts 100 ms timer ticks to 1 second timer ticks. It is
not used by mini-drivers.
Serial Device Baud Rate. This field holds the current physical baud rate of the serial
port in bps (for example, 9600, 19200, 153600, etc.).
Device Mode. The mode field holds the mode of the serial port in terms of data bits,
stop bits, and parity. These values appear in HAL.H. Currently defined values are as
follows:
• #define HAL_SERIAL_MODE_8N1 0
• #define HAL_SERIAL_MODE_7E1 1
Flow Control Mode. The FlowCtrl field determines the flow control mode. These values
appear in HAL.H. Currently defined values are as follows:
• #define HAL_SERIAL_FLOWCTRL_NONE 0
• #define HAL_SERIAL_FLOWCTRL_HARDWARE 1
Transmitter Free Flag. The TxFree flag is used by LLSERIAL.C to determine if new
data should be sent immediately by the mini-driver, or placed on the transmit pending
queue for later. If the flag is not zero, the mini-driver function HwSerTxNext() is called
when any new data is queued for transmission. This flag is maintained by the
mini-driver.
Tx Queue. The PBMQ_tx queue is a queue of packets waiting to be transmitted. When
the transmitter is free and the HwSerTxNext() function is called, the mini-driver
removes the next packet off this queue and starts transmission. The PBMQ object is a
queue of PBM packet buffers and it is operated on by the PBMQ functions defined in
theTMS320C6000 Network Developer's Kit (NDK) Software Programmer's Reference
Guide (SPRU524).
Rx Queue. The PBMQ_rx queue is a queue of packets that have been received on the
interface. When a new packet is received, the mini-driver adds it to this queue, and
fires a serial event to the STKEVENT handle. PBMQ object is a queue of PBM packet
buffers and it is operated on by the PBMQ functions defined in the TMS320C6000
Network Developer's Kit (NDK) Software Programmer's Reference Guide (SPRU524).
PBM_Handle to Packet Being Received. When in HDLC mode, this value holds a
handle to the packet that is currently being received by the mini-driver. When the
packet is complete, the mini-driver places this packet in the PBMQ_rx queue, and
allocates another free packet by calling PBM_alloc().
Pointer to Next Character in Packet to Receive. When in HDLC mode, this points to
where to write the next character of received data. The pointer points somewhere in the
current packet buffer whose handle is stored in hRxPend.
Number of Bytes Written to RX Packet Buffer so far. When in HDLC mode, this value is
the number of characters that have been written to the current packet being received.
RX CRC Running Total. When in HDLC mode, this value is a running total of the
current CRC value of the packet being received. It is used as a temporary CRC holding
value while packet data is still being received. It is then compared to the CRC
contained in the packet to validate the incoming CRC.
Flag Indicating That Next Byte is the Second Half of an Escape Sequence. When in
HDLC mode, this flag is set when an escape character is seen. It prompts the RX state
machine in the mini-driver to un-escape the next character received.
PBM_Handle to Packet Being Transmitted. This value holds a handle to the packet that
is currently being transmitted by mini-driver. When the packet is completely transmitted,
the mini-driver frees this packet by calling PBM_free().
Pointer to Next Character in Packet to Transmit. This is a pointer where to read the
next character of transmit data. The pointer points somewhere in the current packet
buffer whose handle is stored in hTxPend.
Number of Bytes Yet to Send From to TX Packet. This value is the number of
characters that have yet to be read and transmitted from the current packet being sent.
TMS320C6000 Network Developer's Kit (NDK) Support Package for EVMDM642
Serial Driver
23