no-OS
pico_uart.h
Go to the documentation of this file.
1 /***************************************************************************/
39 #ifndef _PICO_UART_H_
40 #define _PICO_UART_H_
41 
42 /******************************************************************************/
43 /***************************** Include Files **********************************/
44 /******************************************************************************/
45 
46 #include "no_os_uart.h"
47 #include "no_os_irq.h"
48 #include "hardware/uart.h"
49 
50 /******************************************************************************/
51 /*************************** Types Declarations *******************************/
52 /******************************************************************************/
53 
60  uart_inst_t *uart_instance;
65 };
66 
70 enum uart_tx_gp {
71  /* UART0 available configurations */
75  /* UART1 available configurations */
78 };
79 
83 enum uart_rx_gp {
84  /* UART0 available configurations */
88  /* UART1 available configurations */
91 };
92 
101 };
102 
103 #endif
pico_uart.h
Header file of UART driver for pico.
no_os_uart_init
int32_t no_os_uart_init(struct no_os_uart_desc **desc, struct no_os_uart_init_param *param)
Initialize the UART communication peripheral.
Definition: pico_uart.c:75
no_os_uart_init_param::parity
enum no_os_uart_parity parity
Definition: no_os_uart.h:115
lf256fifo_remove
void lf256fifo_remove(struct lf256fifo *fifo)
NO_OS_EVT_UART_RX_COMPLETE
@ NO_OS_EVT_UART_RX_COMPLETE
Definition: no_os_irq.h:70
no_os_uart_init_param::extra
void * extra
Definition: no_os_uart.h:119
no_os_callback_desc
Structure describing a callback to be registered.
Definition: no_os_irq.h:136
UART0_RX_GP1
@ UART0_RX_GP1
Definition: pico_uart.h:85
NO_OS_UART_STOP_1_BIT
@ NO_OS_UART_STOP_1_BIT
Definition: no_os_uart.h:94
no_os_irq.h
Header file of IRQ interface.
no_os_irq_register_callback
int32_t no_os_irq_register_callback(struct no_os_irq_ctrl_desc *desc, uint32_t irq_id, struct no_os_callback_desc *callback_desc)
Register a callback to handle the irq events.
Definition: no_os_irq.c:82
no_os_uart_write
int32_t no_os_uart_write(struct no_os_uart_desc *desc, const uint8_t *data, uint32_t bytes_number)
Write data to UART device.
Definition: pico_uart.c:246
lf256fifo_init
int lf256fifo_init(struct lf256fifo **)
no_os_uart_init_param::size
enum no_os_uart_size size
Definition: no_os_uart.h:113
pico_uart_desc::uart_instance
uart_inst_t * uart_instance
Definition: pico_uart.h:60
uart_tx_gp
uart_tx_gp
Available GP config for UART TX.
Definition: pico_uart.h:70
UART1_RX_GP9
@ UART1_RX_GP9
Definition: pico_uart.h:90
UART1_TX_GP8
@ UART1_TX_GP8
Definition: pico_uart.h:77
NO_OS_UART_CS_5
@ NO_OS_UART_CS_5
Definition: no_os_uart.h:60
UART0_TX_GP16
@ UART0_TX_GP16
Definition: pico_uart.h:74
pico_uart_init_param::uart_tx_pin
enum uart_tx_gp uart_tx_pin
Definition: pico_uart.h:98
no_os_uart_init_param::irq_id
uint32_t irq_id
Definition: no_os_uart.h:107
uart_rx_gp
uart_rx_gp
Available GP config for UART RX.
Definition: pico_uart.h:83
pico_irq_ops
const struct no_os_irq_platform_ops pico_irq_ops
pico specific IRQ platform ops structure
Definition: pico_irq.c:422
no_os_uart_desc::device_id
uint8_t device_id
Definition: no_os_uart.h:128
UART0_TX_GP12
@ UART0_TX_GP12
Definition: pico_uart.h:73
UART0_RX_GP17
@ UART0_RX_GP17
Definition: pico_uart.h:87
lf256fifo_read
int lf256fifo_read(struct lf256fifo *, uint8_t *)
no_os_uart_desc
Stucture holding the UART descriptor.
Definition: no_os_uart.h:126
no_os_error.h
Error codes definition.
no_os_uart_init_param::asynchronous_rx
bool asynchronous_rx
Definition: no_os_uart.h:109
pico_uart_init_param::uart_rx_pin
enum uart_rx_gp uart_rx_pin
Definition: pico_uart.h:100
uart_rx_callback
void uart_rx_callback(void *context)
UART RX callback handler.
Definition: pico_uart.c:60
UART0_TX_GP0
@ UART0_TX_GP0
Definition: pico_uart.h:72
UART0_RX_GP13
@ UART0_RX_GP13
Definition: pico_uart.h:86
no_os_uart_desc::extra
void * extra
Definition: no_os_uart.h:136
no_os_irq_unregister_callback
int32_t no_os_irq_unregister_callback(struct no_os_irq_ctrl_desc *desc, uint32_t irq_id, struct no_os_callback_desc *callback_desc)
Unregisters a generic IRQ handling function.
Definition: no_os_irq.c:96
no_os_irq_init_param::platform_ops
const struct no_os_irq_platform_ops * platform_ops
Definition: no_os_irq.h:107
no_os_uart_desc::rx_fifo
struct lf256fifo * rx_fifo
Definition: no_os_uart.h:132
UART1_TX_GP4
@ UART1_TX_GP4
Definition: pico_uart.h:76
lf256fifo_write
int lf256fifo_write(struct lf256fifo *, uint8_t)
no_os_irq_ctrl_init
int32_t no_os_irq_ctrl_init(struct no_os_irq_ctrl_desc **desc, const struct no_os_irq_init_param *param)
Initialize the IRQ interrupts.
Definition: no_os_irq.c:51
no_os_callback_desc::callback
void(* callback)(void *context)
Definition: no_os_irq.h:138
no_os_uart_init_param::baud_rate
uint32_t baud_rate
Definition: no_os_uart.h:111
no_os_uart_init_param::stop
enum no_os_uart_stop stop
Definition: no_os_uart.h:117
NO_OS_UART_PAR_EVEN
@ NO_OS_UART_PAR_EVEN
Definition: no_os_uart.h:85
no_os_lf256fifo.h
SPSC lock-free fifo of fixed size (256), specialized for UART.
no_os_uart_desc::irq_id
uint32_t irq_id
Definition: no_os_uart.h:130
NO_OS_UART_CS_7
@ NO_OS_UART_CS_7
Definition: no_os_uart.h:64
NO_OS_UART_CS_6
@ NO_OS_UART_CS_6
Definition: no_os_uart.h:62
UART1_RX_GP5
@ UART1_RX_GP5
Definition: pico_uart.h:89
pico_uart_desc::nvic
struct no_os_irq_ctrl_desc * nvic
Definition: pico_uart.h:62
NULL
#define NULL
Definition: wrapper.h:64
no_os_uart_init_param
Structure holding the parameters for UART initialization.
Definition: no_os_uart.h:103
no_os_irq_init_param
Structure holding the initial parameters for Interrupt Request.
Definition: no_os_irq.h:103
NO_OS_UART_PAR_NO
@ NO_OS_UART_PAR_NO
Definition: no_os_uart.h:77
no_os_uart_read
int32_t no_os_uart_read(struct no_os_uart_desc *desc, uint8_t *data, uint32_t bytes_number)
Read data from UART device.
Definition: pico_uart.c:271
NO_OS_UART_IRQ
@ NO_OS_UART_IRQ
Definition: no_os_irq.h:87
no_os_irq_ctrl_remove
int32_t no_os_irq_ctrl_remove(struct no_os_irq_ctrl_desc *desc)
Free the resources allocated by no_os_irq_ctrl_init().
Definition: no_os_irq.c:70
pico_irq.h
Header file for pico irq specifics.
no_os_uart_init_param::device_id
uint8_t device_id
Definition: no_os_uart.h:105
no_os_uart_remove
int32_t no_os_uart_remove(struct no_os_uart_desc *desc)
Free the resources allocated by no_os_uart_init().
Definition: pico_uart.c:214
no_os_irq_enable
int32_t no_os_irq_enable(struct no_os_irq_ctrl_desc *desc, uint32_t irq_id)
Enable specific interrupt.
Definition: no_os_irq.c:144
pico_uart_desc
pico platform specific UART descriptor
Definition: pico_uart.h:58
NO_OS_UART_PAR_ODD
@ NO_OS_UART_PAR_ODD
Definition: no_os_uart.h:83
no_os_uart.h
Header file of UART interface.
pico_uart_desc::rx_callback
struct no_os_callback_desc rx_callback
Definition: pico_uart.h:64
no_os_irq_disable
int32_t no_os_irq_disable(struct no_os_irq_ctrl_desc *desc, uint32_t irq_id)
Disable specific interrupt.
Definition: no_os_irq.c:155
no_os_irq_ctrl_desc
Definition: no_os_irq.h:119
NO_OS_UART_CS_8
@ NO_OS_UART_CS_8
Definition: no_os_uart.h:66
pico_uart_init_param
Additional UART config parameters.
Definition: pico_uart.h:96