aboutsummaryrefslogtreecommitdiffstats
path: root/src/chserial.c
blob: b57dc96a456bcfbbeaddc22d62b3d1e7cd4b9db8 (plain)
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
/*
    ChibiOS/RT - Copyright (C) 2006-2007 Giovanni Di Sirio.

    This file is part of ChibiOS/RT.

    ChibiOS/RT is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.

    ChibiOS/RT is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

/**
 * @addtogroup Serial
 * @{
 */

#include <ch.h>

#ifdef CH_USE_SERIAL_FULLDUPLEX
/**
 * Initializes a generic full duplex driver. The HW dependent part of the
 * initialization has to be performed outside, usually in the hardware
 * initialization code.
 * @param sd pointer to a \p FullDuplexDriver structure
 * @param ib pointer to a memory area allocated for the Input Queue buffer
 * @param isize size of the Input Queue buffer
 * @param inotify pointer to a callback function that is invoked when
 *        some data is read from the Queue. The value can be \p NULL.
 * @param ob pointer to a memory area allocated for the Output Queue buffer
 * @param osize size of the Output Queue buffer
 * @param onotify pointer to a callback function that is invoked when
 *        some data is written in the Queue. The value can be \p NULL.
 */
void chFDDInit(FullDuplexDriver *sd,
               uint8_t *ib, size_t isize, qnotify_t inotify,
               uint8_t *ob, size_t osize, qnotify_t onotify) {

  chIQInit(&sd->sd_iqueue, ib, isize, inotify);
  chEvtInit(&sd->sd_ievent);
  chOQInit(&sd->sd_oqueue, ob, osize, onotify);
  chEvtInit(&sd->sd_oevent);
  chEvtInit(&sd->sd_sevent);
  sd->sd_flags = SD_NO_ERROR;
}

/**
 * This function must be called from the input interrupt service routine in
 * order to enqueue incoming data and generate the related events.
 * @param sd pointer to a \p FullDuplexDriver structure
 * @param b the byte to be written in the driver's Input Queue
 */
void chFDDIncomingDataI(FullDuplexDriver *sd, uint8_t b) {

  if (chIQPutI(&sd->sd_iqueue, b) < Q_OK)
    chFDDAddFlagsI(sd, SD_OVERRUN_ERROR);
  else
    chEvtSendI(&sd->sd_ievent);
}

/**
 * Must be called from the output interrupt service routine in order to get
 * the next byte to be transmitted.
 *
 * @param sd pointer to a \p FullDuplexDriver structure
 * @return the byte read from the driver's Output Queue or \p Q_EMPTY if the
 *         queue is empty (the lower driver usually disables the interrupt
 *         source when this happens).
 */
msg_t chFDDRequestDataI(FullDuplexDriver *sd) {

  msg_t b = chOQGetI(&sd->sd_oqueue);
  if (b < Q_OK)
    chEvtSendI(&sd->sd_oevent);
  return b;
}

/**
 * Must be called from the I/O interrupt service routine in order to
 * notify I/O conditions as errors, signals change etc.
 * @param sd pointer to a \p FullDuplexDriver structure
 * @param mask condition flags to be added to the mask
 */
void chFDDAddFlagsI(FullDuplexDriver *sd, dflags_t mask) {

  sd->sd_flags |= mask;
  chEvtSendI(&sd->sd_sevent);
}

/**
 * This function returns and clears the errors mask associated to the driver.
 * @param sd pointer to a \p FullDuplexDriver structure
 * @return the condition flags modified since last time this function was
 *         invoked
 */
dflags_t chFDDGetAndClearFlags(FullDuplexDriver *sd) {
  dflags_t mask;

  mask = sd->sd_flags;
  sd->sd_flags = SD_NO_ERROR;
  return mask;
}
#endif /* CH_USE_SERIAL_FULLDUPLEX */

#ifdef CH_USE_SERIAL_HALFDUPLEX
/**
 * Initializes a generic half duplex driver. The HW dependent part of the
 * initialization has to be performed outside, usually in the hardware
 * initialization code.
 * @param sd pointer to a \p HalfDuplexDriver structure
 * @param b pointer to a memory area allocated for the queue buffer
 * @param size the buffer size
 * @param inotify pointer to a callback function that is invoked when
 *        some data is read from the queue. The value can be \p NULL.
 * @param onotify pointer to a callback function that is invoked when
 *        some data is written in the queue. The value can be \p NULL.
 */
void chHDDInit(HalfDuplexDriver *sd, uint8_t *b, size_t size,
               qnotify_t inotify, qnotify_t onotify) {

  chHDQInit(&sd->sd_queue, b, size, inotify, onotify);
  chEvtInit(&sd->sd_ievent);
  chEvtInit(&sd->sd_oevent);
  chEvtInit(&sd->sd_sevent);
  sd->sd_flags = SD_NO_ERROR;
}

/**
 * This function must be called from the input interrupt service routine in
 * order to enqueue incoming data and generate the related events.
 * @param sd pointer to a \p FullDuplexDriver structure
 * @param b the byte to be written in the driver's Input Queue
 */
void chHDDIncomingDataI(HalfDuplexDriver *sd, uint8_t b) {

  if (chHDQPutReceiveI(&sd->sd_queue, b) < Q_OK)
    chHDDAddFlagsI(sd, SD_OVERRUN_ERROR);
  else
    chEvtSendI(&sd->sd_ievent);
}

/**
 * Must be called from the output interrupt service routine in order to get
 * the next byte to be transmitted.
 *
 * @param sd pointer to a \p HalfDuplexDriver structure
 * @return the byte read from the driver's Output Queue or \p Q_EMPTY if the
 *         queue is empty (the lower driver usually disables the interrupt
 *         source when this happens).
 */
msg_t chHDDRequestDataI(HalfDuplexDriver *sd) {

  msg_t b = chHDQGetTransmitI(&sd->sd_queue);
  if (b < Q_OK)
    chEvtSendI(&sd->sd_oevent);
  return b;
}

/**
 * Must be called from the I/O interrupt service routine in order to
 * notify I/O conditions as errors, signals change etc.
 * @param sd pointer to a \p HalfDuplexDriver structure
 * @param mask condition flags to be added to the mask
 */
void chHDDAddFlagsI(HalfDuplexDriver *sd, dflags_t mask) {

  sd->sd_flags |= mask;
  chEvtSendI(&sd->sd_sevent);
}

/**
 * This function returns and clears the errors mask associated to the driver.
 * @param sd pointer to a \p HalfDuplexDriver structure
 * @return the condition flags modified since last time this function was
 *         invoked
 */
dflags_t chHDDGetAndClearFlags(HalfDuplexDriver *sd) {
  dflags_t mask;

  mask = sd->sd_flags;
  sd->sd_flags = SD_NO_ERROR;
  return mask;
}
#endif /* CH_USE_SERIAL_HALFDUPLEX */

/** @} */