OrgZephyr/zephyr
OrgZephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity
zephyr/include/uart.h

629 lines
14 KiB
C
Raw Blame History

/*
* Copyright (c) 2015 Wind River Systems, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @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 <stddef.h>
#include <device.h>
#ifdef CONFIG_PCI
#include <pci/pci.h>
#include <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)
/* 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)
/**
* @brief Define the application callback function signature for UART.
*
* @param port Device struct for the UART device.
*/
typedef void (*uart_irq_callback_t)(struct device *port);
/* For configuring IRQ on each individual UART device. Internal use only. */
typedef void (*uart_irq_config_func_t)(struct device *port);
/** @brief UART device configuration.*/
struct uart_device_config {
/**
* Base port number
* or memory mapped base address
* or register address
*/
union {
uint32_t port;
uint8_t *base;
uint32_t regs;
};
/** System clock frequency in Hz.*/
uint32_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 uint8_t *tx_data, int len);
/** Interrupt driven FIFO read function */
int (*fifo_read)(struct device *dev, uint8_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 empty function */
int (*irq_tx_empty)(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);
/** Interrupt driven input hook function */
int (*irq_input_hook)(struct device *dev, uint8_t byte);
/** Set the callback function */
void (*irq_callback_set)(struct device *dev, uart_irq_callback_t cb);
#endif
#ifdef CONFIG_UART_LINE_CTRL
int (*line_ctrl_set)(struct device *dev, uint32_t ctrl, uint32_t val);
#endif
#ifdef CONFIG_UART_DRV_CMD
int (*drv_cmd)(struct device *dev, uint32_t cmd, uint32_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.
*/
static inline int uart_err_check(struct device *dev)
{
struct uart_driver_api *api;
api = (struct uart_driver_api *)dev->driver_api;
if (api && 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 the input buffer if empty.
* @retval DEV_INVALID_OP If the operation is not supported.
*/
static inline int uart_poll_in(struct device *dev, unsigned char *p_char)
{
struct uart_driver_api *api;
api = (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.
*/
static inline unsigned char uart_poll_out(struct device *dev,
unsigned char out_char)
{
struct uart_driver_api *api;
api = (struct uart_driver_api *)dev->driver_api;
return api->poll_out(dev, out_char);
}
#ifdef CONFIG_UART_INTERRUPT_DRIVEN
/**
* @brief Fill FIFO with data.
*
* @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 uint8_t *tx_data,
int size)
{
struct uart_driver_api *api;
api = (struct uart_driver_api *)dev->driver_api;
if (api && api->fifo_fill) {
return api->fifo_fill(dev, tx_data, size);
}
return 0;
}
/**
* @brief Read data from FIFO.
*
* @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, uint8_t *rx_data,
const int size)
{
struct uart_driver_api *api;
api = (struct uart_driver_api *)dev->driver_api;
if (api && 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
*/
static inline void uart_irq_tx_enable(struct device *dev)
{
struct uart_driver_api *api;
api = (struct uart_driver_api *)dev->driver_api;
if (api && api->irq_tx_enable) {
api->irq_tx_enable(dev);
}
}
/**
* @brief Disable TX interrupt in IER.
*
* @param dev UART device structure.
*
* @return N/A
*/
static inline void uart_irq_tx_disable(struct device *dev)
{
struct uart_driver_api *api;
api = (struct uart_driver_api *)dev->driver_api;
if (api && api->irq_tx_disable) {
api->irq_tx_disable(dev);
}
}
/**
* @brief Check if Tx IRQ has been raised.
*
* @param dev UART device structure.
*
* @retval 1 If an IRQ is ready.
* @retval 0 Otherwise.
*/
static inline int uart_irq_tx_ready(struct device *dev)
{
struct uart_driver_api *api;
api = (struct uart_driver_api *)dev->driver_api;
if (api && 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
*/
static inline void uart_irq_rx_enable(struct device *dev)
{
struct uart_driver_api *api;
api = (struct uart_driver_api *)dev->driver_api;
if (api && api->irq_rx_enable) {
api->irq_rx_enable(dev);
}
}
/**
* @brief Disable RX interrupt in IER.
*
* @param dev UART device structure.
*
* @return N/A
*/
static inline void uart_irq_rx_disable(struct device *dev)
{
struct uart_driver_api *api;
api = (struct uart_driver_api *)dev->driver_api;
if (api && api->irq_tx_disable) {
api->irq_tx_disable(dev);
}
}
/**
* @brief Check if nothing remains to be transmitted
*
* @param dev UART device structure.
*
* @retval 1 If nothing remains to be transmitted.
* @retval 0 Otherwise.
*/
static inline int uart_irq_tx_empty(struct device *dev)
{
struct uart_driver_api *api;
api = (struct uart_driver_api *)dev->driver_api;
if (api && api->irq_tx_empty) {
return api->irq_tx_empty(dev);
}
return 0;
}
/**
* @brief Check if Rx IRQ has been raised.
*
* @param dev UART device structure.
*
* @retval 1 If an IRQ is ready.
* @retval 0 Otherwise.
*/
static inline int uart_irq_rx_ready(struct device *dev)
{
struct uart_driver_api *api;
api = (struct uart_driver_api *)dev->driver_api;
if (api && 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
*/
static inline void uart_irq_err_enable(struct device *dev)
{
struct uart_driver_api *api;
api = (struct uart_driver_api *)dev->driver_api;
if (api && 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.
*/
static inline void uart_irq_err_disable(struct device *dev)
{
struct uart_driver_api *api;
api = (struct uart_driver_api *)dev->driver_api;
if (api && 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.
*/
static inline int uart_irq_is_pending(struct device *dev)
{
struct uart_driver_api *api;
api = (struct uart_driver_api *)dev->driver_api;
if (api && 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.
*/
static inline int uart_irq_update(struct device *dev)
{
struct uart_driver_api *api;
api = (struct uart_driver_api *)dev->driver_api;
if (api && api->irq_update) {
return api->irq_update(dev);
}
return 0;
}
/**
* @brief Invoke the UART input hook routine if it is installed.
*
* The input hook is a custom handler invoked by the ISR on each received
* character. It allows the detection of a character escape sequence that can
* be used to override the behavior of the ISR handler.
*
* @param dev UART device structure.
* @param byte Byte to process.
*
* @retval 1 If character processing must stop.
* @retval 0 If it should continue.
*/
static inline int uart_irq_input_hook(struct device *dev, uint8_t byte)
{
struct uart_driver_api *api;
api = (struct uart_driver_api *)dev->driver_api;
if ((api != NULL) && (api->irq_input_hook != NULL)) {
return api->irq_input_hook(dev, byte);
}
return 0;
}
/**
* @brief Set the UART input hook routine.
*
* @param dev UART device structure.
* @param hook Routine to use as UART input hook.
*
* @return N/A
*/
static inline void uart_irq_input_hook_set(struct device *dev,
int (*hook)(struct device *, uint8_t))
{
struct uart_driver_api *api;
api = (struct uart_driver_api *)dev->driver_api;
if (api != NULL) {
api->irq_input_hook = hook;
}
}
/**
* @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.
*
* @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)
{
struct uart_driver_api *api;
api = (struct uart_driver_api *)dev->driver_api;
if ((api != NULL) && (api->irq_callback_set != NULL)) {
api->irq_callback_set(dev, cb);
}
}
#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 DEV_OK If successful.
* @retval failed Otherwise.
*/
static inline int uart_line_ctrl_set(struct device *dev,
uint32_t ctrl, uint32_t val)
{
struct uart_driver_api *api;
api = (struct uart_driver_api *)dev->driver_api;
if (api && api->line_ctrl_set) {
return api->line_ctrl_set(dev, ctrl, val);
}
return DEV_INVALID_OP;
}
#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 DEV_OK If successful.
* @retval failed Otherwise.
*/
static inline int uart_drv_cmd(struct device *dev, uint32_t cmd, uint32_t p)
{
struct uart_driver_api *api;
api = (struct uart_driver_api *)dev->driver_api;
if (api && api->drv_cmd) {
return api->drv_cmd(dev, cmd, p);
}
return DEV_INVALID_OP;
}
#endif /* CONFIG_UART_DRV_CMD */
#ifdef __cplusplus
}
#endif
/**
* @}
*/
#endif /* __INCuarth */
Reference in New Issue View Git Blame Copy Permalink