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
|
/*
* Copyright (c) 2016 embedded brains GmbH. All rights reserved.
*
* embedded brains GmbH
* Dornierstr. 4
* 82178 Puchheim
* Germany
* <info@embedded-brains.de>
*
* The license and distribution terms for this file may be
* found in the file LICENSE in this distribution or at
* http://www.rtems.org/license/LICENSE.
*/
#ifndef _DEV_SERIAL_SC16IS752_H
#define _DEV_SERIAL_SC16IS752_H
#include <sys/ioccom.h>
#include <rtems/termiostypes.h>
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
/**
* @defgroup SC16IS752 SC16IS752 Serial Device Driver
*
* @ingroup TermiostypesSupport
*/
typedef enum {
SC16IS752_MODE_RS232,
SC16IS752_MODE_RS485
} sc16is752_mode;
typedef struct sc16is752_context sc16is752_context;
/**
* @brief SC16IS752 device context.
*/
struct sc16is752_context {
rtems_termios_device_context base;
/**
* @brief Writes a register.
*
* Internal handler.
*/
int (*write_reg)(
sc16is752_context *ctx,
uint8_t addr,
const uint8_t *data,
size_t len
);
/**
* @brief Reads a register.
*
* Internal handler.
*/
int (*read_reg)(
sc16is752_context *ctx,
uint8_t addr,
uint8_t *data,
size_t len
);
/**
* @brief Reads two registers.
*
* Internal handler.
*/
int (*read_2_reg)(
sc16is752_context *ctx,
uint8_t addr_0,
uint8_t addr_1,
uint8_t data[2]
);
/**
* @brief First open.
*
* Internal handler.
*/
bool (*first_open)(sc16is752_context *ctx);
/**
* @brief Last close.
*
* Internal handler.
*/
void (*last_close)(sc16is752_context *ctx);
/**
* @brief Shall install the interrupt handler.
*
* Must be initialized by the user before the device creation.
*/
bool (*install_irq)(sc16is752_context *ctx);
/**
* @brief Shall remove the interrupt handler.
*
* Must be initialized by the user before the device creation.
*/
void (*remove_irq)(sc16is752_context *ctx);
/**
* @brief Device mode.
*
* Must be initialized by the user before the device creation.
*/
sc16is752_mode mode;
/**
* @brief Input frequency in Hertz (dependent on crystal, see XTAL1 and XTAL2
* pins).
*
* Must be initialized by the user before the device creation.
*/
uint32_t input_frequency;
/**
* @brief Corresponding Termios structure.
*
* Internal variable.
*/
rtems_termios_tty *tty;
/**
* @brief Shadow Interrupt Enable Register (IER).
*
* Internal variable.
*/
uint8_t ier;
/**
* @brief Characters placed into transmit FIFO.
*
* Internal variable.
*/
uint8_t tx_in_progress;
/**
* @brief Count of free characters in the transmit FIFO.
*
* Internal variable.
*/
uint8_t tx_fifo_free;
/**
* @brief Shadow Line Control Register (LCR).
*
* Internal variable.
*/
uint8_t lcr;
/**
* @brief Shadow Extra Features Control Register (EFCR).
*
* Internal variable.
*/
uint8_t efcr;
};
/**
* @brief SC16IS752 SPI context.
*/
typedef struct {
sc16is752_context base;
/**
* @brief The SPI bus device file descriptor.
*
* Internal variable.
*/
int fd;
/**
* @brief The SPI device chip select.
*
* Must be initialized by the user before the call to sc16is752_spi_create().
*/
uint8_t cs;
/**
* @brief The SPI bus speed in Hertz.
*
* Must be initialized by the user before the call to sc16is752_spi_create().
*/
uint32_t speed_hz;
/**
* @brief The SPI bus device path.
*
* Must be initialized by the user before the call to sc16is752_spi_create().
*/
const char *spi_path;
} sc16is752_spi_context;
/**
* @brief SC16IS752 I2C context.
*/
typedef struct {
sc16is752_context base;
/**
* @brief The I2C bus device file descriptor.
*
* Internal variable.
*/
int fd;
/**
* @brief The I2C bus device path.
*
* Must be initialized before the call to sc16is752_i2c_create().
*/
const char *bus_path;
} sc16is752_i2c_context;
const rtems_termios_device_handler sc16is752_termios_handler;
/**
* @brief The interrupt handler for receive and transmit operations.
*
* @param[in] arg The device context.
*/
void sc16is752_interrupt_handler(void *arg);
/**
* @brief Creates an SPI connected SC16IS752 device.
*
* @param[in] ctx The SPI SC16IS752 device context.
* @param[in] device_path The device file path for the new device.
*
* @retval RTEMS_SUCCESSFUL Successful operation.
* @retval other See rtems_termios_device_install().
*/
rtems_status_code sc16is752_spi_create(
sc16is752_spi_context *ctx,
const char *device_path
);
/**
* @brief Enables the sleep mode if non-zero, otherwise disables it.
*
* The sleep mode is disabled by default.
*/
#define SC16IS752_SET_SLEEP_MODE _IOW('d', 0, int)
/**
* @brief Returns non-zero in case the sleep mode is enabled, otherwise zero.
*/
#define SC16IS752_GET_SLEEP_MODE _IOR('d', 0, int)
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /* _DEV_SERIAL_SC16IS752_H */
|
