source: mainline/uspace/lib/drv/generic/remote_battery_dev.c

Last change on this file was 984a9ba, checked in by Martin Decky <martin@…>, 7 years ago

do not expose the call capability handler from the async framework

Keep the call capability handler encapsulated within the async framework
and do not expose it explicitly via its API. Use the pointer to
ipc_call_t as the sole object identifying an IPC call in the code that
uses the async framework.

This plugs a major leak in the abstraction and also simplifies both the
async framework (slightly) and all IPC servers.

  • Property mode set to 100644
File size: 4.6 KB
RevLine 
[69a13a4]1/*
2 * Copyright (c) 2012 Maurizio Lombardi
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 libdrv
30 * @{
31 */
32/** @file
33 */
34
35#include <async.h>
36#include <errno.h>
37#include <ops/battery_dev.h>
[26c03dbd]38#include <battery_iface.h>
[69a13a4]39#include <ddf/driver.h>
[9be30cdf]40#include <macros.h>
[69a13a4]41
[26c03dbd]42/** Read the current battery status from the device
43 *
44 * @param sess Session of the device
45 * @param status Current status of the battery
46 *
[cde999a]47 * @return EOK on success or an error code
[26c03dbd]48 */
[b7fd2a0]49errno_t
[26c03dbd]50battery_status_get(async_sess_t *sess, battery_status_t *batt_status)
51{
52 sysarg_t status;
53
54 async_exch_t *exch = async_exchange_begin(sess);
55
[b7fd2a0]56 errno_t const rc = async_req_1_1(exch, DEV_IFACE_ID(BATTERY_DEV_IFACE),
[26c03dbd]57 BATTERY_STATUS_GET, &status);
58
59 async_exchange_end(exch);
60
61 if (rc == EOK)
62 *batt_status = (battery_status_t) status;
63
64 return rc;
65}
66
67/** Read the current battery charge level from the device
68 *
69 * @param sess Session of the device
70 * @param level Battery charge level (0 - 100)
71 *
[cde999a]72 * @return EOK on success or an error code
[26c03dbd]73 */
[b7fd2a0]74errno_t
[26c03dbd]75battery_charge_level_get(async_sess_t *sess, int *level)
76{
77 sysarg_t charge_level;
78
79 async_exch_t *exch = async_exchange_begin(sess);
80
[b7fd2a0]81 errno_t const rc = async_req_1_1(exch, DEV_IFACE_ID(BATTERY_DEV_IFACE),
[26c03dbd]82 BATTERY_CHARGE_LEVEL_GET, &charge_level);
83
84 async_exchange_end(exch);
85
86 if (rc == EOK)
87 *level = (int) charge_level;
88
89 return rc;
90}
91
[984a9ba]92static void remote_battery_status_get(ddf_fun_t *, void *, ipc_call_t *);
93static void remote_battery_charge_level_get(ddf_fun_t *, void *, ipc_call_t *);
[69a13a4]94
95/** Remote battery interface operations */
[9be30cdf]96static const remote_iface_func_ptr_t remote_battery_dev_iface_ops[] = {
[c1ee46f]97 [BATTERY_STATUS_GET] = remote_battery_status_get,
98 [BATTERY_CHARGE_LEVEL_GET] = remote_battery_charge_level_get,
[69a13a4]99};
100
101/** Remote battery interface structure
102 *
103 * Interface for processing request from remote clients
104 * addressed by the battery interface.
105 *
106 */
[7f80313]107const remote_iface_t remote_battery_dev_iface = {
[9be30cdf]108 .method_count = ARRAY_SIZE(remote_battery_dev_iface_ops),
[69a13a4]109 .methods = remote_battery_dev_iface_ops,
110};
111
112/** Process the status_get() request from the remote client
113 *
[984a9ba]114 * @param fun The function from which the battery status is read
115 * @param ops The local ops structure
116 *
[69a13a4]117 */
[984a9ba]118static void remote_battery_status_get(ddf_fun_t *fun, void *ops,
[69a13a4]119 ipc_call_t *call)
120{
121 const battery_dev_ops_t *bops = (battery_dev_ops_t *) ops;
122
123 if (bops->battery_status_get == NULL) {
[984a9ba]124 async_answer_0(call, ENOTSUP);
[69a13a4]125 return;
126 }
127
128 battery_status_t batt_status;
[b7fd2a0]129 const errno_t rc = bops->battery_status_get(fun, &batt_status);
[69a13a4]130
131 if (rc != EOK)
[984a9ba]132 async_answer_0(call, rc);
[69a13a4]133 else
[984a9ba]134 async_answer_1(call, rc, batt_status);
[69a13a4]135}
136
137/** Process the battery_charge_level_get() request from the remote client
138 *
[984a9ba]139 * @param fun The function from which the battery charge level is read
140 * @param ops The local ops structure
[69a13a4]141 *
142 */
[984a9ba]143static void remote_battery_charge_level_get(ddf_fun_t *fun, void *ops,
[69a13a4]144 ipc_call_t *call)
145{
146 const battery_dev_ops_t *bops = (battery_dev_ops_t *) ops;
147
148 if (bops->battery_charge_level_get == NULL) {
[984a9ba]149 async_answer_0(call, ENOTSUP);
[69a13a4]150 return;
151 }
152
153 int battery_level;
[b7fd2a0]154 const errno_t rc = bops->battery_charge_level_get(fun, &battery_level);
[69a13a4]155
156 if (rc != EOK)
[984a9ba]157 async_answer_0(call, rc);
[69a13a4]158 else
[984a9ba]159 async_answer_1(call, rc, battery_level);
[69a13a4]160}
Note: See TracBrowser for help on using the repository browser.