2 * \file udi_meta_mgmt.h
4 #ifndef _UDI_META_MGMT_H_
5 #define _UDI_META_MGMT_H_
7 typedef struct udi_mgmt_ops_s udi_mgmt_ops_t;
8 typedef struct udi_mgmt_cb_s udi_mgmt_cb_t;
9 typedef struct udi_usage_cb_s udi_usage_cb_t;
10 typedef struct udi_filter_element_s udi_filter_element_t;
11 typedef struct udi_enumerate_cb_s udi_enumerate_cb_t;
17 typedef void udi_usage_ind_op_t(udi_usage_cb_t *cb, udi_ubit8_t resource_level);
18 /* Values for resource_level */
19 #define UDI_RESOURCES_CRITICAL 1
20 #define UDI_RESOURCES_LOW 2
21 #define UDI_RESOURCES_NORMAL 3
22 #define UDI_RESOURCES_PLENTIFUL 4
24 extern udi_usage_ind_op_t udi_static_usage;
29 typedef void udi_usage_res_op_t(udi_usage_cb_t *cb);
32 * \name Enumerate this driver
35 typedef void udi_enumerate_req_op_t(udi_enumerate_cb_t *cb, udi_ubit8_t enumeration_level);
36 /* Values for enumeration_level */
37 #define UDI_ENUMERATE_START 1
38 #define UDI_ENUMERATE_START_RESCAN 2
39 #define UDI_ENUMERATE_NEXT 3
40 #define UDI_ENUMERATE_NEW 4
41 #define UDI_ENUMERATE_DIRECTED 5
42 #define UDI_ENUMERATE_RELEASE 6
44 extern udi_enumerate_req_op_t udi_enumerate_no_children;
50 * \name Enumeration Acknowlagement
53 typedef void udi_enumerate_ack_op_t(udi_enumerate_cb_t *cb, udi_ubit8_t enumeration_result, udi_index_t ops_idx);
54 /* Values for enumeration_result */
55 #define UDI_ENUMERATE_OK 0
56 #define UDI_ENUMERATE_LEAF 1
57 #define UDI_ENUMERATE_DONE 2
58 #define UDI_ENUMERATE_RESCAN 3
59 #define UDI_ENUMERATE_REMOVED 4
60 #define UDI_ENUMERATE_REMOVED_SELF 5
61 #define UDI_ENUMERATE_RELEASED 6
62 #define UDI_ENUMERATE_FAILED 255
71 typedef void udi_devmgmt_req_op_t(udi_mgmt_cb_t *cb, udi_ubit8_t mgmt_op, udi_ubit8_t parent_ID);
73 typedef void udi_devmgmt_ack_op_t(udi_mgmt_cb_t *cb, udi_ubit8_t flags, udi_status_t status);
77 typedef void udi_final_cleanup_req_op_t(udi_mgmt_cb_t *cb);
78 typedef void udi_final_cleanup_ack_op_t(udi_mgmt_cb_t *cb);
86 udi_usage_ind_op_t *usage_ind_op;
87 udi_enumerate_req_op_t *enumerate_req_op;
88 udi_devmgmt_req_op_t *devmgmt_req_op;
89 udi_final_cleanup_req_op_t *final_cleanup_req_op;
100 udi_trevent_t trace_mask;
101 udi_index_t meta_idx;
105 struct udi_filter_element_s
107 char attr_name[UDI_MAX_ATTR_NAMELEN];
108 udi_ubit8_t attr_min[UDI_MAX_ATTR_SIZE];
109 udi_ubit8_t attr_min_len;
110 udi_ubit8_t attr_max[UDI_MAX_ATTR_SIZE];
111 udi_ubit8_t attr_max_len;
112 udi_instance_attr_type_t attr_type;
113 udi_ubit32_t attr_stride;
115 struct udi_enumerate_cb_s
118 udi_ubit32_t child_ID;
120 udi_instance_attr_list_t *attr_list;
121 udi_ubit8_t attr_valid_length;
122 const udi_filter_element_t *filter_list;
123 udi_ubit8_t filter_list_length;
124 udi_ubit8_t parent_ID;
126 /* Special parent_ID filter values */
127 #define UDI_ANY_PARENT_ID 0
132 extern void udi_devmgmt_req(udi_mgmt_cb_t *cb, udi_ubit8_t mgmt_op, udi_ubit8_t parent_ID );
134 * \brief Values for ::udi_devmgmt_req \a mgmt_op
138 UDI_DMGMT_PREPARE_TO_SUSPEND = 1,
141 UDI_DMGMT_PARENT_SUSPENDED,
146 extern void udi_devmgmt_ack(udi_mgmt_cb_t *cb, udi_ubit8_t flags, udi_status_t status);
147 //!\brief Values for flags
148 #define UDI_DMGMT_NONTRANSPARENT (1U<<0)
149 //!\brief Meta-Specific Status Codes
150 #define UDI_DMGMT_STAT_ROUTING_CHANGE (UDI_STAT_META_SPECIFIC|1)
152 extern void udi_final_cleanup_req(udi_mgmt_cb_t *cb);
153 extern void udi_final_cleanup_ack(udi_mgmt_cb_t *cb);