Loading...
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 | /*
* Copyright (c) 2015 Wind River Systems, Inc.
*
* SPDX-License-Identifier: Apache-2.0
*/
/**
* @file
* @brief Public APIs for UART drivers
*/
#ifndef __INCuarth
#define __INCuarth
/**
* @brief UART Interface
* @defgroup uart_interface UART Interface
* @ingroup io_interfaces
* @{
*/
#ifdef __cplusplus
extern "C" {
#endif
#include <errno.h>
#include <stddef.h>
#include <device.h>
#ifdef CONFIG_PCI
#include <drivers/pci/pci.h>
#include <drivers/pci/pci_mgr.h>
#endif
/**
* @brief Options for @a UART initialization.
*/
#define UART_OPTION_AFCE 0x01
/** Common line controls for UART.*/
#define LINE_CTRL_BAUD_RATE (1 << 0)
#define LINE_CTRL_RTS (1 << 1)
#define LINE_CTRL_DTR (1 << 2)
#define LINE_CTRL_DCD (1 << 3)
#define LINE_CTRL_DSR (1 << 4)
/* Common communication errors for UART.*/
/** @brief Overrun error */
#define UART_ERROR_OVERRUN (1 << 0)
/** @brief Parity error */
#define UART_ERROR_PARITY (1 << 1)
/** @brief Framing error */
#define UART_ERROR_FRAMING (1 << 2)
/**
* @brief Break interrupt error:
*
* A break interrupt was received. This happens when the serial input is
* held at a logic '0' state for longer than the sum of start time + data bits
* + parity + stop bits.
*/
#define UART_ERROR_BREAK (1 << 3)
/**
* @typedef uart_irq_callback_user_data_t
* @brief Define the application callback function signature for
* uart_irq_callback_user_data_set() function.
*
* @param user_data Arbitrary user data.
*/
typedef void (*uart_irq_callback_user_data_t)(void *user_data);
/**
* @typedef uart_irq_callback_t
* @brief Define the application callback function signature for legacy
* uart_irq_callback_set().
*
* @param port Device struct for the UART device.
*/
typedef void (*uart_irq_callback_t)(struct device *port);
/**
* @typedef uart_irq_config_func_t
* @brief For configuring IRQ on each individual UART device.
*
* @internal
*/
typedef void (*uart_irq_config_func_t)(struct device *port);
/**
* @brief UART device configuration.
*
* @param port Base port number
* @param base Memory mapped base address
* @param regs Register address
* @param sys_clk_freq System clock frequency in Hz
*/
struct uart_device_config {
union {
u32_t port;
u8_t *base;
u32_t regs;
};
u32_t sys_clk_freq;
#ifdef CONFIG_PCI
struct pci_dev_info pci_dev;
#endif /* CONFIG_PCI */
#ifdef CONFIG_UART_INTERRUPT_DRIVEN
uart_irq_config_func_t irq_config_func;
#endif
};
/** @brief Driver API structure. */
struct uart_driver_api {
/** Console I/O function */
int (*poll_in)(struct device *dev, unsigned char *p_char);
unsigned char (*poll_out)(struct device *dev, unsigned char out_char);
/** Console I/O function */
int (*err_check)(struct device *dev);
#ifdef CONFIG_UART_INTERRUPT_DRIVEN
/** Interrupt driven FIFO fill function */
int (*fifo_fill)(struct device *dev, const u8_t *tx_data, int len);
/** Interrupt driven FIFO read function */
int (*fifo_read)(struct device *dev, u8_t *rx_data, const int size);
/** Interrupt driven transfer enabling function */
void (*irq_tx_enable)(struct device *dev);
/** Interrupt driven transfer disabling function */
void (*irq_tx_disable)(struct device *dev);
/** Interrupt driven transfer ready function */
int (*irq_tx_ready)(struct device *dev);
/** Interrupt driven receiver enabling function */
void (*irq_rx_enable)(struct device *dev);
/** Interrupt driven receiver disabling function */
void (*irq_rx_disable)(struct device *dev);
/** Interrupt driven transfer complete function */
int (*irq_tx_complete)(struct device *dev);
/** Interrupt driven receiver ready function */
int (*irq_rx_ready)(struct device *dev);
/** Interrupt driven error enabling function */
void (*irq_err_enable)(struct device *dev);
/** Interrupt driven error disabling function */
void (*irq_err_disable)(struct device *dev);
/** Interrupt driven pending status function */
int (*irq_is_pending)(struct device *dev);
/** Interrupt driven interrupt update function */
int (*irq_update)(struct device *dev);
/** Set the irq callback function */
void (*irq_callback_set)(struct device *dev,
uart_irq_callback_user_data_t cb,
void *user_data);
#endif
#ifdef CONFIG_UART_LINE_CTRL
int (*line_ctrl_set)(struct device *dev, u32_t ctrl, u32_t val);
int (*line_ctrl_get)(struct device *dev, u32_t ctrl, u32_t *val);
#endif
#ifdef CONFIG_UART_DRV_CMD
int (*drv_cmd)(struct device *dev, u32_t cmd, u32_t p);
#endif
};
/**
* @brief Check whether an error was detected.
*
* @param dev UART device structure.
*
* @retval UART_ERROR_OVERRUN if an overrun error was detected.
* @retval UART_ERROR_PARITY if a parity error was detected.
* @retval UART_ERROR_FRAMING if a framing error was detected.
* @retval UART_ERROR_BREAK if a break error was detected.
* @retval 0 Otherwise.
*/
__syscall int uart_err_check(struct device *dev);
static inline int _impl_uart_err_check(struct device *dev)
{
const struct uart_driver_api *api =
(const struct uart_driver_api *)dev->driver_api;
if (api->err_check) {
return api->err_check(dev);
}
return 0;
}
/**
* @brief Poll the device for input.
*
* @param dev UART device structure.
* @param p_char Pointer to character.
*
* @retval 0 If a character arrived.
* @retval -1 If no character was available to read (i.e., the UART
* input buffer was empty).
* @retval -ENOTSUP If the operation is not supported.
*/
__syscall int uart_poll_in(struct device *dev, unsigned char *p_char);
static inline int _impl_uart_poll_in(struct device *dev, unsigned char *p_char)
{
const struct uart_driver_api *api =
(const struct uart_driver_api *)dev->driver_api;
return api->poll_in(dev, p_char);
}
/**
* @brief Output a character in polled mode.
*
* This routine checks if the transmitter is empty.
* When the transmitter is empty, it writes a character to the data
* register.
*
* To send a character when hardware flow control is enabled, the handshake
* signal CTS must be asserted.
*
* @param dev UART device structure.
* @param out_char Character to send.
*
* @retval char Sent character.
*/
__syscall unsigned char uart_poll_out(struct device *dev,
unsigned char out_char);
static inline unsigned char _impl_uart_poll_out(struct device *dev,
unsigned char out_char)
{
const struct uart_driver_api *api =
(const struct uart_driver_api *)dev->driver_api;
return api->poll_out(dev, out_char);
}
#ifdef CONFIG_UART_INTERRUPT_DRIVEN
/**
* @brief Fill FIFO with data.
*
* @details This function is expected to be called from UART
* interrupt handler (ISR), if uart_irq_tx_ready() returns true.
* Result of calling this function not from an ISR is undefined
* (hardware-dependent). Likewise, *not* calling this function
* from an ISR if uart_irq_tx_ready() returns true may lead to
* undefined behavior, e.g. infinite interrupt loops. It's
* mandatory to test return value of this function, as different
* hardware has different FIFO depth (oftentimes just 1).
*
* @param dev UART device structure.
* @param tx_data Data to transmit.
* @param size Number of bytes to send.
*
* @return Number of bytes sent.
*/
static inline int uart_fifo_fill(struct device *dev, const u8_t *tx_data,
int size)
{
const struct uart_driver_api *api =
(const struct uart_driver_api *)dev->driver_api;
if (api->fifo_fill) {
return api->fifo_fill(dev, tx_data, size);
}
return 0;
}
/**
* @brief Read data from FIFO.
*
* @details This function is expected to be called from UART
* interrupt handler (ISR), if uart_irq_rx_ready() returns true.
* Result of calling this function not from an ISR is undefined
* (hardware-dependent). It's unspecified whether "RX ready"
* condition as returned by uart_irq_rx_ready() is level- or
* edge- triggered. That means that once uart_irq_rx_ready() is
* detected, uart_fifo_read() must be called until it reads all
* available data in the FIFO (i.e. until it returns less data
* than was requested).
*
* @param dev UART device structure.
* @param rx_data Data container.
* @param size Container size.
*
* @return Number of bytes read.
*/
static inline int uart_fifo_read(struct device *dev, u8_t *rx_data,
const int size)
{
const struct uart_driver_api *api =
(const struct uart_driver_api *)dev->driver_api;
if (api->fifo_read) {
return api->fifo_read(dev, rx_data, size);
}
return 0;
}
/**
* @brief Enable TX interrupt in IER.
*
* @param dev UART device structure.
*
* @return N/A
*/
__syscall void uart_irq_tx_enable(struct device *dev);
static inline void _impl_uart_irq_tx_enable(struct device *dev)
{
const struct uart_driver_api *api =
(const struct uart_driver_api *)dev->driver_api;
if (api->irq_tx_enable) {
api->irq_tx_enable(dev);
}
}
/**
* @brief Disable TX interrupt in IER.
*
* @param dev UART device structure.
*
* @return N/A
*/
__syscall void uart_irq_tx_disable(struct device *dev);
static inline void _impl_uart_irq_tx_disable(struct device *dev)
{
const struct uart_driver_api *api =
(const struct uart_driver_api *)dev->driver_api;
if (api->irq_tx_disable) {
api->irq_tx_disable(dev);
}
}
/**
* @brief Check if UART TX buffer can accept a new char
*
* @details Check if UART TX buffer can accept at least one character
* for transmission (i.e. uart_fifo_fill() will succeed and return
* non-zero). This function must be called in a UART interrupt
* handler, or its result is undefined. Before calling this function
* in the interrupt handler, uart_irq_update() must be called once per
* the handler invocation.
*
* @param dev UART device structure.
*
* @retval 1 If at least one char can be written to UART.
* @retval 0 Otherwise.
*/
static inline int uart_irq_tx_ready(struct device *dev)
{
const struct uart_driver_api *api =
(const struct uart_driver_api *)dev->driver_api;
if (api->irq_tx_ready) {
return api->irq_tx_ready(dev);
}
return 0;
}
/**
* @brief Enable RX interrupt in IER.
*
* @param dev UART device structure.
*
* @return N/A
*/
__syscall void uart_irq_rx_enable(struct device *dev);
static inline void _impl_uart_irq_rx_enable(struct device *dev)
{
const struct uart_driver_api *api =
(const struct uart_driver_api *)dev->driver_api;
if (api->irq_rx_enable) {
api->irq_rx_enable(dev);
}
}
/**
* @brief Disable RX interrupt in IER.
*
* @param dev UART device structure.
*
* @return N/A
*/
__syscall void uart_irq_rx_disable(struct device *dev);
static inline void _impl_uart_irq_rx_disable(struct device *dev)
{
const struct uart_driver_api *api =
(const struct uart_driver_api *)dev->driver_api;
if (api->irq_rx_disable) {
api->irq_rx_disable(dev);
}
}
/**
* @brief Check if UART TX block finished transmission
*
* @details Check if any outgoing data buffered in UART TX block was
* fully transmitted and TX block is idle. When this condition is
* true, UART device (or whole system) can be power off. Note that
* this function is *not* useful to check if UART TX can accept more
* data, use uart_irq_tx_ready() for that. This function must be called
* in a UART interrupt handler, or its result is undefined. Before
* calling this function in the interrupt handler, uart_irq_update()
* must be called once per the handler invocation.
*
* @param dev UART device structure.
*
* @retval 1 If nothing remains to be transmitted.
* @retval 0 Otherwise.
*/
static inline int uart_irq_tx_complete(struct device *dev)
{
const struct uart_driver_api *api =
(const struct uart_driver_api *)dev->driver_api;
if (api->irq_tx_complete) {
return api->irq_tx_complete(dev);
}
return 0;
}
/**
* @deprecated This API is deprecated.
*/
static inline int __deprecated uart_irq_tx_empty(struct device *dev)
{
return uart_irq_tx_complete(dev);
}
/**
* @brief Check if UART RX buffer has a received char
*
* @details Check if UART RX buffer has at least one pending character
* (i.e. uart_fifo_read() will succeed and return non-zero). This function
* must be called in a UART interrupt handler, or its result is undefined.
* Before calling this function in the interrupt handler, uart_irq_update()
* must be called once per the handler invocation. It's unspecified whether
* condition as returned by this function is level- or edge- triggered (i.e.
* if this function returns true when RX FIFO is non-empty, or when a new
* char was received since last call to it). See description of
* uart_fifo_read() for implication of this.
*
* @param dev UART device structure.
*
* @retval 1 If a received char is ready.
* @retval 0 Otherwise.
*/
static inline int uart_irq_rx_ready(struct device *dev)
{
const struct uart_driver_api *api =
(const struct uart_driver_api *)dev->driver_api;
if (api->irq_rx_ready) {
return api->irq_rx_ready(dev);
}
return 0;
}
/**
* @brief Enable error interrupt in IER.
*
* @param dev UART device structure.
*
* @return N/A
*/
__syscall void uart_irq_err_enable(struct device *dev);
static inline void _impl_uart_irq_err_enable(struct device *dev)
{
const struct uart_driver_api *api =
(const struct uart_driver_api *)dev->driver_api;
if (api->irq_err_enable) {
api->irq_err_enable(dev);
}
}
/**
* @brief Disable error interrupt in IER.
*
* @param dev UART device structure.
*
* @retval 1 If an IRQ is ready.
* @retval 0 Otherwise.
*/
__syscall void uart_irq_err_disable(struct device *dev);
static inline void _impl_uart_irq_err_disable(struct device *dev)
{
const struct uart_driver_api *api =
(const struct uart_driver_api *)dev->driver_api;
if (api->irq_err_disable) {
api->irq_err_disable(dev);
}
}
/**
* @brief Check if any IRQs is pending.
*
* @param dev UART device structure.
*
* @retval 1 If an IRQ is pending.
* @retval 0 Otherwise.
*/
__syscall int uart_irq_is_pending(struct device *dev);
static inline int _impl_uart_irq_is_pending(struct device *dev)
{
const struct uart_driver_api *api =
(const struct uart_driver_api *)dev->driver_api;
if (api->irq_is_pending) {
return api->irq_is_pending(dev);
}
return 0;
}
/**
* @brief Update cached contents of IIR.
*
* @param dev UART device structure.
*
* @retval 1 Always.
*/
__syscall int uart_irq_update(struct device *dev);
static inline int _impl_uart_irq_update(struct device *dev)
{
const struct uart_driver_api *api =
(const struct uart_driver_api *)dev->driver_api;
if (api->irq_update) {
return api->irq_update(dev);
}
return 0;
}
/**
* @brief Set the IRQ callback function pointer.
*
* This sets up the callback for IRQ. When an IRQ is triggered,
* the specified function will be called with specified user data.
*
* @param dev UART device structure.
* @param cb Pointer to the callback function.
* @param user_data Data to pass to callback function.
*
* @return N/A
*/
static inline void uart_irq_callback_user_data_set(
struct device *dev,
uart_irq_callback_user_data_t cb,
void *user_data)
{
const struct uart_driver_api *api =
(const struct uart_driver_api *)dev->driver_api;
if ((api != NULL) && (api->irq_callback_set != NULL)) {
api->irq_callback_set(dev, cb, user_data);
}
}
/**
* @brief Set the IRQ callback function pointer (legacy).
*
* This sets up the callback for IRQ. When an IRQ is triggered,
* the specified function will be called with the device pointer.
*
* @param dev UART device structure.
* @param cb Pointer to the callback function.
*
* @return N/A
*/
static inline void uart_irq_callback_set(struct device *dev,
uart_irq_callback_t cb)
{
uart_irq_callback_user_data_set(dev, (uart_irq_callback_user_data_t)cb,
dev);
}
#endif
#ifdef CONFIG_UART_LINE_CTRL
/**
* @brief Manipulate line control for UART.
*
* @param dev UART device structure.
* @param ctrl The line control to manipulate.
* @param val Value to set to the line control.
*
* @retval 0 If successful.
* @retval failed Otherwise.
*/
__syscall int uart_line_ctrl_set(struct device *dev,
u32_t ctrl, u32_t val);
static inline int _impl_uart_line_ctrl_set(struct device *dev,
u32_t ctrl, u32_t val)
{
const struct uart_driver_api *api =
(const struct uart_driver_api *)dev->driver_api;
if (api->line_ctrl_set) {
return api->line_ctrl_set(dev, ctrl, val);
}
return -ENOTSUP;
}
/**
* @brief Retrieve line control for UART.
*
* @param dev UART device structure.
* @param ctrl The line control to manipulate.
* @param val Value to get for the line control.
*
* @retval 0 If successful.
* @retval failed Otherwise.
*/
__syscall int uart_line_ctrl_get(struct device *dev, u32_t ctrl, u32_t *val);
static inline int _impl_uart_line_ctrl_get(struct device *dev,
u32_t ctrl, u32_t *val)
{
const struct uart_driver_api *api =
(const struct uart_driver_api *)dev->driver_api;
if (api && api->line_ctrl_get) {
return api->line_ctrl_get(dev, ctrl, val);
}
return -ENOTSUP;
}
#endif /* CONFIG_UART_LINE_CTRL */
#ifdef CONFIG_UART_DRV_CMD
/**
* @brief Send extra command to driver.
*
* Implementation and accepted commands are driver specific.
* Refer to the drivers for more information.
*
* @param dev UART device structure.
* @param cmd Command to driver.
* @param p Parameter to the command.
*
* @retval 0 If successful.
* @retval failed Otherwise.
*/
__syscall int uart_drv_cmd(struct device *dev, u32_t cmd, u32_t p);
static inline int _impl_uart_drv_cmd(struct device *dev, u32_t cmd, u32_t p)
{
const struct uart_driver_api *api =
(const struct uart_driver_api *)dev->driver_api;
if (api->drv_cmd) {
return api->drv_cmd(dev, cmd, p);
}
return -ENOTSUP;
}
#endif /* CONFIG_UART_DRV_CMD */
#ifdef __cplusplus
}
#endif
/**
* @}
*/
#include <syscalls/uart.h>
#endif /* __INCuarth */
|