1 /* 2 * Copyright 2005-2008, Haiku Inc. All Rights Reserved. 3 * Distributed under the terms of the MIT License 4 */ 5 #ifndef _ACPI_H 6 #define _ACPI_H 7 8 9 #include <device_manager.h> 10 #include <KernelExport.h> 11 12 13 typedef struct acpi_module_info acpi_module_info; 14 typedef union acpi_object_type acpi_object_type; 15 16 #define B_ACPI_MODULE_NAME "bus_managers/acpi/v1" 17 18 typedef addr_t acpi_physical_address; 19 typedef addr_t acpi_io_address; 20 typedef size_t acpi_size; 21 22 /* Actually a ptr to a NS Node */ 23 typedef void * acpi_handle; 24 25 #ifndef __ACTYPES_H__ 26 27 /* Notify types */ 28 29 #define ACPI_SYSTEM_NOTIFY 0x1 30 #define ACPI_DEVICE_NOTIFY 0x2 31 #define ACPI_ALL_NOTIFY (ACPI_SYSTEM_NOTIFY | ACPI_DEVICE_NOTIFY) 32 #define ACPI_MAX_NOTIFY_HANDLER_TYPE 0x3 33 34 #define ACPI_MAX_SYS_NOTIFY 0x7F 35 36 /* Address Space (Operation Region) Types */ 37 38 enum { 39 ACPI_ADR_SPACE_SYSTEM_MEMORY = 0, 40 ACPI_ADR_SPACE_SYSTEM_IO = 1, 41 ACPI_ADR_SPACE_PCI_CONFIG = 2, 42 ACPI_ADR_SPACE_EC = 3, 43 ACPI_ADR_SPACE_SMBUS = 4, 44 ACPI_ADR_SPACE_CMOS = 5, 45 ACPI_ADR_SPACE_PCI_BAR_TARGET = 6, 46 ACPI_ADR_SPACE_IPMI = 7, 47 ACPI_ADR_SPACE_DATA_TABLE = 8, 48 ACPI_ADR_SPACE_FIXED_HARDWARE = 127 49 }; 50 51 /* ACPI fixed event types */ 52 53 enum { 54 ACPI_EVENT_PMTIMER = 0, 55 ACPI_EVENT_GLOBAL, 56 ACPI_EVENT_POWER_BUTTON, 57 ACPI_EVENT_SLEEP_BUTTON, 58 ACPI_EVENT_RTC 59 }; 60 61 /* ACPI Object Types */ 62 63 enum { 64 ACPI_TYPE_ANY = 0, 65 ACPI_TYPE_INTEGER, 66 ACPI_TYPE_STRING, 67 ACPI_TYPE_BUFFER, 68 ACPI_TYPE_PACKAGE, 69 ACPI_TYPE_FIELD_UNIT, 70 ACPI_TYPE_DEVICE, 71 ACPI_TYPE_EVENT, 72 ACPI_TYPE_METHOD, 73 ACPI_TYPE_MUTEX, 74 ACPI_TYPE_REGION, 75 ACPI_TYPE_POWER, 76 ACPI_TYPE_PROCESSOR, 77 ACPI_TYPE_THERMAL, 78 ACPI_TYPE_BUFFER_FIELD, 79 ACPI_TYPE_DDB_HANDLE, 80 ACPI_TYPE_DEBUG_OBJECT, 81 ACPI_TYPE_LOCAL_REFERENCE = 0x14 82 }; 83 84 /* ACPI control method arg type */ 85 86 union acpi_object_type { 87 uint32 object_type; 88 struct { 89 uint32 object_type; 90 uint64 integer; 91 } integer; 92 struct { 93 uint32 object_type; 94 uint32 len; 95 char *string; /* You have to allocate string space yourself */ 96 } string; 97 struct { 98 uint32 object_type; 99 uint32 length; 100 void *buffer; 101 } buffer; 102 struct { 103 uint32 object_type; 104 uint32 count; 105 acpi_object_type *objects; 106 } package; 107 struct { 108 uint32 object_type; 109 uint32 actual_type; 110 acpi_handle handle; 111 } reference; 112 struct { 113 uint32 object_type; 114 uint32 cpu_id; 115 acpi_io_address pblk_address; 116 uint32 pblk_length; 117 } processor; 118 struct { 119 uint32 object_type; 120 uint32 min_power_state; 121 uint32 resource_order; 122 } power_resource; 123 }; 124 125 126 /* 127 * List of objects, used as a parameter list for control method evaluation 128 */ 129 typedef struct acpi_objects { 130 uint32 count; 131 acpi_object_type *pointer; 132 } acpi_objects; 133 134 135 typedef struct acpi_data { 136 acpi_size length; /* Length in bytes of the buffer */ 137 void *pointer; /* pointer to buffer */ 138 } acpi_data; 139 140 141 enum { 142 ACPI_ALLOCATE_BUFFER = -1, 143 ACPI_ALLOCATE_LOCAL_BUFFER = -2, 144 }; 145 146 147 /* 148 * acpi_status should return ACPI specific error codes, not BeOS ones. 149 */ 150 typedef uint32 acpi_status; 151 152 typedef struct acpi_resource acpi_resource; 153 154 #endif // __ACTYPES_H__ 155 156 157 typedef uint32 (*acpi_event_handler)(void *context); 158 typedef uint32 (*acpi_gpe_handler) (acpi_handle GpeDevice, uint32 GpeNumber, 159 void *context); 160 161 typedef acpi_status (*acpi_adr_space_handler)(uint32 function, 162 acpi_physical_address address, uint32 bitWidth, int *value, 163 void *handlerContext, void *regionContext); 164 165 typedef acpi_status (*acpi_adr_space_setup)(acpi_handle regionHandle, 166 uint32 function, void *handlerContext, void **regionContext); 167 168 typedef void (*acpi_notify_handler)(acpi_handle device, uint32 value, 169 void *context); 170 171 typedef acpi_status (*acpi_walk_resources_callback)(acpi_resource* resource, 172 void* context); 173 174 175 struct acpi_module_info { 176 module_info info; 177 178 status_t (*get_handle)(acpi_handle parent, const char *pathname, 179 acpi_handle *retHandle); 180 181 /* Global Lock */ 182 183 status_t (*acquire_global_lock)(uint16 timeout, uint32 *handle); 184 status_t (*release_global_lock)(uint32 handle); 185 186 /* Notify Handler */ 187 188 status_t (*install_notify_handler)(acpi_handle device, 189 uint32 handlerType, acpi_notify_handler handler, 190 void *context); 191 status_t (*remove_notify_handler)(acpi_handle device, 192 uint32 handlerType, acpi_notify_handler handler); 193 194 /* GPE Handler */ 195 196 status_t (*update_all_gpes)(); 197 status_t (*enable_gpe)(acpi_handle handle, uint32 gpeNumber); 198 status_t (*disable_gpe)(acpi_handle handle, uint32 gpeNumber); 199 status_t (*clear_gpe)(acpi_handle handle, uint32 gpeNumber); 200 status_t (*set_gpe)(acpi_handle handle, uint32 gpeNumber, 201 uint8 action); 202 status_t (*finish_gpe)(acpi_handle handle, uint32 gpeNumber); 203 status_t (*install_gpe_handler)(acpi_handle handle, uint32 gpeNumber, 204 uint32 type, acpi_gpe_handler handler, void *data); 205 status_t (*remove_gpe_handler)(acpi_handle handle, uint32 gpeNumber, 206 acpi_gpe_handler address); 207 208 /* Address Space Handler */ 209 210 status_t (*install_address_space_handler)(acpi_handle handle, 211 uint32 spaceId, 212 acpi_adr_space_handler handler, 213 acpi_adr_space_setup setup, void *data); 214 status_t (*remove_address_space_handler)(acpi_handle handle, 215 uint32 spaceId, 216 acpi_adr_space_handler handler); 217 218 /* Fixed Event Management */ 219 220 void (*enable_fixed_event)(uint32 event); 221 void (*disable_fixed_event)(uint32 event); 222 223 uint32 (*fixed_event_status) (uint32 event); 224 /* Returns 1 if event set, 0 otherwise */ 225 void (*reset_fixed_event) (uint32 event); 226 227 status_t (*install_fixed_event_handler)(uint32 event, 228 acpi_event_handler handler, void *data); 229 status_t (*remove_fixed_event_handler)(uint32 event, 230 acpi_event_handler handler); 231 232 /* Namespace Access */ 233 234 status_t (*get_next_entry)(uint32 objectType, const char *base, 235 char *result, size_t length, void **_counter); 236 status_t (*get_device)(const char *hid, uint32 index, char *result, 237 size_t resultLength); 238 239 status_t (*get_device_hid)(const char *path, char *hid, 240 size_t hidLength); 241 uint32 (*get_object_type)(const char *path); 242 status_t (*get_object)(const char *path, 243 acpi_object_type **_returnValue); 244 status_t (*get_object_typed)(const char *path, 245 acpi_object_type **_returnValue, uint32 objectType); 246 status_t (*ns_handle_to_pathname)(acpi_handle targetHandle, 247 acpi_data *buffer); 248 249 /* Control method execution and data acquisition */ 250 251 status_t (*evaluate_object)(acpi_handle handle, const char* object, 252 acpi_objects *args, acpi_object_type *returnValue, size_t bufferLength); 253 status_t (*evaluate_method)(acpi_handle handle, const char *method, 254 acpi_objects *args, acpi_data *returnValue); 255 256 /* Resource Management */ 257 258 status_t (*get_irq_routing_table)(acpi_handle busDeviceHandle, 259 acpi_data *retBuffer); 260 status_t (*get_current_resources)(acpi_handle busDeviceHandle, 261 acpi_data *retBuffer); 262 status_t (*get_possible_resources)(acpi_handle busDeviceHandle, 263 acpi_data *retBuffer); 264 status_t (*set_current_resources)(acpi_handle busDeviceHandle, 265 acpi_data *buffer); 266 status_t (*walk_resources)(acpi_handle busDeviceHandle, 267 char *method, acpi_walk_resources_callback callback, 268 void* context); 269 270 /* Power state setting */ 271 272 status_t (*prepare_sleep_state)(uint8 state, void (*wakeFunc)(void), 273 size_t size); 274 status_t (*enter_sleep_state)(uint8 state); 275 status_t (*reboot)(void); 276 277 /* Table Access */ 278 status_t (*get_table)(const char *signature, uint32 instance, 279 void **tableHeader); 280 281 /* Register Access */ 282 status_t (*read_bit_register)(uint32 regid, uint32 *val); 283 status_t (*write_bit_register)(uint32 regid, uint32 val); 284 }; 285 286 287 /* Sleep states */ 288 289 enum { 290 ACPI_POWER_STATE_ON = 0, 291 ACPI_POWER_STATE_SLEEP_S1, 292 ACPI_POWER_STATE_SLEEP_S2, 293 ACPI_POWER_STATE_SLEEP_S3, 294 ACPI_POWER_STATE_HIBERNATE, 295 ACPI_POWER_STATE_OFF 296 }; 297 298 299 #define ACPI_DEVICE_HID_ITEM "acpi/hid" 300 #define ACPI_DEVICE_PATH_ITEM "acpi/path" 301 #define ACPI_DEVICE_TYPE_ITEM "acpi/type" 302 303 304 typedef struct acpi_device_cookie *acpi_device; 305 306 // Interface to one ACPI device. 307 typedef struct acpi_device_module_info { 308 driver_module_info info; 309 310 /* Notify Handler */ 311 312 status_t (*install_notify_handler)(acpi_device device, 313 uint32 handlerType, acpi_notify_handler handler, 314 void *context); 315 status_t (*remove_notify_handler)(acpi_device device, 316 uint32 handlerType, acpi_notify_handler handler); 317 318 /* Address Space Handler */ 319 status_t (*install_address_space_handler)(acpi_device device, 320 uint32 spaceId, 321 acpi_adr_space_handler handler, 322 acpi_adr_space_setup setup, void *data); 323 status_t (*remove_address_space_handler)(acpi_device device, 324 uint32 spaceId, 325 acpi_adr_space_handler handler); 326 327 /* Namespace Access */ 328 uint32 (*get_object_type)(acpi_device device); 329 status_t (*get_object)(acpi_device device, const char *path, 330 acpi_object_type **_returnValue); 331 332 /* Control method execution and data acquisition */ 333 status_t (*evaluate_method)(acpi_device device, const char *method, 334 acpi_objects *args, acpi_data *returnValue); 335 336 /* Resource Management */ 337 status_t (*walk_resources)(acpi_device device, char *method, 338 acpi_walk_resources_callback callback, void* context); 339 } acpi_device_module_info; 340 341 342 #endif /* _ACPI_H */ 343