michaelh/zephyr
1
0
Fork 0
Code Releases Activity

driver: uart: make deprecation effective

Browse source 
Several macros were documented as deprecated but lacked the
infrastructure to produce deprecation warnings.  Add the deprecation
marker, and fix the in-tree references to the deprecated spellings.

Note that one non-deprecated macro should have been deprecated, and
is, referring to a newly added line control bit.

Signed-off-by: Peter A. Bigot <pab@pabigot.com>
This commit is contained in:
Peter A. Bigot 2019-11-02 10:19:17 -05:00 • committed by Kumar Gala
commit a58d8ebaa6
10 changed files with 34 additions and 32 deletions
Download patch file Download diff file Expand all files Collapse all files

2
drivers/console/uart_console.c
View file

@ -599,7 +599,7 @@ static int uart_console_init(struct device *arg)
while (1) { while (1) {
u32_t dtr = 0U; u32_t dtr = 0U;
uart_line_ctrl_get(uart_console_dev, LINE_CTRL_DTR, &dtr); uart_line_ctrl_get(uart_console_dev, UART_LINE_CTRL_DTR, &dtr);
if (dtr) { if (dtr) {
break; break;
} }

2
drivers/serial/uart_cc32xx.c
View file

@ -120,7 +120,7 @@ static int uart_cc32xx_err_check(struct device *dev)
/* Map cc32xx SDK uart.h defines to zephyr uart.h defines */ /* Map cc32xx SDK uart.h defines to zephyr uart.h defines */
z_err = ((cc32xx_errs & UART_RXERROR_OVERRUN) ? z_err = ((cc32xx_errs & UART_RXERROR_OVERRUN) ?
UART_ERROR_OVERRUN : 0) | UART_ERROR_OVERRUN : 0) |
((cc32xx_errs & UART_RXERROR_BREAK) ? UART_ERROR_BREAK : 0) | ((cc32xx_errs & UART_RXERROR_BREAK) ? UART_BREAK : 0) |
((cc32xx_errs & UART_RXERROR_PARITY) ? UART_ERROR_PARITY : 0) | ((cc32xx_errs & UART_RXERROR_PARITY) ? UART_ERROR_PARITY : 0) |
((cc32xx_errs & UART_RXERROR_FRAMING) ? UART_ERROR_FRAMING : 0); ((cc32xx_errs & UART_RXERROR_FRAMING) ? UART_ERROR_FRAMING : 0);

10
drivers/serial/uart_ns16550.c
View file

@ -451,7 +451,7 @@ static void uart_ns16550_poll_out(struct device *dev,
* @param dev UART device struct * @param dev UART device struct
* *
* @return one of UART_ERROR_OVERRUN, UART_ERROR_PARITY, UART_ERROR_FRAMING, * @return one of UART_ERROR_OVERRUN, UART_ERROR_PARITY, UART_ERROR_FRAMING,
* UART_ERROR_BREAK if an error was detected, 0 otherwise. * UART_BREAK if an error was detected, 0 otherwise.
*/ */
static int uart_ns16550_err_check(struct device *dev) static int uart_ns16550_err_check(struct device *dev)
{ {
@ -691,15 +691,15 @@ static int uart_ns16550_line_ctrl_set(struct device *dev,
u32_t mdc, chg; u32_t mdc, chg;
switch (ctrl) { switch (ctrl) {
case LINE_CTRL_BAUD_RATE: case UART_LINE_CTRL_BAUD_RATE:
set_baud_rate(dev, val); set_baud_rate(dev, val);
return 0; return 0;
case LINE_CTRL_RTS: case UART_LINE_CTRL_RTS:
case LINE_CTRL_DTR: case UART_LINE_CTRL_DTR:
mdc = INBYTE(MDC(dev)); mdc = INBYTE(MDC(dev));
if (ctrl == LINE_CTRL_RTS) { if (ctrl == UART_LINE_CTRL_RTS) {
chg = MCR_RTS; chg = MCR_RTS;
} else { } else {
chg = MCR_DTR; chg = MCR_DTR;

14
include/drivers/uart.h
View file

@ -31,6 +31,7 @@ extern "C" {
/** @brief Line control signals. */ /** @brief Line control signals. */
enum uart_line_ctrl { enum uart_line_ctrl {
UART_LINE_CTRL_BAUD_RATE = BIT(0),
UART_LINE_CTRL_RTS = BIT(1), UART_LINE_CTRL_RTS = BIT(1),
UART_LINE_CTRL_DTR = BIT(2), UART_LINE_CTRL_DTR = BIT(2),
UART_LINE_CTRL_DCD = BIT(3), UART_LINE_CTRL_DCD = BIT(3),
@ -157,13 +158,14 @@ enum uart_rx_stop_reason {
UART_BREAK = (1 << 3), UART_BREAK = (1 << 3),
}; };
/** @brief Backward compatibility defines, deprecated */ /** @brief Backward compatibility defines, deprecated */
#define UART_ERROR_BREAK UART_BREAK #define UART_ERROR_BREAK __DEPRECATED_MACRO UART_BREAK
#define LINE_CTRL_BAUD_RATE (1 << 0) #define LINE_CTRL_BAUD_RATE __DEPRECATED_MACRO UART_LINE_CTRL_BAUD_RATE
#define LINE_CTRL_RTS UART_LINE_CTRL_RTS #define LINE_CTRL_RTS __DEPRECATED_MACRO UART_LINE_CTRL_RTS
#define LINE_CTRL_DTR UART_LINE_CTRL_DTR #define LINE_CTRL_DTR __DEPRECATED_MACRO UART_LINE_CTRL_DTR
#define LINE_CTRL_DCD UART_LINE_CTRL_DCD #define LINE_CTRL_DCD __DEPRECATED_MACRO UART_LINE_CTRL_DCD
#define LINE_CTRL_DSR UART_LINE_CTRL_DSR #define LINE_CTRL_DSR __DEPRECATED_MACRO UART_LINE_CTRL_DSR
/** @brief UART TX event data. */ /** @brief UART TX event data. */

6
include/usb/class/usb_cdc.h
View file

@ -73,9 +73,9 @@
#define SET_CONTROL_LINE_STATE_DTR 0x01 #define SET_CONTROL_LINE_STATE_DTR 0x01
/** Enhance enum uart_line_ctrl with CDC specific values */ /** Enhance enum uart_line_ctrl with CDC specific values */
#define USB_CDC_LINE_CTRL_BAUD_RATE LINE_CTRL_BAUD_RATE #define USB_CDC_LINE_CTRL_BAUD_RATE UART_LINE_CTRL_BAUD_RATE
#define USB_CDC_LINE_CTRL_DCD LINE_CTRL_DCD #define USB_CDC_LINE_CTRL_DCD UART_LINE_CTRL_DCD
#define USB_CDC_LINE_CTRL_DSR LINE_CTRL_DSR #define USB_CDC_LINE_CTRL_DSR UART_LINE_CTRL_DSR
#define USB_CDC_LINE_CTRL_BREAK BIT(5) #define USB_CDC_LINE_CTRL_BREAK BIT(5)
#define USB_CDC_LINE_CTRL_RING_SIGNAL BIT(6) #define USB_CDC_LINE_CTRL_RING_SIGNAL BIT(6)
#define USB_CDC_LINE_CTRL_FRAMING BIT(7) #define USB_CDC_LINE_CTRL_FRAMING BIT(7)

4
samples/net/wpan_serial/src/main.c
View file

@ -574,7 +574,7 @@ void main(void)
LOG_DBG("Wait for DTR"); LOG_DBG("Wait for DTR");
while (1) { while (1) {
uart_line_ctrl_get(dev, LINE_CTRL_DTR, &dtr); uart_line_ctrl_get(dev, UART_LINE_CTRL_DTR, &dtr);
if (dtr) { if (dtr) {
break; break;
} }
@ -584,7 +584,7 @@ void main(void)
LOG_DBG("DTR set, continue"); LOG_DBG("DTR set, continue");
ret = uart_line_ctrl_get(dev, LINE_CTRL_BAUD_RATE, &baudrate); ret = uart_line_ctrl_get(dev, UART_LINE_CTRL_BAUD_RATE, &baudrate);
if (ret) { if (ret) {
printk("Failed to get baudrate, ret code %d\n", ret); printk("Failed to get baudrate, ret code %d\n", ret);
} else { } else {

8
samples/subsys/usb/cdc_acm/src/main.c
View file

@ -86,7 +86,7 @@ void main(void)
LOG_INF("Wait for DTR"); LOG_INF("Wait for DTR");
while (true) { while (true) {
uart_line_ctrl_get(dev, LINE_CTRL_DTR, &dtr); uart_line_ctrl_get(dev, UART_LINE_CTRL_DTR, &dtr);
if (dtr) { if (dtr) {
break; break;
} else { } else {
@ -98,12 +98,12 @@ void main(void)
LOG_INF("DTR set"); LOG_INF("DTR set");
/* They are optional, we use them to test the interrupt endpoint */ /* They are optional, we use them to test the interrupt endpoint */
ret = uart_line_ctrl_set(dev, LINE_CTRL_DCD, 1); ret = uart_line_ctrl_set(dev, UART_LINE_CTRL_DCD, 1);
if (ret) { if (ret) {
LOG_WRN("Failed to set DCD, ret code %d", ret); LOG_WRN("Failed to set DCD, ret code %d", ret);
} }
ret = uart_line_ctrl_set(dev, LINE_CTRL_DSR, 1); ret = uart_line_ctrl_set(dev, UART_LINE_CTRL_DSR, 1);
if (ret) { if (ret) {
LOG_WRN("Failed to set DSR, ret code %d", ret); LOG_WRN("Failed to set DSR, ret code %d", ret);
} }
@ -111,7 +111,7 @@ void main(void)
/* Wait 1 sec for the host to do all settings */ /* Wait 1 sec for the host to do all settings */
k_busy_wait(1000000); k_busy_wait(1000000);
ret = uart_line_ctrl_get(dev, LINE_CTRL_BAUD_RATE, &baudrate); ret = uart_line_ctrl_get(dev, UART_LINE_CTRL_BAUD_RATE, &baudrate);
if (ret) { if (ret) {
LOG_WRN("Failed to get baudrate, ret code %d", ret); LOG_WRN("Failed to get baudrate, ret code %d", ret);
} else { } else {

10
samples/subsys/usb/cdc_acm_composite/src/main.c
View file

@ -88,12 +88,12 @@ static void uart_line_set(struct device *dev)
int ret; int ret;
/* They are optional, we use them to test the interrupt endpoint */ /* They are optional, we use them to test the interrupt endpoint */
ret = uart_line_ctrl_set(dev, LINE_CTRL_DCD, 1); ret = uart_line_ctrl_set(dev, UART_LINE_CTRL_DCD, 1);
if (ret) { if (ret) {
LOG_DBG("Failed to set DCD, ret code %d", ret); LOG_DBG("Failed to set DCD, ret code %d", ret);
} }
ret = uart_line_ctrl_set(dev, LINE_CTRL_DSR, 1); ret = uart_line_ctrl_set(dev, UART_LINE_CTRL_DSR, 1);
if (ret) { if (ret) {
LOG_DBG("Failed to set DSR, ret code %d", ret); LOG_DBG("Failed to set DSR, ret code %d", ret);
} }
@ -101,7 +101,7 @@ static void uart_line_set(struct device *dev)
/* Wait 1 sec for the host to do all settings */ /* Wait 1 sec for the host to do all settings */
k_busy_wait(1000000); k_busy_wait(1000000);
ret = uart_line_ctrl_get(dev, LINE_CTRL_BAUD_RATE, &baudrate); ret = uart_line_ctrl_get(dev, UART_LINE_CTRL_BAUD_RATE, &baudrate);
if (ret) { if (ret) {
LOG_DBG("Failed to get baudrate, ret code %d", ret); LOG_DBG("Failed to get baudrate, ret code %d", ret);
} else { } else {
@ -131,7 +131,7 @@ void main(void)
LOG_INF("Wait for DTR"); LOG_INF("Wait for DTR");
while (1) { while (1) {
uart_line_ctrl_get(dev0, LINE_CTRL_DTR, &dtr); uart_line_ctrl_get(dev0, UART_LINE_CTRL_DTR, &dtr);
if (dtr) { if (dtr) {
break; break;
} }
@ -140,7 +140,7 @@ void main(void)
} }
while (1) { while (1) {
uart_line_ctrl_get(dev1, LINE_CTRL_DTR, &dtr); uart_line_ctrl_get(dev1, UART_LINE_CTRL_DTR, &dtr);
if (dtr) { if (dtr) {
break; break;
} }

4
samples/subsys/usb/hid-cdc/src/main.c
View file

@ -627,7 +627,7 @@ void main(void)
LOG_INF("Wait for DTR on CDC ACM 0"); LOG_INF("Wait for DTR on CDC ACM 0");
while (1) { while (1) {
uart_line_ctrl_get(cdc0_dev, LINE_CTRL_DTR, &dtr); uart_line_ctrl_get(cdc0_dev, UART_LINE_CTRL_DTR, &dtr);
if (dtr) { if (dtr) {
break; break;
} }
@ -636,7 +636,7 @@ void main(void)
LOG_INF("Wait for DTR on CDC ACM 1"); LOG_INF("Wait for DTR on CDC ACM 1");
while (1) { while (1) {
uart_line_ctrl_get(cdc1_dev, LINE_CTRL_DTR, &dtr); uart_line_ctrl_get(cdc1_dev, UART_LINE_CTRL_DTR, &dtr);
if (dtr) { if (dtr) {
break; break;
} }

6
subsys/usb/class/cdc_acm.c
View file

@ -885,14 +885,14 @@ static int cdc_acm_line_ctrl_get(struct device *dev,
struct cdc_acm_dev_data_t * const dev_data = DEV_DATA(dev); struct cdc_acm_dev_data_t * const dev_data = DEV_DATA(dev);
switch (ctrl) { switch (ctrl) {
case LINE_CTRL_BAUD_RATE: case UART_LINE_CTRL_BAUD_RATE:
*val = sys_le32_to_cpu(dev_data->line_coding.dwDTERate); *val = sys_le32_to_cpu(dev_data->line_coding.dwDTERate);
return 0; return 0;
case LINE_CTRL_RTS: case UART_LINE_CTRL_RTS:
*val = (dev_data->line_state & *val = (dev_data->line_state &
SET_CONTROL_LINE_STATE_RTS) ? 1 : 0; SET_CONTROL_LINE_STATE_RTS) ? 1 : 0;
return 0; return 0;
case LINE_CTRL_DTR: case UART_LINE_CTRL_DTR:
*val = (dev_data->line_state & *val = (dev_data->line_state &
SET_CONTROL_LINE_STATE_DTR) ? 1 : 0; SET_CONTROL_LINE_STATE_DTR) ? 1 : 0;
return 0; return 0;