source: mainline/uspace/srv/devman/devman.h@ aff587f

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

Reference counting of device and function nodes in devman.
  • Property mode set to 100644
File size: 8.7 KB
Line 
1/*
2 * Copyright (c) 2010 Lenka Trochtova
3 * Copyright (c) 2011 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/** @addtogroup devman
31 * @{
32 */
33
34#ifndef DEVMAN_H_
35#define DEVMAN_H_
36
37#include <assert.h>
38#include <bool.h>
39#include <dirent.h>
40#include <str.h>
41#include <adt/list.h>
42#include <adt/hash_table.h>
43#include <ipc/devman.h>
44#include <ipc/loc.h>
45#include <fibril_synch.h>
46#include <atomic.h>
47#include <async.h>
48
49#include "util.h"
50
51#define NAME "devman"
52
53#define MATCH_EXT ".ma"
54#define DEVICE_BUCKETS 256
55
56#define LOC_DEVICE_NAMESPACE "devices"
57#define LOC_SEPARATOR '\\'
58
59struct dev_node;
60typedef struct dev_node dev_node_t;
61
62struct fun_node;
63typedef struct fun_node fun_node_t;
64
65typedef struct {
66 fibril_mutex_t mutex;
67 struct driver *driver;
68} client_t;
69
70typedef enum {
71 /** Driver has not been started. */
72 DRIVER_NOT_STARTED = 0,
73
74 /**
75 * Driver has been started, but has not registered as running and ready
76 * to receive requests.
77 */
78 DRIVER_STARTING,
79
80 /** Driver is running and prepared to serve incomming requests. */
81 DRIVER_RUNNING
82} driver_state_t;
83
84/** Representation of device driver. */
85typedef struct driver {
86 /** Pointers to previous and next drivers in a linked list. */
87 link_t drivers;
88
89 /**
90 * Specifies whether the driver has been started and wheter is running
91 * and prepared to receive requests.
92 */
93 int state;
94
95 /** Session asociated with this driver. */
96 async_sess_t *sess;
97 /** Name of the device driver. */
98 char *name;
99 /** Path to the driver's binary. */
100 const char *binary_path;
101 /** List of device ids for device-to-driver matching. */
102 match_id_list_t match_ids;
103 /** List of devices controlled by this driver. */
104 list_t devices;
105
106 /**
107 * Fibril mutex for this driver - driver state, list of devices, session.
108 */
109 fibril_mutex_t driver_mutex;
110} driver_t;
111
112/** The list of drivers. */
113typedef struct driver_list {
114 /** List of drivers */
115 list_t drivers;
116 /** Fibril mutex for list of drivers. */
117 fibril_mutex_t drivers_mutex;
118} driver_list_t;
119
120/** The state of the device. */
121typedef enum {
122 DEVICE_NOT_INITIALIZED = 0,
123 DEVICE_USABLE,
124 DEVICE_NOT_PRESENT,
125 DEVICE_INVALID
126} device_state_t;
127
128/** Device node in the device tree. */
129struct dev_node {
130 /** Reference count */
131 atomic_t refcnt;
132
133 /** The global unique identifier of the device. */
134 devman_handle_t handle;
135
136 /** (Parent) function the device is attached to. */
137 fun_node_t *pfun;
138
139 /** List of device functions. */
140 list_t functions;
141 /** Driver of this device. */
142 driver_t *drv;
143 /** The state of the device. */
144 device_state_t state;
145 /** Link to list of devices owned by driver (driver_t.devices) */
146 link_t driver_devices;
147
148 /**
149 * Used by the hash table of devices indexed by devman device handles.
150 */
151 link_t devman_dev;
152
153 /**
154 * Whether this device was already passed to the driver.
155 */
156 bool passed_to_driver;
157};
158
159/** Function node in the device tree. */
160struct fun_node {
161 /** Reference count */
162 atomic_t refcnt;
163
164 /** The global unique identifier of the function */
165 devman_handle_t handle;
166 /** Name of the function, assigned by the device driver */
167 char *name;
168 /** Function type */
169 fun_type_t ftype;
170
171 /** Full path and name of the device in device hierarchy */
172 char *pathname;
173
174 /** Device which this function belongs to */
175 dev_node_t *dev;
176
177 /** Link to list of functions in the device (ddf_dev_t.functions) */
178 link_t dev_functions;
179
180 /** Child device node (if any attached). */
181 dev_node_t *child;
182 /** List of device ids for device-to-driver matching. */
183 match_id_list_t match_ids;
184
185 /** Service ID if the device function is registered with loc. */
186 service_id_t service_id;
187
188 /**
189 * Used by the hash table of functions indexed by devman device handles.
190 */
191 link_t devman_fun;
192
193 /**
194 * Used by the hash table of functions indexed by service IDs.
195 */
196 link_t loc_fun;
197};
198
199
200/** Represents device tree. */
201typedef struct dev_tree {
202 /** Root device node. */
203 fun_node_t *root_node;
204
205 /**
206 * The next available handle - handles are assigned in a sequential
207 * manner.
208 */
209 devman_handle_t current_handle;
210
211 /** Synchronize access to the device tree. */
212 fibril_rwlock_t rwlock;
213
214 /** Hash table of all devices indexed by devman handles. */
215 hash_table_t devman_devices;
216
217 /** Hash table of all devices indexed by devman handles. */
218 hash_table_t devman_functions;
219
220 /**
221 * Hash table of services registered with location service, indexed by
222 * service IDs.
223 */
224 hash_table_t loc_functions;
225} dev_tree_t;
226
227/* Match ids and scores */
228
229extern int get_match_score(driver_t *, dev_node_t *);
230
231extern bool parse_match_ids(char *, match_id_list_t *);
232extern bool read_match_ids(const char *, match_id_list_t *);
233extern char *read_match_id(char **);
234extern char *read_id(const char **);
235
236/* Drivers */
237
238extern void init_driver_list(driver_list_t *);
239extern driver_t *create_driver(void);
240extern bool get_driver_info(const char *, const char *, driver_t *);
241extern int lookup_available_drivers(driver_list_t *, const char *);
242
243extern driver_t *find_best_match_driver(driver_list_t *, dev_node_t *);
244extern bool assign_driver(dev_node_t *, driver_list_t *, dev_tree_t *);
245
246extern void add_driver(driver_list_t *, driver_t *);
247extern void attach_driver(dev_tree_t *, dev_node_t *, driver_t *);
248extern void detach_driver(dev_tree_t *, dev_node_t *);
249extern void add_device(driver_t *, dev_node_t *, dev_tree_t *);
250extern bool start_driver(driver_t *);
251extern int driver_dev_remove(dev_tree_t *, dev_node_t *);
252extern int driver_fun_online(dev_tree_t *, fun_node_t *);
253extern int driver_fun_offline(dev_tree_t *, fun_node_t *);
254
255extern driver_t *find_driver(driver_list_t *, const char *);
256extern void initialize_running_driver(driver_t *, dev_tree_t *);
257
258extern void init_driver(driver_t *);
259extern void clean_driver(driver_t *);
260extern void delete_driver(driver_t *);
261
262/* Device nodes */
263
264extern dev_node_t *create_dev_node(void);
265extern void delete_dev_node(dev_node_t *node);
266extern void dev_add_ref(dev_node_t *);
267extern void dev_del_ref(dev_node_t *);
268extern dev_node_t *find_dev_node_no_lock(dev_tree_t *tree,
269 devman_handle_t handle);
270extern dev_node_t *find_dev_node(dev_tree_t *tree, devman_handle_t handle);
271extern dev_node_t *find_dev_function(dev_node_t *, const char *);
272extern int dev_get_functions(dev_tree_t *tree, dev_node_t *, devman_handle_t *,
273 size_t, size_t *);
274
275extern fun_node_t *create_fun_node(void);
276extern void delete_fun_node(fun_node_t *);
277extern void fun_add_ref(fun_node_t *);
278extern void fun_del_ref(fun_node_t *);
279extern fun_node_t *find_fun_node_no_lock(dev_tree_t *tree,
280 devman_handle_t handle);
281extern fun_node_t *find_fun_node(dev_tree_t *tree, devman_handle_t handle);
282extern fun_node_t *find_fun_node_by_path(dev_tree_t *, char *);
283extern fun_node_t *find_fun_node_in_device(dev_tree_t *tree, dev_node_t *,
284 const char *);
285
286/* Device tree */
287
288extern bool init_device_tree(dev_tree_t *, driver_list_t *);
289extern bool create_root_nodes(dev_tree_t *);
290extern bool insert_dev_node(dev_tree_t *, dev_node_t *, fun_node_t *);
291extern void remove_dev_node(dev_tree_t *, dev_node_t *);
292extern bool insert_fun_node(dev_tree_t *, fun_node_t *, char *, dev_node_t *);
293extern void remove_fun_node(dev_tree_t *, fun_node_t *);
294
295/* Loc services */
296
297extern void loc_register_tree_function(fun_node_t *, dev_tree_t *);
298
299extern fun_node_t *find_loc_tree_function(dev_tree_t *, service_id_t);
300
301extern void tree_add_loc_function(dev_tree_t *, fun_node_t *);
302
303#endif
304
305/** @}
306 */
Note: See TracBrowser for help on using the repository browser.