source: mainline/uspace/lib/c/generic/device/char.c@ f724e82

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

Clean up character device client interface.

  • Property mode set to 100644
File size: 3.8 KB
Line 
1/*
2 * Copyright (c) 2010 Lenka Trochtova
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * - Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * - Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * - The name of the author may not be used to endorse or promote products
15 * derived from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29 /** @addtogroup libc
30 * @{
31 */
32/** @file
33 */
34
35#include <ipc/dev_iface.h>
36#include <device/char.h>
37#include <errno.h>
38#include <async.h>
39#include <malloc.h>
40#include <stdio.h>
41
42/** Read to or write from device.
43 *
44 * Helper function to read to or write from a device
45 * using its character interface.
46 *
47 * @param dev_phone Phone to the device.
48 * @param buf Buffer for the data read from or written to the device.
49 * @param size Maximum size of data (in bytes) to be read or written.
50 * @param read Read from the device if true, write to it otherwise.
51 *
52 * @return Non-negative number of bytes actually read from or
53 * written to the device on success, negative error number
54 * otherwise.
55 */
56static ssize_t char_dev_rw(int dev_phone, void *buf, size_t size, bool read)
57{
58 async_serialize_start();
59
60 ipc_call_t answer;
61 aid_t req;
62 int ret;
63
64 if (read) {
65 req = async_send_1(dev_phone, DEV_IFACE_ID(CHAR_DEV_IFACE),
66 CHAR_DEV_READ, &answer);
67 ret = async_data_read_start(dev_phone, buf, size);
68 } else {
69 req = async_send_1(dev_phone, DEV_IFACE_ID(CHAR_DEV_IFACE),
70 CHAR_DEV_WRITE, &answer);
71 ret = async_data_write_start(dev_phone, buf, size);
72 }
73
74 sysarg_t rc;
75 if (ret != EOK) {
76 async_wait_for(req, &rc);
77 async_serialize_end();
78 if (rc == EOK)
79 return (ssize_t) ret;
80
81 return (ssize_t) rc;
82 }
83
84 async_wait_for(req, &rc);
85 async_serialize_end();
86
87 ret = (int) rc;
88 if (ret != EOK)
89 return (ssize_t) ret;
90
91 return (ssize_t) IPC_GET_ARG1(answer);
92}
93
94/** Read from character device.
95 *
96 * @param dev_phone Phone to the device.
97 * @param buf Output buffer for the data read from the device.
98 * @param size Maximum size (in bytes) of the data to be read.
99 *
100 * @return Non-negative number of bytes actually read from the
101 * device on success, negative error number otherwise.
102 */
103ssize_t char_dev_read(int dev_phone, void *buf, size_t size)
104{
105 return char_dev_rw(dev_phone, buf, size, true);
106}
107
108/** Write to character device.
109 *
110 * @param dev_phone Phone to the device.
111 * @param buf Input buffer containg the data to be written to the
112 * device.
113 * @param size Maximum size (in bytes) of the data to be written.
114 *
115 * @return Non-negative number of bytes actually written to the
116 * device on success, negative error number otherwise.
117 */
118ssize_t char_dev_write(int dev_phone, void *buf, size_t size)
119{
120 return char_dev_rw(dev_phone, buf, size, false);
121}
122
123/** @}
124 */
Note: See TracBrowser for help on using the repository browser.