chiark / gitweb /
consistent key naming to match only the event device or include all parent devices
[elogind.git] / udev_rules.h
1 /*
2  * udev_rules.h
3  *
4  * Copyright (C) 2003-2004 Greg Kroah-Hartman <greg@kroah.com>
5  * Copyright (C) 2004-2005 Kay Sievers <kay.sievers@vrfy.org>
6  *
7  *      This program is free software; you can redistribute it and/or modify it
8  *      under the terms of the GNU General Public License as published by the
9  *      Free Software Foundation version 2 of the License.
10  * 
11  *      This program is distributed in the hope that it will be useful, but
12  *      WITHOUT ANY WARRANTY; without even the implied warranty of
13  *      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  *      General Public License for more details.
15  * 
16  *      You should have received a copy of the GNU General Public License along
17  *      with this program; if not, write to the Free Software Foundation, Inc.,
18  *      675 Mass Ave, Cambridge, MA 02139, USA.
19  *
20  */
21
22 #ifndef UDEV_RULES_H
23 #define UDEV_RULES_H
24
25 #include "udev.h"
26 #include "list.h"
27
28 #define PAIRS_MAX               5
29 #define RULEFILE_SUFFIX         ".rules"
30
31 enum key_operation {
32         KEY_OP_UNSET,
33         KEY_OP_MATCH,
34         KEY_OP_NOMATCH,
35         KEY_OP_ADD,
36         KEY_OP_ASSIGN,
37         KEY_OP_ASSIGN_FINAL,
38 };
39
40 struct key {
41         enum key_operation operation;
42         size_t val_off;
43 };
44
45 struct key_pair {
46         struct key key;
47         size_t key_name_off;
48 };
49
50 struct key_pairs {
51         int count;
52         struct key_pair keys[PAIRS_MAX];
53 };
54
55 enum import_type {
56         IMPORT_UNSET,
57         IMPORT_PROGRAM,
58         IMPORT_FILE,
59         IMPORT_PARENT,
60 };
61
62 struct udev_rule {
63         struct key action;
64         struct key devpath;
65         struct key kernel;
66         struct key subsystem;
67         struct key driver;
68         struct key_pairs attr;
69
70         struct key kernels;
71         struct key subsystems;
72         struct key drivers;
73         struct key_pairs attrs;
74
75         struct key_pairs env;
76         struct key program;
77         struct key result;
78         struct key import;
79         enum import_type import_type;
80         struct key run;
81         struct key wait_for_sysfs;
82         struct key label;
83         struct key goto_label;
84
85         struct key name;
86         struct key symlink;
87         struct key owner;
88         struct key group;
89         mode_t mode;
90         enum key_operation mode_operation;
91
92         unsigned int partitions;
93         unsigned int last_rule:1,
94                      ignore_device:1,
95                      ignore_remove:1;
96
97         size_t bufsize;
98         char buf[];
99 };
100
101 struct udev_rules {
102         char *buf;
103         size_t bufsize;
104         size_t current;
105         int resolve_names;
106 };
107
108 extern int udev_rules_init(struct udev_rules *rules, int resolve_names);
109 extern void udev_rules_cleanup(struct udev_rules *rules);
110
111 extern void udev_rules_iter_init(struct udev_rules *rules);
112 extern struct udev_rule *udev_rules_iter_next(struct udev_rules *rules);
113 extern struct udev_rule *udev_rules_iter_label(struct udev_rules *rules, const char *label);
114
115 extern int udev_rules_get_name(struct udev_rules *rules, struct udevice *udev);
116 extern int udev_rules_get_run(struct udev_rules *rules, struct udevice *udev);
117
118 extern void udev_rules_apply_format(struct udevice *udev, char *string, size_t maxsize);
119
120 #endif