VSF Documented
vsf_hal_distbus_usart.h
Go to the documentation of this file.
1/*****************************************************************************
2 * Copyright(C)2009-2022 by VSF Team *
3 * *
4 * Licensed under the Apache License, Version 2.0 (the "License"); *
5 * you may not use this file except in compliance with the License. *
6 * You may obtain a copy of the License at *
7 * *
8 * http://www.apache.org/licenses/LICENSE-2.0 *
9 * *
10 * Unless required by applicable law or agreed to in writing, software *
11 * distributed under the License is distributed on an "AS IS" BASIS, *
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
13 * See the License for the specific language governing permissions and *
14 * limitations under the License. *
15 * *
16 ****************************************************************************/
17
18#ifndef __VSF_HAL_DISTBUS_USART_H__
19#define __VSF_HAL_DISTBUS_USART_H__
20
21/*============================ INCLUDES ======================================*/
22
23#include "hal/vsf_hal_cfg.h"
24
25#if VSF_HAL_USE_USART == ENABLED && VSF_HAL_DISTBUS_USE_USART == ENABLED
26
27// for stream
28#include "service/vsf_service.h"
29
30#if defined(__VSF_HAL_DISTBUS_USART_CLASS_IMPLEMENT)
31# define __VSF_CLASS_IMPLEMENT__
32#elif defined(__VSF_HAL_DISTBUS_USART_CLASS_INHERIT__)
33# define __VSF_CLASS_INHERIT__
34#endif
35
36#include "utilities/ooc_class.h"
37
38#ifdef __cplusplus
39extern "C" {
40#endif
41
42/*============================ MACROS ========================================*/
43
44#ifndef VSF_HAL_DISTBUS_USART_CFG_MULTI_CLASS
45# define VSF_HAL_DISTBUS_USART_CFG_MULTI_CLASS VSF_USART_CFG_MULTI_CLASS
46#endif
47
48#ifndef VSF_HAL_DISTBUS_USART_CFG_FIFO_SIZE
49# define VSF_HAL_DISTBUS_USART_CFG_FIFO_SIZE 1024
50#endif
51
52/*============================ MACROFIED FUNCTIONS ===========================*/
53/*============================ TYPES =========================================*/
54
55#if defined(__VSF_HAL_DISTBUS_USART_CLASS_IMPLEMENT) || defined(__VSF_HAL_DISTBUS_USART_CLASS_INHERIT__)
56enum {
57 // commands to slave
58 VSF_HAL_DISTBUS_USART_CMD_INIT = 0,
59 VSF_HAL_DISTBUS_USART_CMD_ENABLE,
60 VSF_HAL_DISTBUS_USART_CMD_DISABLE,
61 VSF_HAL_DISTBUS_USART_CMD_IRQ_ENABLE,
62 VSF_HAL_DISTBUS_USART_CMD_IRQ_DISABLE,
63 VSF_HAL_DISTBUS_USART_CMD_TX,
64
65 // commands to host
66 VSF_HAL_DISTBUS_USART_CMD_TXED_COUNT,
67 VSF_HAL_DISTBUS_USART_CMD_RX,
68 VSF_HAL_DISTBUS_USART_CMD_ISR,
69
70 VSF_HAL_DISTBUS_USART_CMD_ADDR_RANGE,
71};
72
73typedef enum vsf_hal_distbus_usart_mode_t {
74 // parity: 3 bits
75 VSF_HAL_DISTBUS_USART_NO_PARITY = (0x0ul << 0),
76 VSF_HAL_DISTBUS_USART_EVEN_PARITY = (0x1ul << 0),
77 VSF_HAL_DISTBUS_USART_ODD_PARITY = (0x2ul << 0),
78 VSF_HAL_DISTBUS_USART_FORCE_0_PARITY = (0x3ul << 0),
79 VSF_HAL_DISTBUS_USART_FORCE_1_PARITY = (0x4ul << 0),
80 VSF_HAL_DISTBUS_USART_PARITY_MASK = VSF_HAL_DISTBUS_USART_NO_PARITY
81 | VSF_HAL_DISTBUS_USART_EVEN_PARITY
82 | VSF_HAL_DISTBUS_USART_ODD_PARITY
83 | VSF_HAL_DISTBUS_USART_FORCE_0_PARITY
84 | VSF_HAL_DISTBUS_USART_FORCE_1_PARITY,
85
86 // stopbit: 2 bits
87 VSF_HAL_DISTBUS_USART_1_STOPBIT = (0x0ul << 3),
88 VSF_HAL_DISTBUS_USART_1_5_STOPBIT = (0x1ul << 3),
89 VSF_HAL_DISTBUS_USART_2_STOPBIT = (0x2ul << 3),
90 VSF_HAL_DISTBUS_USART_STOPBIT_MASK = VSF_HAL_DISTBUS_USART_1_STOPBIT
91 | VSF_HAL_DISTBUS_USART_1_5_STOPBIT
92 | VSF_HAL_DISTBUS_USART_2_STOPBIT,
93
94 // bit length: 3 bits
95 VSF_HAL_DISTBUS_USART_5_BIT_LENGTH = (0x0ul << 5),
96 VSF_HAL_DISTBUS_USART_6_BIT_LENGTH = (0x1ul << 5),
97 VSF_HAL_DISTBUS_USART_7_BIT_LENGTH = (0x2ul << 5),
98 VSF_HAL_DISTBUS_USART_8_BIT_LENGTH = (0x3ul << 5),
99 VSF_HAL_DISTBUS_USART_9_BIT_LENGTH = (0x4ul << 5),
100 VSF_HAL_DISTBUS_USART_BIT_LENGTH_MASK = VSF_HAL_DISTBUS_USART_5_BIT_LENGTH
101 | VSF_HAL_DISTBUS_USART_6_BIT_LENGTH
102 | VSF_HAL_DISTBUS_USART_7_BIT_LENGTH
103 | VSF_HAL_DISTBUS_USART_8_BIT_LENGTH
104 | VSF_HAL_DISTBUS_USART_9_BIT_LENGTH,
105
106 // hwcontrol: 2 bits
107 VSF_HAL_DISTBUS_USART_NO_HWCONTROL = (0x0ul << 8),
108 VSF_HAL_DISTBUS_USART_RTS_HWCONTROL = (0x1ul << 8),
109 VSF_HAL_DISTBUS_USART_CTS_HWCONTROL = (0x2ul << 8),
110 VSF_HAL_DISTBUS_USART_RTS_CTS_HWCONTROL = (0x3ul << 8),
111 VSF_HAL_DISTBUS_USART_HWCONTROL_MASK = VSF_HAL_DISTBUS_USART_NO_HWCONTROL
112 | VSF_HAL_DISTBUS_USART_RTS_HWCONTROL
113 | VSF_HAL_DISTBUS_USART_CTS_HWCONTROL
114 | VSF_HAL_DISTBUS_USART_RTS_CTS_HWCONTROL,
115
116 // enable: 2 bits
117 VSF_HAL_DISTBUS_USART_TX_ENABLE = (0x1ul << 11),
118 VSF_HAL_DISTBUS_USART_RX_ENABLE = (0x1ul << 12),
119 VSF_HAL_DISTBUS_USART_ENABLE_MASK = VSF_HAL_DISTBUS_USART_TX_ENABLE
120 | VSF_HAL_DISTBUS_USART_RX_ENABLE,
121
122 VSF_HAL_DISTBUS_USART_MODE_ALL_BITS_MASK = VSF_HAL_DISTBUS_USART_PARITY_MASK
123 | VSF_HAL_DISTBUS_USART_STOPBIT_MASK
124 | VSF_HAL_DISTBUS_USART_BIT_LENGTH_MASK
125 | VSF_HAL_DISTBUS_USART_HWCONTROL_MASK
126 | VSF_HAL_DISTBUS_USART_ENABLE_MASK,
127} vsf_hal_distbus_usart_mode_t;
128
129typedef enum vsf_hal_distbus_usart_irq_mask_t {
130 VSF_HAL_DISTBUS_USART_IRQ_MASK_TX_CPL = 1UL << 0,
131 VSF_HAL_DISTBUS_USART_IRQ_MASK_RX_CPL = 1UL << 1,
132 VSF_HAL_DISTBUS_USART_IRQ_MASK_TX = 1UL << 2,
133 VSF_HAL_DISTBUS_USART_IRQ_MASK_RX = 1UL << 3,
134 VSF_HAL_DISTBUS_USART_IRQ_MASK_FRAME_ERR = 1UL << 8,
135 VSF_HAL_DISTBUS_USART_IRQ_MASK_PARITY_ERR = 1UL << 9,
136 VSF_HAL_DISTBUS_USART_IRQ_MASK_BREAK_ERR = 1UL << 10,
137 VSF_HAL_DISTBUS_USART_IRQ_MASK_OVERFLOW_ERR = 1UL << 11,
138 VSF_HAL_DISTBUS_USART_IRQ_MASK_RX_TIMEOUT = 1UL << 12,
139
140 VSF_HAL_DISTBUS_USART_IRQ_MASK_ERR = VSF_HAL_DISTBUS_USART_IRQ_MASK_FRAME_ERR
141 | VSF_HAL_DISTBUS_USART_IRQ_MASK_PARITY_ERR
142 | VSF_HAL_DISTBUS_USART_IRQ_MASK_BREAK_ERR
143 | VSF_HAL_DISTBUS_USART_IRQ_MASK_OVERFLOW_ERR,
144
145 VSF_HAL_DISTBUS_USART_IRQ_ALL_BITS_MASK = VSF_HAL_DISTBUS_USART_IRQ_MASK_TX
146 | VSF_HAL_DISTBUS_USART_IRQ_MASK_RX
147 | VSF_HAL_DISTBUS_USART_IRQ_MASK_RX_TIMEOUT
148 | VSF_HAL_DISTBUS_USART_IRQ_MASK_TX_CPL
149 | VSF_HAL_DISTBUS_USART_IRQ_MASK_RX_CPL
150 | VSF_HAL_DISTBUS_USART_IRQ_MASK_ERR,
151} vsf_hal_distbus_usart_irq_mask_t;
152
153typedef struct vsf_hal_distbus_usart_init_t {
154 uint32_t mode;
155 uint32_t baudrate;
156 uint32_t rx_timeout;
157} VSF_CAL_PACKED vsf_hal_distbus_usart_init_t;
158
159typedef struct vsf_hal_distbus_usart_isr_t {
160 uint32_t irq_mask;
161} VSF_CAL_PACKED vsf_hal_distbus_usart_isr_t;
162
163typedef struct vsf_hal_distbus_usart_txed_cnt_t {
164 uint32_t count;
165} VSF_CAL_PACKED vsf_hal_distbus_usart_txed_cnt_t;
166#endif
167
168vsf_class(vsf_hal_distbus_usart_t) {
169#if VSF_HAL_DISTBUS_USART_CFG_MULTI_CLASS == ENABLED
170 public_member(
171 implement(vsf_usart_t)
172 )
173#endif
174 protected_member(
175 vsf_distbus_service_t service;
176 )
177 private_member(
178 vsf_distbus_t *distbus;
179 struct {
180 vsf_usart_isr_handler_t *handler;
181 void *target;
182 vsf_usart_irq_mask_t mask;
183 } irq;
184 struct {
185 struct {
186 vsf_mem_stream_t stream;
187 uint8_t buffer[VSF_HAL_DISTBUS_USART_CFG_FIFO_SIZE];
188 } rx;
189 struct {
190 vsf_mem_stream_t stream;
191 uint8_t buffer[VSF_HAL_DISTBUS_USART_CFG_FIFO_SIZE];
192 bool is_pending;
193 } tx;
194 } fifo;
195 struct {
196 struct {
197 uint8_t *buffer;
198 uint32_t size;
199 } tx;
200 struct {
201 uint8_t *buffer;
202 uint32_t size;
203 } rx;
204 } dma;
205 )
206};
207
208/*============================ GLOBAL VARIABLES ==============================*/
209/*============================ INCLUDES ======================================*/
210/*============================ PROTOTYPES ====================================*/
211
212extern uint32_t vsf_hal_distbus_usart_register_service(vsf_distbus_t *distbus, vsf_hal_distbus_usart_t *usart, void *info, uint32_t infolen);
213
214#if defined(__VSF_HAL_DISTBUS_USART_CLASS_IMPLEMENT) || defined(__VSF_HAL_DISTBUS_USART_CLASS_INHERIT__)
215extern vsf_usart_mode_t vsf_hal_distbus_usart_mode_to_generic_usart_mode(uint32_t hal_distbus_usart_mode);
216extern uint32_t vsf_generic_usart_mode_to_hal_distbus_usart_mode(vsf_usart_mode_t generic_usart_mode);
217extern vsf_usart_irq_mask_t vsf_hal_distbus_usart_irqmask_to_generic_usart_irqmask(uint32_t hal_distbus_usart_irqmask);
218extern uint32_t vsf_generic_usart_irqmask_to_hal_distbus_usart_irqmask(vsf_usart_irq_mask_t generic_usart_irqmask);
219#endif
220
221/*============================ INCLUDES ======================================*/
222
223#define VSF_USART_CFG_DEC_PREFIX vsf_hal_distbus
224#define VSF_USART_CFG_DEC_UPCASE_PREFIX VSF_HAL_DISTBUS
225#define VSF_USART_CFG_DEC_FIFO_TO_REQUEST
226#include "hal/driver/common/usart/usart_template.h"
227
228#ifdef __cplusplus
229}
230#endif
231
232#undef __VSF_HAL_DISTBUS_USART_CLASS_IMPLEMENT
233#undef __VSF_HAL_DISTBUS_USART_CLASS_INHERIT__
234
235#endif
236#endif
237/* EOF */
238
vsf_usart_mode_t
vsf_usart_mode_t
Definition uart.h:32
vsf_usart_irq_mask_t
vsf_usart_irq_mask_t
Definition uart.h:105
vsf_distbus_service_t
Definition vsf_distbus.h:86
vsf_distbus_t
Definition vsf_distbus.h:119
vsf_hal_distbus_usart_t
Definition vsf_hal_distbus_usart.h:168
vsf_mem_stream_t
Definition vsf_mem_stream.h:88
ooc_class.h
vsf_class
#define vsf_class(__name)
Definition ooc_class.h:48
irq_mask
const i_spi_t vsf_spi_irq_mask_t irq_mask
Definition spi_interface.h:38
uint32_t
unsigned uint32_t
Definition stdint.h:9
uint8_t
unsigned char uint8_t
Definition stdint.h:5
vsf_usart_t
Definition vsf_template_usart.h:661
usart_template.h
vsf_hal_cfg.h
vsf_hal_distbus_usart_irqmask_to_generic_usart_irqmask
vsf_usart_irq_mask_t vsf_hal_distbus_usart_irqmask_to_generic_usart_irqmask(uint32_t hal_distbus_usart_irqmask)
Definition vsf_hal_distbus_usart.c:80
vsf_generic_usart_irqmask_to_hal_distbus_usart_irqmask
uint32_t vsf_generic_usart_irqmask_to_hal_distbus_usart_irqmask(vsf_usart_irq_mask_t generic_usart_irqmask)
Definition vsf_hal_distbus_usart.c:86
vsf_generic_usart_mode_to_hal_distbus_usart_mode
uint32_t vsf_generic_usart_mode_to_hal_distbus_usart_mode(vsf_usart_mode_t generic_usart_mode)
Definition vsf_hal_distbus_usart.c:74
vsf_hal_distbus_usart_mode_to_generic_usart_mode
vsf_usart_mode_t vsf_hal_distbus_usart_mode_to_generic_usart_mode(uint32_t hal_distbus_usart_mode)
Definition vsf_hal_distbus_usart.c:68
VSF_HAL_DISTBUS_USART_CFG_FIFO_SIZE
#define VSF_HAL_DISTBUS_USART_CFG_FIFO_SIZE
Definition vsf_hal_distbus_usart.h:49
vsf_hal_distbus_usart_register_service
uint32_t vsf_hal_distbus_usart_register_service(vsf_distbus_t *distbus, vsf_hal_distbus_usart_t *usart, void *info, uint32_t infolen)
Definition vsf_hal_distbus_usart.c:173
size
uint32_t size
Definition vsf_memfs.h:50
fifo
__bfs_node_fifo_t fifo
Definition vsf_msg_tree.h:247
VSF_CAL_PACKED
struct vk_romfs_header_t VSF_CAL_PACKED
vsf_service.h
vsf_usart_isr_handler_t
void vsf_usart_isr_handler_t(void *target_ptr, vsf_usart_t *usart_ptr, vsf_usart_irq_mask_t irq_mask)
Definition vsf_template_usart.h:546
Generated by doxygen 1.9.8