serial_line_tty.c
16.1 KB
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
/*
*********************************************************************************************************
* SERIAL (BYTE) COMMUNICATION
*
* (c) Copyright 2007-2009; Micrium, Inc.; Weston, FL
*
* All rights reserved. Protected by international copyright laws.
* Knowledge of the source code may NOT be used to develop a similar product.
* Please help us continue to provide the Embedded community with the finest
* software available. Your honesty is greatly appreciated.
*********************************************************************************************************
*/
/*
*********************************************************************************************************
*
* SERIAL (BYTE) COMMUNICATION
*
* SERIAL LINE DRIVER
* TELETYPE TERMINAL (TTY)
*
* Filename : serial_line_tty.c
* Version : V2.00
* Programmer(s) : FGK
*********************************************************************************************************
*/
/*
*********************************************************************************************************
* INCLUDE FILES
*********************************************************************************************************
*/
#define SERIAL_LINE_TTY_MODULE
#include <serial_line_tty.h>
/*
*********************************************************************************************************
* LOCAL DEFINES
*********************************************************************************************************
*/
#define SERIAL_LINE_TTY_TX_STATE_NORMAL 0u
#define SERIAL_LINE_TTY_TX_STATE_CR 1u
/*
*********************************************************************************************************
* FORWARD DECLARATIONS
*********************************************************************************************************
*/
typedef struct serial_line_tty_info SERIAL_LINE_INFO;
/*
*********************************************************************************************************
* LOCAL DATA TYPES
*********************************************************************************************************
*/
struct serial_line_tty_info {
SERIAL_LINE_INFO *NextPtr; /* Ptr to next serial line info struct. */
CPU_INT08U TxState; /* Tx state machine state. */
CPU_BOOLEAN EchoRx; /* Echo rx'd octet. */
CPU_BOOLEAN EchoTx; /* Echo tx'd octet. */
};
/*
*********************************************************************************************************
* LOCAL GLOBAL VARIABLES
*********************************************************************************************************
*/
static SERIAL_LINE_INFO *SerialLine_TTY_Info = (SERIAL_LINE_INFO *)0;
/*
*********************************************************************************************************
* LOCAL FUNCTION PROTOTYPES
*********************************************************************************************************
*/
/* Open line driver. */
static void *SerialLine_Open (SERIAL_DEV *pdev,
SERIAL_ERR *perr);
/* Close line driver. */
static void SerialLine_Close (SERIAL_DEV *pdev,
void *pline_data,
SERIAL_ERR *perr);
/* Rd octet from buf via protocol. */
static void SerialLine_RdOctet(SERIAL_DEV *pdev,
SERIAL_BUF *pbuf,
CPU_INT08U *pdatum,
SERIAL_ERR *perr);
/* Wr octet into buf via protocol. */
static void SerialLine_WrOctet(SERIAL_DEV *pdev,
SERIAL_BUF *pbuf,
CPU_INT08U datum,
SERIAL_ERR *perr);
/*
*********************************************************************************************************
*********************************************************************************************************
* SERIAL INTERFACE LINE DRIVER API
*********************************************************************************************************
*********************************************************************************************************
*/
SERIAL_LINE_DRV_API SerialLine_TTY = {
SerialLine_Open,
SerialLine_Close,
SerialLine_RdOctet,
SerialLine_WrOctet
};
/*$PAGE*/
/*
*********************************************************************************************************
*********************************************************************************************************
* DRIVER AUXILIARY FUNCTIONS
*********************************************************************************************************
*********************************************************************************************************
*/
/*
*********************************************************************************************************
* SerialLine_TTY_EchoRx()
*
* Description : Set receive echo control.
*
* Argument(s) : if_nbr Interface number.
*
* echo Echo control enable or disable: DEF_ENABLED, DEF_DISABLED.
*
* Return(s) : None.
*
* Caller(s) : Application.
*
* Note(s) : None.
*********************************************************************************************************
*/
void SerialLine_TTY_EchoRx (SERIAL_IF_NBR if_nbr,
CPU_BOOLEAN echo)
{
SERIAL_DEV *pdev;
SERIAL_LINE_INFO *pinfo;
SERIAL_ERR err;
pdev = SerialIF_GetDevPtr(if_nbr, &err);
if (err != SERIAL_ERR_NONE) {
return;
}
/* -------------- VALIDATE LINE DRV TYPE -------------- */
if (pdev->LineDrv_API != &SerialLine_TTY) {
return;
}
pinfo = (SERIAL_LINE_INFO *)pdev->LineDrv_Data;
pinfo->EchoRx = echo;
}
/*
*********************************************************************************************************
* SerialLine_TTY_EchoTx()
*
* Description : Set transmit echo control.
*
* Argument(s) : if_nbr Interface number.
*
* echo Echo control enable or disable: DEF_ENABLED, DEF_DISABLED.
*
* Return(s) : None.
*
* Caller(s) : Application.
*
* Note(s) : None.
*********************************************************************************************************
*/
void SerialLine_TTY_EchoTx (SERIAL_IF_NBR if_nbr,
CPU_BOOLEAN echo)
{
SERIAL_DEV *pdev;
SERIAL_LINE_INFO *pinfo;
SERIAL_ERR err;
pdev = SerialIF_GetDevPtr(if_nbr, &err);
if (err != SERIAL_ERR_NONE) {
return;
}
/* -------------- VALIDATE LINE DRV TYPE -------------- */
if (pdev->LineDrv_API != &SerialLine_TTY) {
return;
}
pinfo = (SERIAL_LINE_INFO *)pdev->LineDrv_Data;
pinfo->EchoTx = echo;
}
/*$PAGE*/
/*
*********************************************************************************************************
*********************************************************************************************************
* DRIVER INTERFACE FUNCTIONS
*********************************************************************************************************
*********************************************************************************************************
*/
/*
*********************************************************************************************************
* SerialLine_Open()
*
* Description : Open serial line driver.
*
* Argument(s) : pdev Pointer to device.
*
* perr Pointer to variable that will receive the return error code from this function :
*
* SERIAL_ERR_NONE Serial line driver opened.
* SERIAL_ERR_LINE_OPEN Serial line driver could NOT be opened.
*
* Return(s) : Pointer to line driver data structure.
*
* Caller(s) : Serial_Open().
*
* Note(s) : (1) Interrupts are assumed to be disabled when this function is called.
*********************************************************************************************************
*/
static void *SerialLine_Open (SERIAL_DEV *pdev,
SERIAL_ERR *perr)
{
SERIAL_LINE_INFO *pinfo;
CPU_SIZE_T octets_reqd;
LIB_ERR lib_err;
(void)&pdev;
pinfo = SerialLine_TTY_Info;
if (pinfo == (SERIAL_LINE_INFO *)0) { /* Find avail TTY info struct. */
pinfo = (SERIAL_LINE_INFO *)Mem_HeapAlloc((CPU_SIZE_T ) sizeof(SERIAL_LINE_INFO),
(CPU_SIZE_T ) sizeof(CPU_ALIGN),
(CPU_SIZE_T *)&octets_reqd,
(LIB_ERR *)&lib_err);
if (pinfo == (SERIAL_LINE_INFO *)0) {
*perr = SERIAL_ERR_LINE_DRV_OPEN;
return ((void *)0);
}
} else {
SerialLine_TTY_Info = pinfo->NextPtr;
}
pinfo->NextPtr = (SERIAL_LINE_INFO *)0;
pinfo->TxState = SERIAL_LINE_TTY_TX_STATE_NORMAL;
pinfo->EchoRx = DEF_ENABLED;
pinfo->EchoTx = DEF_DISABLED;
*perr = SERIAL_ERR_NONE;
return ((void *)pinfo);
}
/*$PAGE*/
/*
*********************************************************************************************************
* SerialLine_Close()
*
* Description : Close serial line driver.
*
* Argument(s) : pdev Pointer to device.
*
* pline_data Pointer to line driver data structure.
*
* perr Pointer to variable that will receive the return error code from this function :
*
* SERIAL_ERR_NONE Serial line driver closed.
*
* Return(s) : None.
*
* Caller(s) : Serial_Close().
*
* Note(s) : (1) Interrupts are assumed to be disabled when this function is called.
*********************************************************************************************************
*/
static void SerialLine_Close (SERIAL_DEV *pdev,
void *pline_data,
SERIAL_ERR *perr)
{
SERIAL_LINE_INFO *pinfo;
(void)&pdev;
pinfo = (SERIAL_LINE_INFO *)pline_data;
pinfo->TxState = SERIAL_LINE_TTY_TX_STATE_NORMAL;
pinfo->EchoRx = DEF_DISABLED;
pinfo->EchoTx = DEF_DISABLED;
pinfo->NextPtr = SerialLine_TTY_Info;
SerialLine_TTY_Info = pinfo;
*perr = SERIAL_ERR_NONE;
}
/*$PAGE*/
/*
*********************************************************************************************************
* SerialLine_RdOctet()
*
* Description : Get next octet to transmit.
*
* Argument(s) : pdev Pointer to device.
*
* pbuf Pointer to buffer.
*
* pdatum Pointer to variable that will receive data octet.
*
* perr Pointer to variable that will receive the return error code from this function :
*
* SERIAL_ERR_NONE Octet supplied.
* SERIAL_ERR_UNDERFLOW Buffer underflow.
*
* Return(s) : None.
*
* Caller(s) : Serial_IF_Tx().
*
* Note(s) : (1) Interrupts are assumed to be disabled when this function is called.
*********************************************************************************************************
*/
static void SerialLine_RdOctet (SERIAL_DEV *pdev,
SERIAL_BUF *pbuf,
CPU_INT08U *pdatum,
SERIAL_ERR *perr)
{
SERIAL_LINE_INFO *pinfo;
CPU_BOOLEAN rd;
pinfo = (SERIAL_LINE_INFO *)pdev->LineDrv_Data;
switch (pinfo->TxState) {
case SERIAL_LINE_TTY_TX_STATE_CR: /* ---------------- TX CARRIAGE RETURN ---------------- */
pinfo->TxState = SERIAL_LINE_TTY_TX_STATE_NORMAL;
*pdatum = ASCII_CHAR_CARRIAGE_RETURN;
*perr = SERIAL_ERR_NONE;
return;
case SERIAL_LINE_TTY_TX_STATE_NORMAL: /* --------------------- TX OCTETS -------------------- */
rd = SerialBuf_RdOctet(pbuf, pdatum);
if (rd == DEF_NO) {
*perr = SERIAL_ERR_UNDERFLOW;
return;
}
if (*pdatum == ASCII_CHAR_LINE_FEED) {
pinfo->TxState = SERIAL_LINE_TTY_TX_STATE_CR;
}
break;
}
#if (SERIAL_CFG_RD_BUF_EN == DEF_ENABLED) /* Echo data. */
pinfo = (SERIAL_LINE_INFO *)pdev->LineDrv_Data;
if (pinfo->EchoTx == DEF_ENABLED) {
SerialIF_Rx(pdev, *pdatum);
}
#endif
*perr = SERIAL_ERR_NONE;
}
/*$PAGE*/
/*
*********************************************************************************************************
* SerialLine_WrOctet()
*
* Description : Handle octet received from serial port.
*
* Argument(s) : pdev Pointer to device.
*
* pbuf Pointer to buffer.
*
* datum Data octet to write.
*
* perr Pointer to variable that will receive the return error code from this function :
*
* SERIAL_ERR_NONE Octet handled.
* SERIAL_ERR_OVERFLOW Buffer overflow.
* SERIAL_ERR_LINE_END End of line detected.
*
* Return(s) : None.
*
* Caller(s) : Serial_IF_Rx().
*
* Note(s) : (1) Interrupts are assumed to be disabled when this function is called.
*********************************************************************************************************
*/
static void SerialLine_WrOctet (SERIAL_DEV *pdev,
SERIAL_BUF *pbuf,
CPU_INT08U datum,
SERIAL_ERR *perr)
{
#if (SERIAL_CFG_WR_BUF_EN == DEF_ENABLED)
SERIAL_LINE_INFO *pinfo;
#endif
CPU_BOOLEAN wr;
(void)&pdev;
if ((datum == ASCII_CHAR_LINE_FEED) ||
(datum == ASCII_CHAR_CARRIAGE_RETURN)) {
wr = SerialBuf_WrOctet(pbuf, ASCII_CHAR_NULL);
*perr = SERIAL_ERR_LINE_END;
return;
}
wr = SerialBuf_WrOctet(pbuf, datum);
if (wr == DEF_NO) {
*perr = SERIAL_ERR_OVERFLOW;
return;
}
#if (SERIAL_CFG_WR_BUF_EN == DEF_ENABLED) /* Echo data. */
pinfo = (SERIAL_LINE_INFO *)pdev->LineDrv_Data;
if (pinfo->EchoRx == DEF_ENABLED) {
SerialIF_TxWrBuf(pdev, datum);
}
#endif
*perr = SERIAL_ERR_NONE;
}