serial_line_dflt.c
8.79 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
/*
*********************************************************************************************************
* 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
* DEFAULT
*
* Filename : serial_line_dflt.c
* Version : V2.00
* Programmer(s) : FGK
*********************************************************************************************************
*/
/*
*********************************************************************************************************
* INCLUDE FILES
*********************************************************************************************************
*/
#define SERIAL_LINE_DFLT_MODULE
#include <serial.h>
/*
*********************************************************************************************************
* 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_Dflt = {
SerialLine_Open,
SerialLine_Close,
SerialLine_RdOctet,
SerialLine_WrOctet
};
/*$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)
{
(void)&pdev;
*perr = SERIAL_ERR_NONE;
return ((void *)0);
}
/*$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)
{
(void)&pdev;
(void)&pline_data;
*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)
{
CPU_BOOLEAN rd;
(void)&pdev;
rd = SerialBuf_RdOctet(pbuf, pdatum);
if (rd == DEF_NO) {
*perr = SERIAL_ERR_UNDERFLOW;
return;
}
*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)
{
CPU_BOOLEAN wr;
(void)&pdev;
wr = SerialBuf_WrOctet(pbuf, datum);
if (wr == DEF_NO) {
*perr = SERIAL_ERR_OVERFLOW;
return;
}
*perr = SERIAL_ERR_NONE;
}