source: mainline/uspace/drv/char/pl050/pl050.c@ 677cad5

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since 677cad5 was 677cad5, checked in by Jiri Svoboda <jiri@…>, 8 years ago

Chardev server-side error reporting should match client side.
  • Property mode set to 100644
File size: 9.0 KB
Line 
1/*
2 * Copyright (c) 2009 Vineeth Pillai
3 * Copyright (c) 2014 Jiri Svoboda
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 *
10 * - Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * - Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * - The name of the author may not be used to endorse or promote products
16 * derived from this software without specific prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 */
29
30/** @file
31 */
32
33#include <assert.h>
34#include <bitops.h>
35#include <stdio.h>
36#include <errno.h>
37#include <ddf/driver.h>
38#include <ddf/interrupt.h>
39#include <ddf/log.h>
40#include <device/hw_res.h>
41#include <device/hw_res_parsed.h>
42#include <io/chardev_srv.h>
43
44#include "pl050_hw.h"
45
46#define NAME "pl050"
47
48enum {
49 buffer_size = 64
50};
51
52static int pl050_dev_add(ddf_dev_t *);
53static int pl050_fun_online(ddf_fun_t *);
54static int pl050_fun_offline(ddf_fun_t *);
55static void pl050_char_conn(ipc_callid_t, ipc_call_t *, void *);
56static int pl050_read(chardev_srv_t *, void *, size_t, size_t *);
57static int pl050_write(chardev_srv_t *, const void *, size_t, size_t *);
58
59static driver_ops_t driver_ops = {
60 .dev_add = &pl050_dev_add,
61 .fun_online = &pl050_fun_online,
62 .fun_offline = &pl050_fun_offline
63};
64
65static driver_t pl050_driver = {
66 .name = NAME,
67 .driver_ops = &driver_ops
68};
69
70static chardev_ops_t pl050_chardev_ops = {
71 .read = pl050_read,
72 .write = pl050_write
73};
74
75typedef struct {
76 async_sess_t *parent_sess;
77 ddf_dev_t *dev;
78 char *name;
79
80 ddf_fun_t *fun_a;
81 chardev_srvs_t cds;
82
83 uintptr_t iobase;
84 size_t iosize;
85 kmi_regs_t *regs;
86 uint8_t buffer[buffer_size];
87 size_t buf_rp;
88 size_t buf_wp;
89 fibril_condvar_t buf_cv;
90 fibril_mutex_t buf_lock;
91} pl050_t;
92
93static irq_pio_range_t pl050_ranges[] = {
94 {
95 .base = 0,
96 .size = 9,
97 }
98};
99
100static irq_cmd_t pl050_cmds[] = {
101 {
102 .cmd = CMD_PIO_READ_8,
103 .addr = NULL,
104 .dstarg = 1
105 },
106 {
107 .cmd = CMD_AND,
108 .value = BIT_V(uint8_t, kmi_stat_rxfull),
109 .srcarg = 1,
110 .dstarg = 3
111 },
112 {
113 .cmd = CMD_PREDICATE,
114 .value = 2,
115 .srcarg = 3
116 },
117 {
118 .cmd = CMD_PIO_READ_8,
119 .addr = NULL, /* Will be patched in run-time */
120 .dstarg = 2
121 },
122 {
123 .cmd = CMD_ACCEPT
124 }
125};
126
127static irq_code_t pl050_irq_code = {
128 sizeof(pl050_ranges) / sizeof(irq_pio_range_t),
129 pl050_ranges,
130 sizeof(pl050_cmds) / sizeof(irq_cmd_t),
131 pl050_cmds
132};
133
134static pl050_t *pl050_from_fun(ddf_fun_t *fun)
135{
136 return (pl050_t *)ddf_dev_data_get(ddf_fun_get_dev(fun));
137}
138
139static void pl050_interrupt(ipc_callid_t iid, ipc_call_t *call, ddf_dev_t *dev)
140{
141 pl050_t *pl050 = (pl050_t *)ddf_dev_data_get(dev);
142 size_t nidx;
143
144 fibril_mutex_lock(&pl050->buf_lock);
145 nidx = (pl050->buf_wp + 1) % buffer_size;
146 if (nidx == pl050->buf_rp) {
147 /** Buffer overrunt */
148 ddf_msg(LVL_WARN, "Buffer overrun.");
149 fibril_mutex_unlock(&pl050->buf_lock);
150 return;
151 }
152
153 pl050->buffer[pl050->buf_wp] = IPC_GET_ARG2(*call);
154 pl050->buf_wp = nidx;
155 fibril_condvar_broadcast(&pl050->buf_cv);
156 fibril_mutex_unlock(&pl050->buf_lock);
157}
158
159static int pl050_init(pl050_t *pl050)
160{
161 hw_res_list_parsed_t res;
162 void *regs;
163 int rc;
164
165 fibril_mutex_initialize(&pl050->buf_lock);
166 fibril_condvar_initialize(&pl050->buf_cv);
167 pl050->buf_rp = pl050->buf_wp = 0;
168
169 pl050->parent_sess = ddf_dev_parent_sess_get(pl050->dev);
170 if (pl050->parent_sess == NULL) {
171 ddf_msg(LVL_ERROR, "Failed connecitng parent driver.");
172 rc = ENOMEM;
173 goto error;
174 }
175
176 hw_res_list_parsed_init(&res);
177 rc = hw_res_get_list_parsed(pl050->parent_sess, &res, 0);
178 if (rc != EOK) {
179 ddf_msg(LVL_ERROR, "Failed getting resource list.");
180 goto error;
181 }
182
183 if (res.mem_ranges.count != 1) {
184 ddf_msg(LVL_ERROR, "Expected exactly one memory range.");
185 rc = EINVAL;
186 goto error;
187 }
188
189 pl050->iobase = RNGABS(res.mem_ranges.ranges[0]);
190 pl050->iosize = RNGSZ(res.mem_ranges.ranges[0]);
191
192 pl050_irq_code.ranges[0].base = pl050->iobase;
193 kmi_regs_t *regsphys = (kmi_regs_t *) pl050->iobase;
194 pl050_irq_code.cmds[0].addr = &regsphys->stat;
195 pl050_irq_code.cmds[3].addr = &regsphys->data;
196
197 if (res.irqs.count != 1) {
198 ddf_msg(LVL_ERROR, "Expected exactly one IRQ.");
199 rc = EINVAL;
200 goto error;
201 }
202
203 ddf_msg(LVL_DEBUG, "iobase=%p irq=%d", (void *)pl050->iobase,
204 res.irqs.irqs[0]);
205
206 rc = pio_enable((void *)pl050->iobase, sizeof(kmi_regs_t), &regs);
207 if (rc != EOK) {
208 ddf_msg(LVL_ERROR, "Error enabling PIO");
209 goto error;
210 }
211
212 pl050->regs = regs;
213
214 const int irq_cap = register_interrupt_handler(pl050->dev,
215 res.irqs.irqs[0], pl050_interrupt, &pl050_irq_code);
216 if (irq_cap < 0) {
217 rc = irq_cap;
218 ddf_msg(LVL_ERROR, "Failed registering interrupt handler. (%d)",
219 rc);
220 goto error;
221 }
222
223 rc = hw_res_enable_interrupt(pl050->parent_sess, res.irqs.irqs[0]);
224 if (rc != EOK) {
225 ddf_msg(LVL_ERROR, "Failed enabling interrupt. (%d)", rc);
226 goto error;
227 }
228
229 pio_write_8(&pl050->regs->cr,
230 BIT_V(uint8_t, kmi_cr_enable) |
231 BIT_V(uint8_t, kmi_cr_rxintr));
232
233 return EOK;
234error:
235 return rc;
236}
237
238static int pl050_read(chardev_srv_t *srv, void *buffer, size_t size,
239 size_t *nread)
240{
241 pl050_t *pl050 = (pl050_t *)srv->srvs->sarg;
242 uint8_t *bp = buffer;
243 size_t left;
244
245 fibril_mutex_lock(&pl050->buf_lock);
246
247 left = size;
248 while (left > 0) {
249 while (left == size && pl050->buf_rp == pl050->buf_wp)
250 fibril_condvar_wait(&pl050->buf_cv, &pl050->buf_lock);
251 if (pl050->buf_rp == pl050->buf_wp)
252 break;
253 *bp++ = pl050->buffer[pl050->buf_rp];
254 --left;
255 pl050->buf_rp = (pl050->buf_rp + 1) % buffer_size;
256 }
257
258 fibril_mutex_unlock(&pl050->buf_lock);
259
260 *nread = size - left;
261 return EOK;
262}
263
264static int pl050_write(chardev_srv_t *srv, const void *data, size_t size,
265 size_t *nwritten)
266{
267 pl050_t *pl050 = (pl050_t *)srv->srvs->sarg;
268 uint8_t *dp = (uint8_t *)data;
269 uint8_t status;
270 size_t i;
271
272 ddf_msg(LVL_NOTE, "%s/pl050_write(%zu bytes)", pl050->name, size);
273 for (i = 0; i < size; i++) {
274 while (true) {
275 status = pio_read_8(&pl050->regs->stat);
276 if ((status & BIT_V(uint8_t, kmi_stat_txempty)) != 0)
277 break;
278 }
279 pio_write_8(&pl050->regs->data, dp[i]);
280 }
281 ddf_msg(LVL_NOTE, "%s/pl050_write() success", pl050->name);
282
283 *nwritten = size;
284 return EOK;
285}
286
287void pl050_char_conn(ipc_callid_t iid, ipc_call_t *icall, void *arg)
288{
289 pl050_t *pl050 = pl050_from_fun((ddf_fun_t *)arg);
290
291 chardev_conn(iid, icall, &pl050->cds);
292}
293
294/** Add device. */
295static int pl050_dev_add(ddf_dev_t *dev)
296{
297 ddf_fun_t *fun_a;
298 pl050_t *pl050 = NULL;
299 const char *mname;
300 int rc;
301
302 ddf_msg(LVL_DEBUG, "pl050_dev_add()");
303
304 pl050 = ddf_dev_data_alloc(dev, sizeof(pl050_t));
305 if (pl050 == NULL) {
306 ddf_msg(LVL_ERROR, "Failed allocating soft state.\n");
307 rc = ENOMEM;
308 goto error;
309 }
310
311 pl050->name = (char *)ddf_dev_get_name(dev);
312 if (pl050->name == NULL) {
313 rc = ENOMEM;
314 goto error;
315 }
316
317 fun_a = ddf_fun_create(dev, fun_inner, "a");
318 if (fun_a == NULL) {
319 ddf_msg(LVL_ERROR, "Failed creating function 'a'.");
320 rc = ENOMEM;
321 goto error;
322 }
323
324 pl050->fun_a = fun_a;
325 pl050->dev = dev;
326
327 rc = pl050_init(pl050);
328 if (rc != EOK)
329 goto error;
330
331 if (str_cmp(pl050->name, "kbd") == 0)
332 mname = "char/atkbd";
333 else
334 mname = "char/ps2mouse";
335
336 rc = ddf_fun_add_match_id(fun_a, mname, 10);
337 if (rc != EOK) {
338 ddf_msg(LVL_ERROR, "Failed adding match IDs to function %s",
339 "char/xtkbd");
340 goto error;
341 }
342
343 chardev_srvs_init(&pl050->cds);
344 pl050->cds.ops = &pl050_chardev_ops;
345 pl050->cds.sarg = pl050;
346
347 ddf_fun_set_conn_handler(fun_a, pl050_char_conn);
348
349 rc = ddf_fun_bind(fun_a);
350 if (rc != EOK) {
351 ddf_msg(LVL_ERROR, "Failed binding function 'a'. (%d)", rc);
352 ddf_fun_destroy(fun_a);
353 goto error;
354 }
355
356 ddf_msg(LVL_DEBUG, "Device added.");
357 return EOK;
358error:
359 if (pl050 != NULL)
360 free(pl050->name);
361 return rc;
362}
363
364static int pl050_fun_online(ddf_fun_t *fun)
365{
366 ddf_msg(LVL_DEBUG, "pl050_fun_online()");
367 return ddf_fun_online(fun);
368}
369
370static int pl050_fun_offline(ddf_fun_t *fun)
371{
372 ddf_msg(LVL_DEBUG, "pl050_fun_offline()");
373 return ddf_fun_offline(fun);
374}
375
376int main(int argc, char *argv[])
377{
378 int rc;
379
380 printf(NAME ": HelenOS pl050 serial device driver\n");
381 rc = ddf_log_init(NAME);
382 if (rc != EOK) {
383 printf(NAME ": Error connecting logging service.");
384 return 1;
385 }
386
387 return ddf_driver_main(&pl050_driver);
388}
389
Note: See TracBrowser for help on using the repository browser.