28 Nov
2012
28 Nov
'12
10:03 p.m.
Author: hbelusca
Date: Wed Nov 28 22:03:07 2012
New Revision: 57775
URL: http://svn.reactos.org/svn/reactos?rev=57775&view=rev
Log:
[SERIAL]
Comment the different defines.
Modified:
trunk/reactos/include/reactos/drivers/serial/ns16550.h
Modified: trunk/reactos/include/reactos/drivers/serial/ns16550.h
URL:
http://svn.reactos.org/svn/reactos/trunk/reactos/include/reactos/drivers/se…
==============================================================================
--- trunk/reactos/include/reactos/drivers/serial/ns16550.h [iso-8859-1] (original)
+++ trunk/reactos/include/reactos/drivers/serial/ns16550.h [iso-8859-1] Wed Nov 28
22:03:07 2012
@@ -10,60 +10,93 @@
#pragma once
-/* Note: These definitions are the internal definitions used by Microsoft serial
- driver (see src/kernel/serial/serial.h in WDK source code). Linux uses its own,
- as do most other OS.
+/* Note: These definitions are the internal definitions used by Microsoft
+ Serial Driver (see src/serial/serial/serial.h in WDK source code).
+ Linux uses its own, as do most other OS.
*/
+/* Baud master clock */
+// #define BAUD_CLOCK 1843200
+// #define CLOCKS_PER_BIT 16
+#define CLOCK_RATE 115200 // UART clock rate == BAUD_CLOCK / CLOCKS_PER_BIT
+
+// Define the spacing between registers.
#if !defined(SERIAL_REGISTER_STRIDE)
#define SERIAL_REGISTER_STRIDE 1
#endif
-#define RECEIVE_BUFFER_REGISTER ((ULONG)((0x00)*SERIAL_REGISTER_STRIDE))
-#define TRANSMIT_HOLDING_REGISTER ((ULONG)((0x00)*SERIAL_REGISTER_STRIDE))
-#define INTERRUPT_ENABLE_REGISTER ((ULONG)((0x01)*SERIAL_REGISTER_STRIDE))
-#define INTERRUPT_IDENT_REGISTER ((ULONG)((0x02)*SERIAL_REGISTER_STRIDE))
-#define FIFO_CONTROL_REGISTER ((ULONG)((0x02)*SERIAL_REGISTER_STRIDE))
-#define LINE_CONTROL_REGISTER ((ULONG)((0x03)*SERIAL_REGISTER_STRIDE))
-#define MODEM_CONTROL_REGISTER ((ULONG)((0x04)*SERIAL_REGISTER_STRIDE))
-#define LINE_STATUS_REGISTER ((ULONG)((0x05)*SERIAL_REGISTER_STRIDE))
-#define MODEM_STATUS_REGISTER ((ULONG)((0x06)*SERIAL_REGISTER_STRIDE))
-#define DIVISOR_LATCH_LSB ((ULONG)((0x00)*SERIAL_REGISTER_STRIDE))
-#define DIVISOR_LATCH_MSB ((ULONG)((0x01)*SERIAL_REGISTER_STRIDE))
-#define SERIAL_REGISTER_SPAN ((ULONG)(7*SERIAL_REGISTER_STRIDE))
-#define SERIAL_STATUS_LENGTH ((ULONG)(1*SERIAL_REGISTER_STRIDE))
+/*
+ * Offsets of the various registers, from the base register address.
+ */
+#define RECEIVE_BUFFER_REGISTER ((ULONG)((0x00)*SERIAL_REGISTER_STRIDE))
+#define TRANSMIT_HOLDING_REGISTER ((ULONG)((0x00)*SERIAL_REGISTER_STRIDE))
+#define INTERRUPT_ENABLE_REGISTER ((ULONG)((0x01)*SERIAL_REGISTER_STRIDE))
+#define INTERRUPT_IDENT_REGISTER ((ULONG)((0x02)*SERIAL_REGISTER_STRIDE))
+#define FIFO_CONTROL_REGISTER ((ULONG)((0x02)*SERIAL_REGISTER_STRIDE))
+#define LINE_CONTROL_REGISTER ((ULONG)((0x03)*SERIAL_REGISTER_STRIDE))
+#define MODEM_CONTROL_REGISTER ((ULONG)((0x04)*SERIAL_REGISTER_STRIDE))
+#define LINE_STATUS_REGISTER ((ULONG)((0x05)*SERIAL_REGISTER_STRIDE))
+#define MODEM_STATUS_REGISTER ((ULONG)((0x06)*SERIAL_REGISTER_STRIDE))
+#define SCRATCH_REGISTER ((ULONG)((0x07)*SERIAL_REGISTER_STRIDE))
-#define SERIAL_DATA_LENGTH_5 0x00
-#define SERIAL_DATA_LENGTH_6 0x01
-#define SERIAL_DATA_LENGTH_7 0x02
-#define SERIAL_DATA_LENGTH_8 0x03
+#define DIVISOR_LATCH_LSB ((ULONG)((0x00)*SERIAL_REGISTER_STRIDE))
+#define DIVISOR_LATCH_MSB ((ULONG)((0x01)*SERIAL_REGISTER_STRIDE))
+#define SERIAL_REGISTER_LENGTH ((ULONG)(7*SERIAL_REGISTER_STRIDE))
-#define SERIAL_IER_RDA 0x01
-#define SERIAL_IER_THR 0x02
-#define SERIAL_IER_RLS 0x04
-#define SERIAL_IER_MS 0x08
+// Length of the interrupt status register.
+#define SERIAL_STATUS_LENGTH ((ULONG)(1*SERIAL_REGISTER_STRIDE))
+/*
+ * Start, Data, Parity, Stop number of data bits
+ * transmitted in the Serial Data Unit.
+ */
+#define SERIAL_DATA_LENGTH_5 0x00
+#define SERIAL_DATA_LENGTH_6 0x01
+#define SERIAL_DATA_LENGTH_7 0x02
+#define SERIAL_DATA_LENGTH_8 0x03
+
+/*
+ * Masks defining the interrupts that can be enabled or disabled.
+ */
+#define SERIAL_IER_RDA 0x01 // New incoming data available.
+#define SERIAL_IER_THR 0x02 // Space available for another octet in the transmitter.
+#define SERIAL_IER_RLS 0x04 // Error occurred with incoming data.
+#define SERIAL_IER_MS 0x08 // Change occurred in the modem control line.
+
+/*
+ * Interrupt Identification Register masks.
+ */
#define SERIAL_IIR_RLS 0x06
#define SERIAL_IIR_RDA 0x04
#define SERIAL_IIR_CTI 0x0c
#define SERIAL_IIR_THR 0x02
#define SERIAL_IIR_MS 0x00
-#define SERIAL_IIR_FIFOS_ENABLED 0xc0
+#define SERIAL_IIR_FIFOS_ENABLED 0xc0
#define SERIAL_IIR_NO_INTERRUPT_PENDING 0x01
-#define SERIAL_IIR_MUST_BE_ZERO 0x30
+#define SERIAL_IIR_MUST_BE_ZERO 0x30
-#define SERIAL_FCR_ENABLE ((UCHAR)0x01)
-#define SERIAL_FCR_RCVR_RESET ((UCHAR)0x02)
-#define SERIAL_FCR_TXMT_RESET ((UCHAR)0x04)
+/*
+ * Fifo Control Register accessing masks.
+ */
+#define SERIAL_FCR_DISABLE ((UCHAR)0x00)
+#define SERIAL_FCR_ENABLE ((UCHAR)0x01)
+#define SERIAL_FCR_RCVR_RESET ((UCHAR)0x02)
+#define SERIAL_FCR_TXMT_RESET ((UCHAR)0x04)
-#define SERIAL_1_BYTE_HIGH_WATER ((UCHAR)0x00)
-#define SERIAL_4_BYTE_HIGH_WATER ((UCHAR)0x40)
-#define SERIAL_8_BYTE_HIGH_WATER ((UCHAR)0x80)
-#define SERIAL_14_BYTE_HIGH_WATER ((UCHAR)0xc0)
+#define SERIAL_1_BYTE_HIGH_WATER ((UCHAR)0x00)
+#define SERIAL_4_BYTE_HIGH_WATER ((UCHAR)0x40)
+#define SERIAL_8_BYTE_HIGH_WATER ((UCHAR)0x80)
+#define SERIAL_14_BYTE_HIGH_WATER ((UCHAR)0xc0)
-#define SERIAL_LCR_DLAB 0x80
-#define SERIAL_LCR_BREAK 0x40
+/*
+ * Line Control Register accessing masks.
+ */
+#define SERIAL_LCR_DLAB 0x80 // Divisor Latch Access Bit
+#define SERIAL_LCR_BREAK 0x40 // Send a break
+/*
+ * Line Control Register setting bits.
+ */
#define SERIAL_5_DATA ((UCHAR)0x00)
#define SERIAL_6_DATA ((UCHAR)0x01)
#define SERIAL_7_DATA ((UCHAR)0x02)
@@ -82,27 +115,38 @@
#define SERIAL_SPACE_PARITY ((UCHAR)0x38)
#define SERIAL_PARITY_MASK ((UCHAR)0x38)
-#define SERIAL_MCR_DTR 0x01
-#define SERIAL_MCR_RTS 0x02
-#define SERIAL_MCR_OUT1 0x04
-#define SERIAL_MCR_OUT2 0x08
-#define SERIAL_MCR_LOOP 0x10
-#define SERIAL_MCR_TL16C550CAFE 0x20
+/*
+ * Modem Control Register accessing masks.
+ */
+#define SERIAL_MCR_DTR 0x01 // Controls the Data Terminal Ready line
+#define SERIAL_MCR_RTS 0x02 // Controls the Ready To Send line
+#define SERIAL_MCR_OUT1 0x04 // General purpose output
+#define SERIAL_MCR_OUT2 0x08 // General purpose output
+#define SERIAL_MCR_LOOP 0x10 // Controls the loopback testing mode
+#define SERIAL_MCR_TL16C550CAFE 0x20 // Enables Auto Flow Control on a TI
TL16C550C
-#define SERIAL_LSR_DR 0x01
-#define SERIAL_LSR_OE 0x02
-#define SERIAL_LSR_PE 0x04
-#define SERIAL_LSR_FE 0x08
-#define SERIAL_LSR_BI 0x10
-#define SERIAL_LSR_THRE 0x20
-#define SERIAL_LSR_TEMT 0x40
-#define SERIAL_LSR_FIFOERR 0x80
+/*
+ * Line Status Register accessing masks.
+ */
+#define SERIAL_LSR_DR 0x01 // Data Ready indicator
+#define SERIAL_LSR_OE 0x02 // Overrun indicator
+#define SERIAL_LSR_PE 0x04 // Parity Error indicator
+#define SERIAL_LSR_FE 0x08 // Framing Error indicator
+#define SERIAL_LSR_BI 0x10 // Break Interrupt indicator
+#define SERIAL_LSR_THRE 0x20 // Transmit Holding Register Empty indicator
+#define SERIAL_LSR_TEMT 0x40 // Transmitter Empty indicator
+#define SERIAL_LSR_FIFOERR 0x80 // Fifo Error indicator
-#define SERIAL_MSR_DCTS 0x01
-#define SERIAL_MSR_DDSR 0x02
-#define SERIAL_MSR_TERI 0x04
-#define SERIAL_MSR_DDCD 0x08
-#define SERIAL_MSR_CTS 0x10
-#define SERIAL_MSR_DSR 0x20
-#define SERIAL_MSR_RI 0x40
-#define SERIAL_MSR_DCD 0x80
+/*
+ * Modem Status Register accessing masks.
+ */
+#define SERIAL_MSR_DCTS 0x01 // Delta Clear To Send
+#define SERIAL_MSR_DDSR 0x02 // Delta Data Set Ready
+#define SERIAL_MSR_TERI 0x04 // Trailing Edge Ring Indicator
+#define SERIAL_MSR_DDCD 0x08 // Delta Data Carrier Detect
+#define SERIAL_MSR_CTS 0x10 // Clear To Send
+#define SERIAL_MSR_DSR 0x20 // Data Set Ready
+#define SERIAL_MSR_RI 0x40 // Ring Indicator
+#define SERIAL_MSR_DCD 0x80 // Data Carrier Detect
+
+/* EOF */