1/* SPDX-License-Identifier: (GPL-2.0 OR BSD-3-Clause) */ 2/* 3 * Copyright(c) 2014 - 2015 Google Inc. All rights reserved. 4 * Copyright(c) 2014 - 2015 Linaro Ltd. All rights reserved. 5 */ 6 7#ifndef __GREYBUS_PROTOCOLS_H 8#define __GREYBUS_PROTOCOLS_H 9 10#include <linux/types.h> 11 12/* Fixed IDs for control/svc protocols */ 13 14/* SVC switch-port device ids */ 15#define GB_SVC_DEVICE_ID_SVC 0 16#define GB_SVC_DEVICE_ID_AP 1 17#define GB_SVC_DEVICE_ID_MIN 2 18#define GB_SVC_DEVICE_ID_MAX 31 19 20#define GB_SVC_CPORT_ID 0 21#define GB_CONTROL_BUNDLE_ID 0 22#define GB_CONTROL_CPORT_ID 0 23 24 25/* 26 * All operation messages (both requests and responses) begin with 27 * a header that encodes the size of the message (header included). 28 * This header also contains a unique identifier, that associates a 29 * response message with its operation. The header contains an 30 * operation type field, whose interpretation is dependent on what 31 * type of protocol is used over the connection. The high bit 32 * (0x80) of the operation type field is used to indicate whether 33 * the message is a request (clear) or a response (set). 34 * 35 * Response messages include an additional result byte, which 36 * communicates the result of the corresponding request. A zero 37 * result value means the operation completed successfully. Any 38 * other value indicates an error; in this case, the payload of the 39 * response message (if any) is ignored. The result byte must be 40 * zero in the header for a request message. 41 * 42 * The wire format for all numeric fields in the header is little 43 * endian. Any operation-specific data begins immediately after the 44 * header. 45 */ 46struct gb_operation_msg_hdr { 47 __le16 size; /* Size in bytes of header + payload */ 48 __le16 operation_id; /* Operation unique id */ 49 __u8 type; /* E.g GB_I2C_TYPE_* or GB_GPIO_TYPE_* */ 50 __u8 result; /* Result of request (in responses only) */ 51 __u8 pad[2]; /* must be zero (ignore when read) */ 52} __packed; 53 54 55/* Generic request types */ 56#define GB_REQUEST_TYPE_CPORT_SHUTDOWN 0x00 57#define GB_REQUEST_TYPE_INVALID 0x7f 58 59struct gb_cport_shutdown_request { 60 __u8 phase; 61} __packed; 62 63 64/* Control Protocol */ 65 66/* Greybus control request types */ 67#define GB_CONTROL_TYPE_VERSION 0x01 68#define GB_CONTROL_TYPE_PROBE_AP 0x02 69#define GB_CONTROL_TYPE_GET_MANIFEST_SIZE 0x03 70#define GB_CONTROL_TYPE_GET_MANIFEST 0x04 71#define GB_CONTROL_TYPE_CONNECTED 0x05 72#define GB_CONTROL_TYPE_DISCONNECTED 0x06 73#define GB_CONTROL_TYPE_TIMESYNC_ENABLE 0x07 74#define GB_CONTROL_TYPE_TIMESYNC_DISABLE 0x08 75#define GB_CONTROL_TYPE_TIMESYNC_AUTHORITATIVE 0x09 76/* Unused 0x0a */ 77#define GB_CONTROL_TYPE_BUNDLE_VERSION 0x0b 78#define GB_CONTROL_TYPE_DISCONNECTING 0x0c 79#define GB_CONTROL_TYPE_TIMESYNC_GET_LAST_EVENT 0x0d 80#define GB_CONTROL_TYPE_MODE_SWITCH 0x0e 81#define GB_CONTROL_TYPE_BUNDLE_SUSPEND 0x0f 82#define GB_CONTROL_TYPE_BUNDLE_RESUME 0x10 83#define GB_CONTROL_TYPE_BUNDLE_DEACTIVATE 0x11 84#define GB_CONTROL_TYPE_BUNDLE_ACTIVATE 0x12 85#define GB_CONTROL_TYPE_INTF_SUSPEND_PREPARE 0x13 86#define GB_CONTROL_TYPE_INTF_DEACTIVATE_PREPARE 0x14 87#define GB_CONTROL_TYPE_INTF_HIBERNATE_ABORT 0x15 88 89struct gb_control_version_request { 90 __u8 major; 91 __u8 minor; 92} __packed; 93 94struct gb_control_version_response { 95 __u8 major; 96 __u8 minor; 97} __packed; 98 99struct gb_control_bundle_version_request { 100 __u8 bundle_id; 101} __packed; 102 103struct gb_control_bundle_version_response { 104 __u8 major; 105 __u8 minor; 106} __packed; 107 108/* Control protocol manifest get size request has no payload*/ 109struct gb_control_get_manifest_size_response { 110 __le16 size; 111} __packed; 112 113/* Control protocol manifest get request has no payload */ 114struct gb_control_get_manifest_response { 115 __u8 data[0]; 116} __packed; 117 118/* Control protocol [dis]connected request */ 119struct gb_control_connected_request { 120 __le16 cport_id; 121} __packed; 122 123struct gb_control_disconnecting_request { 124 __le16 cport_id; 125} __packed; 126/* disconnecting response has no payload */ 127 128struct gb_control_disconnected_request { 129 __le16 cport_id; 130} __packed; 131/* Control protocol [dis]connected response has no payload */ 132 133/* 134 * All Bundle power management operations use the same request and response 135 * layout and status codes. 136 */ 137 138#define GB_CONTROL_BUNDLE_PM_OK 0x00 139#define GB_CONTROL_BUNDLE_PM_INVAL 0x01 140#define GB_CONTROL_BUNDLE_PM_BUSY 0x02 141#define GB_CONTROL_BUNDLE_PM_FAIL 0x03 142#define GB_CONTROL_BUNDLE_PM_NA 0x04 143 144struct gb_control_bundle_pm_request { 145 __u8 bundle_id; 146} __packed; 147 148struct gb_control_bundle_pm_response { 149 __u8 status; 150} __packed; 151 152/* 153 * Interface Suspend Prepare and Deactivate Prepare operations use the same 154 * response layout and error codes. Define a single response structure and reuse 155 * it. Both operations have no payload. 156 */ 157 158#define GB_CONTROL_INTF_PM_OK 0x00 159#define GB_CONTROL_INTF_PM_BUSY 0x01 160#define GB_CONTROL_INTF_PM_NA 0x02 161 162struct gb_control_intf_pm_response { 163 __u8 status; 164} __packed; 165 166/* APBridge protocol */ 167 168/* request APB1 log */ 169#define GB_APB_REQUEST_LOG 0x02 170 171/* request to map a cport to bulk in and bulk out endpoints */ 172#define GB_APB_REQUEST_EP_MAPPING 0x03 173 174/* request to get the number of cports available */ 175#define GB_APB_REQUEST_CPORT_COUNT 0x04 176 177/* request to reset a cport state */ 178#define GB_APB_REQUEST_RESET_CPORT 0x05 179 180/* request to time the latency of messages on a given cport */ 181#define GB_APB_REQUEST_LATENCY_TAG_EN 0x06 182#define GB_APB_REQUEST_LATENCY_TAG_DIS 0x07 183 184/* request to control the CSI transmitter */ 185#define GB_APB_REQUEST_CSI_TX_CONTROL 0x08 186 187/* request to control audio streaming */ 188#define GB_APB_REQUEST_AUDIO_CONTROL 0x09 189 190/* TimeSync requests */ 191#define GB_APB_REQUEST_TIMESYNC_ENABLE 0x0d 192#define GB_APB_REQUEST_TIMESYNC_DISABLE 0x0e 193#define GB_APB_REQUEST_TIMESYNC_AUTHORITATIVE 0x0f 194#define GB_APB_REQUEST_TIMESYNC_GET_LAST_EVENT 0x10 195 196/* requests to set Greybus CPort flags */ 197#define GB_APB_REQUEST_CPORT_FLAGS 0x11 198 199/* ARPC request */ 200#define GB_APB_REQUEST_ARPC_RUN 0x12 201 202struct gb_apb_request_cport_flags { 203 __le32 flags; 204#define GB_APB_CPORT_FLAG_CONTROL 0x01 205#define GB_APB_CPORT_FLAG_HIGH_PRIO 0x02 206} __packed; 207 208 209/* Firmware Download Protocol */ 210 211/* Request Types */ 212#define GB_FW_DOWNLOAD_TYPE_FIND_FIRMWARE 0x01 213#define GB_FW_DOWNLOAD_TYPE_FETCH_FIRMWARE 0x02 214#define GB_FW_DOWNLOAD_TYPE_RELEASE_FIRMWARE 0x03 215 216#define GB_FIRMWARE_TAG_MAX_SIZE 10 217 218/* firmware download find firmware request/response */ 219struct gb_fw_download_find_firmware_request { 220 __u8 firmware_tag[GB_FIRMWARE_TAG_MAX_SIZE]; 221} __packed; 222 223struct gb_fw_download_find_firmware_response { 224 __u8 firmware_id; 225 __le32 size; 226} __packed; 227 228/* firmware download fetch firmware request/response */ 229struct gb_fw_download_fetch_firmware_request { 230 __u8 firmware_id; 231 __le32 offset; 232 __le32 size; 233} __packed; 234 235struct gb_fw_download_fetch_firmware_response { 236 __u8 data[0]; 237} __packed; 238 239/* firmware download release firmware request */ 240struct gb_fw_download_release_firmware_request { 241 __u8 firmware_id; 242} __packed; 243/* firmware download release firmware response has no payload */ 244 245 246/* Firmware Management Protocol */ 247 248/* Request Types */ 249#define GB_FW_MGMT_TYPE_INTERFACE_FW_VERSION 0x01 250#define GB_FW_MGMT_TYPE_LOAD_AND_VALIDATE_FW 0x02 251#define GB_FW_MGMT_TYPE_LOADED_FW 0x03 252#define GB_FW_MGMT_TYPE_BACKEND_FW_VERSION 0x04 253#define GB_FW_MGMT_TYPE_BACKEND_FW_UPDATE 0x05 254#define GB_FW_MGMT_TYPE_BACKEND_FW_UPDATED 0x06 255 256#define GB_FW_LOAD_METHOD_UNIPRO 0x01 257#define GB_FW_LOAD_METHOD_INTERNAL 0x02 258 259#define GB_FW_LOAD_STATUS_FAILED 0x00 260#define GB_FW_LOAD_STATUS_UNVALIDATED 0x01 261#define GB_FW_LOAD_STATUS_VALIDATED 0x02 262#define GB_FW_LOAD_STATUS_VALIDATION_FAILED 0x03 263 264#define GB_FW_BACKEND_FW_STATUS_SUCCESS 0x01 265#define GB_FW_BACKEND_FW_STATUS_FAIL_FIND 0x02 266#define GB_FW_BACKEND_FW_STATUS_FAIL_FETCH 0x03 267#define GB_FW_BACKEND_FW_STATUS_FAIL_WRITE 0x04 268#define GB_FW_BACKEND_FW_STATUS_INT 0x05 269#define GB_FW_BACKEND_FW_STATUS_RETRY 0x06 270#define GB_FW_BACKEND_FW_STATUS_NOT_SUPPORTED 0x07 271 272#define GB_FW_BACKEND_VERSION_STATUS_SUCCESS 0x01 273#define GB_FW_BACKEND_VERSION_STATUS_NOT_AVAILABLE 0x02 274#define GB_FW_BACKEND_VERSION_STATUS_NOT_SUPPORTED 0x03 275#define GB_FW_BACKEND_VERSION_STATUS_RETRY 0x04 276#define GB_FW_BACKEND_VERSION_STATUS_FAIL_INT 0x05 277 278/* firmware management interface firmware version request has no payload */ 279struct gb_fw_mgmt_interface_fw_version_response { 280 __u8 firmware_tag[GB_FIRMWARE_TAG_MAX_SIZE]; 281 __le16 major; 282 __le16 minor; 283} __packed; 284 285/* firmware management load and validate firmware request/response */ 286struct gb_fw_mgmt_load_and_validate_fw_request { 287 __u8 request_id; 288 __u8 load_method; 289 __u8 firmware_tag[GB_FIRMWARE_TAG_MAX_SIZE]; 290} __packed; 291/* firmware management load and validate firmware response has no payload*/ 292 293/* firmware management loaded firmware request */ 294struct gb_fw_mgmt_loaded_fw_request { 295 __u8 request_id; 296 __u8 status; 297 __le16 major; 298 __le16 minor; 299} __packed; 300/* firmware management loaded firmware response has no payload */ 301 302/* firmware management backend firmware version request/response */ 303struct gb_fw_mgmt_backend_fw_version_request { 304 __u8 firmware_tag[GB_FIRMWARE_TAG_MAX_SIZE]; 305} __packed; 306 307struct gb_fw_mgmt_backend_fw_version_response { 308 __le16 major; 309 __le16 minor; 310 __u8 status; 311} __packed; 312 313/* firmware management backend firmware update request */ 314struct gb_fw_mgmt_backend_fw_update_request { 315 __u8 request_id; 316 __u8 firmware_tag[GB_FIRMWARE_TAG_MAX_SIZE]; 317} __packed; 318/* firmware management backend firmware update response has no payload */ 319 320/* firmware management backend firmware updated request */ 321struct gb_fw_mgmt_backend_fw_updated_request { 322 __u8 request_id; 323 __u8 status; 324} __packed; 325/* firmware management backend firmware updated response has no payload */ 326 327 328/* Component Authentication Protocol (CAP) */ 329 330/* Request Types */ 331#define GB_CAP_TYPE_GET_ENDPOINT_UID 0x01 332#define GB_CAP_TYPE_GET_IMS_CERTIFICATE 0x02 333#define GB_CAP_TYPE_AUTHENTICATE 0x03 334 335/* CAP get endpoint uid request has no payload */ 336struct gb_cap_get_endpoint_uid_response { 337 __u8 uid[8]; 338} __packed; 339 340/* CAP get endpoint ims certificate request/response */ 341struct gb_cap_get_ims_certificate_request { 342 __le32 certificate_class; 343 __le32 certificate_id; 344} __packed; 345 346struct gb_cap_get_ims_certificate_response { 347 __u8 result_code; 348 __u8 certificate[]; 349} __packed; 350 351/* CAP authenticate request/response */ 352struct gb_cap_authenticate_request { 353 __le32 auth_type; 354 __u8 uid[8]; 355 __u8 challenge[32]; 356} __packed; 357 358struct gb_cap_authenticate_response { 359 __u8 result_code; 360 __u8 response[64]; 361 __u8 signature[]; 362} __packed; 363 364 365/* Bootrom Protocol */ 366 367/* Version of the Greybus bootrom protocol we support */ 368#define GB_BOOTROM_VERSION_MAJOR 0x00 369#define GB_BOOTROM_VERSION_MINOR 0x01 370 371/* Greybus bootrom request types */ 372#define GB_BOOTROM_TYPE_VERSION 0x01 373#define GB_BOOTROM_TYPE_FIRMWARE_SIZE 0x02 374#define GB_BOOTROM_TYPE_GET_FIRMWARE 0x03 375#define GB_BOOTROM_TYPE_READY_TO_BOOT 0x04 376#define GB_BOOTROM_TYPE_AP_READY 0x05 /* Request with no-payload */ 377#define GB_BOOTROM_TYPE_GET_VID_PID 0x06 /* Request with no-payload */ 378 379/* Greybus bootrom boot stages */ 380#define GB_BOOTROM_BOOT_STAGE_ONE 0x01 /* Reserved for the boot ROM */ 381#define GB_BOOTROM_BOOT_STAGE_TWO 0x02 /* Bootrom package to be loaded by the boot ROM */ 382#define GB_BOOTROM_BOOT_STAGE_THREE 0x03 /* Module personality package loaded by Stage 2 firmware */ 383 384/* Greybus bootrom ready to boot status */ 385#define GB_BOOTROM_BOOT_STATUS_INVALID 0x00 /* Firmware blob could not be validated */ 386#define GB_BOOTROM_BOOT_STATUS_INSECURE 0x01 /* Firmware blob is valid but insecure */ 387#define GB_BOOTROM_BOOT_STATUS_SECURE 0x02 /* Firmware blob is valid and secure */ 388 389/* Max bootrom data fetch size in bytes */ 390#define GB_BOOTROM_FETCH_MAX 2000 391 392struct gb_bootrom_version_request { 393 __u8 major; 394 __u8 minor; 395} __packed; 396 397struct gb_bootrom_version_response { 398 __u8 major; 399 __u8 minor; 400} __packed; 401 402/* Bootrom protocol firmware size request/response */ 403struct gb_bootrom_firmware_size_request { 404 __u8 stage; 405} __packed; 406 407struct gb_bootrom_firmware_size_response { 408 __le32 size; 409} __packed; 410 411/* Bootrom protocol get firmware request/response */ 412struct gb_bootrom_get_firmware_request { 413 __le32 offset; 414 __le32 size; 415} __packed; 416 417struct gb_bootrom_get_firmware_response { 418 __u8 data[0]; 419} __packed; 420 421/* Bootrom protocol Ready to boot request */ 422struct gb_bootrom_ready_to_boot_request { 423 __u8 status; 424} __packed; 425/* Bootrom protocol Ready to boot response has no payload */ 426 427/* Bootrom protocol get VID/PID request has no payload */ 428struct gb_bootrom_get_vid_pid_response { 429 __le32 vendor_id; 430 __le32 product_id; 431} __packed; 432 433 434/* Power Supply */ 435 436/* Greybus power supply request types */ 437#define GB_POWER_SUPPLY_TYPE_GET_SUPPLIES 0x02 438#define GB_POWER_SUPPLY_TYPE_GET_DESCRIPTION 0x03 439#define GB_POWER_SUPPLY_TYPE_GET_PROP_DESCRIPTORS 0x04 440#define GB_POWER_SUPPLY_TYPE_GET_PROPERTY 0x05 441#define GB_POWER_SUPPLY_TYPE_SET_PROPERTY 0x06 442#define GB_POWER_SUPPLY_TYPE_EVENT 0x07 443 444/* Greybus power supply battery technologies types */ 445#define GB_POWER_SUPPLY_TECH_UNKNOWN 0x0000 446#define GB_POWER_SUPPLY_TECH_NiMH 0x0001 447#define GB_POWER_SUPPLY_TECH_LION 0x0002 448#define GB_POWER_SUPPLY_TECH_LIPO 0x0003 449#define GB_POWER_SUPPLY_TECH_LiFe 0x0004 450#define GB_POWER_SUPPLY_TECH_NiCd 0x0005 451#define GB_POWER_SUPPLY_TECH_LiMn 0x0006 452 453/* Greybus power supply types */ 454#define GB_POWER_SUPPLY_UNKNOWN_TYPE 0x0000 455#define GB_POWER_SUPPLY_BATTERY_TYPE 0x0001 456#define GB_POWER_SUPPLY_UPS_TYPE 0x0002 457#define GB_POWER_SUPPLY_MAINS_TYPE 0x0003 458#define GB_POWER_SUPPLY_USB_TYPE 0x0004 459#define GB_POWER_SUPPLY_USB_DCP_TYPE 0x0005 460#define GB_POWER_SUPPLY_USB_CDP_TYPE 0x0006 461#define GB_POWER_SUPPLY_USB_ACA_TYPE 0x0007 462 463/* Greybus power supply health values */ 464#define GB_POWER_SUPPLY_HEALTH_UNKNOWN 0x0000 465#define GB_POWER_SUPPLY_HEALTH_GOOD 0x0001 466#define GB_POWER_SUPPLY_HEALTH_OVERHEAT 0x0002 467#define GB_POWER_SUPPLY_HEALTH_DEAD 0x0003 468#define GB_POWER_SUPPLY_HEALTH_OVERVOLTAGE 0x0004 469#define GB_POWER_SUPPLY_HEALTH_UNSPEC_FAILURE 0x0005 470#define GB_POWER_SUPPLY_HEALTH_COLD 0x0006 471#define GB_POWER_SUPPLY_HEALTH_WATCHDOG_TIMER_EXPIRE 0x0007 472#define GB_POWER_SUPPLY_HEALTH_SAFETY_TIMER_EXPIRE 0x0008 473 474/* Greybus power supply status values */ 475#define GB_POWER_SUPPLY_STATUS_UNKNOWN 0x0000 476#define GB_POWER_SUPPLY_STATUS_CHARGING 0x0001 477#define GB_POWER_SUPPLY_STATUS_DISCHARGING 0x0002 478#define GB_POWER_SUPPLY_STATUS_NOT_CHARGING 0x0003 479#define GB_POWER_SUPPLY_STATUS_FULL 0x0004 480 481/* Greybus power supply capacity level values */ 482#define GB_POWER_SUPPLY_CAPACITY_LEVEL_UNKNOWN 0x0000 483#define GB_POWER_SUPPLY_CAPACITY_LEVEL_CRITICAL 0x0001 484#define GB_POWER_SUPPLY_CAPACITY_LEVEL_LOW 0x0002 485#define GB_POWER_SUPPLY_CAPACITY_LEVEL_NORMAL 0x0003 486#define GB_POWER_SUPPLY_CAPACITY_LEVEL_HIGH 0x0004 487#define GB_POWER_SUPPLY_CAPACITY_LEVEL_FULL 0x0005 488 489/* Greybus power supply scope values */ 490#define GB_POWER_SUPPLY_SCOPE_UNKNOWN 0x0000 491#define GB_POWER_SUPPLY_SCOPE_SYSTEM 0x0001 492#define GB_POWER_SUPPLY_SCOPE_DEVICE 0x0002 493 494struct gb_power_supply_get_supplies_response { 495 __u8 supplies_count; 496} __packed; 497 498struct gb_power_supply_get_description_request { 499 __u8 psy_id; 500} __packed; 501 502struct gb_power_supply_get_description_response { 503 __u8 manufacturer[32]; 504 __u8 model[32]; 505 __u8 serial_number[32]; 506 __le16 type; 507 __u8 properties_count; 508} __packed; 509 510struct gb_power_supply_props_desc { 511 __u8 property; 512#define GB_POWER_SUPPLY_PROP_STATUS 0x00 513#define GB_POWER_SUPPLY_PROP_CHARGE_TYPE 0x01 514#define GB_POWER_SUPPLY_PROP_HEALTH 0x02 515#define GB_POWER_SUPPLY_PROP_PRESENT 0x03 516#define GB_POWER_SUPPLY_PROP_ONLINE 0x04 517#define GB_POWER_SUPPLY_PROP_AUTHENTIC 0x05 518#define GB_POWER_SUPPLY_PROP_TECHNOLOGY 0x06 519#define GB_POWER_SUPPLY_PROP_CYCLE_COUNT 0x07 520#define GB_POWER_SUPPLY_PROP_VOLTAGE_MAX 0x08 521#define GB_POWER_SUPPLY_PROP_VOLTAGE_MIN 0x09 522#define GB_POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN 0x0A 523#define GB_POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN 0x0B 524#define GB_POWER_SUPPLY_PROP_VOLTAGE_NOW 0x0C 525#define GB_POWER_SUPPLY_PROP_VOLTAGE_AVG 0x0D 526#define GB_POWER_SUPPLY_PROP_VOLTAGE_OCV 0x0E 527#define GB_POWER_SUPPLY_PROP_VOLTAGE_BOOT 0x0F 528#define GB_POWER_SUPPLY_PROP_CURRENT_MAX 0x10 529#define GB_POWER_SUPPLY_PROP_CURRENT_NOW 0x11 530#define GB_POWER_SUPPLY_PROP_CURRENT_AVG 0x12 531#define GB_POWER_SUPPLY_PROP_CURRENT_BOOT 0x13 532#define GB_POWER_SUPPLY_PROP_POWER_NOW 0x14 533#define GB_POWER_SUPPLY_PROP_POWER_AVG 0x15 534#define GB_POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN 0x16 535#define GB_POWER_SUPPLY_PROP_CHARGE_EMPTY_DESIGN 0x17 536#define GB_POWER_SUPPLY_PROP_CHARGE_FULL 0x18 537#define GB_POWER_SUPPLY_PROP_CHARGE_EMPTY 0x19 538#define GB_POWER_SUPPLY_PROP_CHARGE_NOW 0x1A 539#define GB_POWER_SUPPLY_PROP_CHARGE_AVG 0x1B 540#define GB_POWER_SUPPLY_PROP_CHARGE_COUNTER 0x1C 541#define GB_POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT 0x1D 542#define GB_POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT_MAX 0x1E 543#define GB_POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE 0x1F 544#define GB_POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE_MAX 0x20 545#define GB_POWER_SUPPLY_PROP_CHARGE_CONTROL_LIMIT 0x21 546#define GB_POWER_SUPPLY_PROP_CHARGE_CONTROL_LIMIT_MAX 0x22 547#define GB_POWER_SUPPLY_PROP_INPUT_CURRENT_LIMIT 0x23 548#define GB_POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN 0x24 549#define GB_POWER_SUPPLY_PROP_ENERGY_EMPTY_DESIGN 0x25 550#define GB_POWER_SUPPLY_PROP_ENERGY_FULL 0x26 551#define GB_POWER_SUPPLY_PROP_ENERGY_EMPTY 0x27 552#define GB_POWER_SUPPLY_PROP_ENERGY_NOW 0x28 553#define GB_POWER_SUPPLY_PROP_ENERGY_AVG 0x29 554#define GB_POWER_SUPPLY_PROP_CAPACITY 0x2A 555#define GB_POWER_SUPPLY_PROP_CAPACITY_ALERT_MIN 0x2B 556#define GB_POWER_SUPPLY_PROP_CAPACITY_ALERT_MAX 0x2C 557#define GB_POWER_SUPPLY_PROP_CAPACITY_LEVEL 0x2D 558#define GB_POWER_SUPPLY_PROP_TEMP 0x2E 559#define GB_POWER_SUPPLY_PROP_TEMP_MAX 0x2F 560#define GB_POWER_SUPPLY_PROP_TEMP_MIN 0x30 561#define GB_POWER_SUPPLY_PROP_TEMP_ALERT_MIN 0x31 562#define GB_POWER_SUPPLY_PROP_TEMP_ALERT_MAX 0x32 563#define GB_POWER_SUPPLY_PROP_TEMP_AMBIENT 0x33 564#define GB_POWER_SUPPLY_PROP_TEMP_AMBIENT_ALERT_MIN 0x34 565#define GB_POWER_SUPPLY_PROP_TEMP_AMBIENT_ALERT_MAX 0x35 566#define GB_POWER_SUPPLY_PROP_TIME_TO_EMPTY_NOW 0x36 567#define GB_POWER_SUPPLY_PROP_TIME_TO_EMPTY_AVG 0x37 568#define GB_POWER_SUPPLY_PROP_TIME_TO_FULL_NOW 0x38 569#define GB_POWER_SUPPLY_PROP_TIME_TO_FULL_AVG 0x39 570#define GB_POWER_SUPPLY_PROP_TYPE 0x3A 571#define GB_POWER_SUPPLY_PROP_SCOPE 0x3B 572#define GB_POWER_SUPPLY_PROP_CHARGE_TERM_CURRENT 0x3C 573#define GB_POWER_SUPPLY_PROP_CALIBRATE 0x3D 574 __u8 is_writeable; 575} __packed; 576 577struct gb_power_supply_get_property_descriptors_request { 578 __u8 psy_id; 579} __packed; 580 581struct gb_power_supply_get_property_descriptors_response { 582 __u8 properties_count; 583 struct gb_power_supply_props_desc props[]; 584} __packed; 585 586struct gb_power_supply_get_property_request { 587 __u8 psy_id; 588 __u8 property; 589} __packed; 590 591struct gb_power_supply_get_property_response { 592 __le32 prop_val; 593}; 594 595struct gb_power_supply_set_property_request { 596 __u8 psy_id; 597 __u8 property; 598 __le32 prop_val; 599} __packed; 600 601struct gb_power_supply_event_request { 602 __u8 psy_id; 603 __u8 event; 604#define GB_POWER_SUPPLY_UPDATE 0x01 605} __packed; 606 607 608/* HID */ 609 610/* Greybus HID operation types */ 611#define GB_HID_TYPE_GET_DESC 0x02 612#define GB_HID_TYPE_GET_REPORT_DESC 0x03 613#define GB_HID_TYPE_PWR_ON 0x04 614#define GB_HID_TYPE_PWR_OFF 0x05 615#define GB_HID_TYPE_GET_REPORT 0x06 616#define GB_HID_TYPE_SET_REPORT 0x07 617#define GB_HID_TYPE_IRQ_EVENT 0x08 618 619/* Report type */ 620#define GB_HID_INPUT_REPORT 0 621#define GB_HID_OUTPUT_REPORT 1 622#define GB_HID_FEATURE_REPORT 2 623 624/* Different request/response structures */ 625/* HID get descriptor response */ 626struct gb_hid_desc_response { 627 __u8 bLength; 628 __le16 wReportDescLength; 629 __le16 bcdHID; 630 __le16 wProductID; 631 __le16 wVendorID; 632 __u8 bCountryCode; 633} __packed; 634 635/* HID get report request/response */ 636struct gb_hid_get_report_request { 637 __u8 report_type; 638 __u8 report_id; 639} __packed; 640 641/* HID set report request */ 642struct gb_hid_set_report_request { 643 __u8 report_type; 644 __u8 report_id; 645 __u8 report[]; 646} __packed; 647 648/* HID input report request, via interrupt pipe */ 649struct gb_hid_input_report_request { 650 __u8 report[0]; 651} __packed; 652 653 654/* I2C */ 655 656/* Greybus i2c request types */ 657#define GB_I2C_TYPE_FUNCTIONALITY 0x02 658#define GB_I2C_TYPE_TRANSFER 0x05 659 660/* functionality request has no payload */ 661struct gb_i2c_functionality_response { 662 __le32 functionality; 663} __packed; 664 665/* 666 * Outgoing data immediately follows the op count and ops array. 667 * The data for each write (master -> slave) op in the array is sent 668 * in order, with no (e.g. pad) bytes separating them. 669 * 670 * Short reads cause the entire transfer request to fail So response 671 * payload consists only of bytes read, and the number of bytes is 672 * exactly what was specified in the corresponding op. Like 673 * outgoing data, the incoming data is in order and contiguous. 674 */ 675struct gb_i2c_transfer_op { 676 __le16 addr; 677 __le16 flags; 678 __le16 size; 679} __packed; 680 681struct gb_i2c_transfer_request { 682 __le16 op_count; 683 struct gb_i2c_transfer_op ops[]; /* op_count of these */ 684} __packed; 685struct gb_i2c_transfer_response { 686 __u8 data[0]; /* inbound data */ 687} __packed; 688 689 690/* GPIO */ 691 692/* Greybus GPIO request types */ 693#define GB_GPIO_TYPE_LINE_COUNT 0x02 694#define GB_GPIO_TYPE_ACTIVATE 0x03 695#define GB_GPIO_TYPE_DEACTIVATE 0x04 696#define GB_GPIO_TYPE_GET_DIRECTION 0x05 697#define GB_GPIO_TYPE_DIRECTION_IN 0x06 698#define GB_GPIO_TYPE_DIRECTION_OUT 0x07 699#define GB_GPIO_TYPE_GET_VALUE 0x08 700#define GB_GPIO_TYPE_SET_VALUE 0x09 701#define GB_GPIO_TYPE_SET_DEBOUNCE 0x0a 702#define GB_GPIO_TYPE_IRQ_TYPE 0x0b 703#define GB_GPIO_TYPE_IRQ_MASK 0x0c 704#define GB_GPIO_TYPE_IRQ_UNMASK 0x0d 705#define GB_GPIO_TYPE_IRQ_EVENT 0x0e 706 707#define GB_GPIO_IRQ_TYPE_NONE 0x00 708#define GB_GPIO_IRQ_TYPE_EDGE_RISING 0x01 709#define GB_GPIO_IRQ_TYPE_EDGE_FALLING 0x02 710#define GB_GPIO_IRQ_TYPE_EDGE_BOTH 0x03 711#define GB_GPIO_IRQ_TYPE_LEVEL_HIGH 0x04 712#define GB_GPIO_IRQ_TYPE_LEVEL_LOW 0x08 713 714/* line count request has no payload */ 715struct gb_gpio_line_count_response { 716 __u8 count; 717} __packed; 718 719struct gb_gpio_activate_request { 720 __u8 which; 721} __packed; 722/* activate response has no payload */ 723 724struct gb_gpio_deactivate_request { 725 __u8 which; 726} __packed; 727/* deactivate response has no payload */ 728 729struct gb_gpio_get_direction_request { 730 __u8 which; 731} __packed; 732struct gb_gpio_get_direction_response { 733 __u8 direction; 734} __packed; 735 736struct gb_gpio_direction_in_request { 737 __u8 which; 738} __packed; 739/* direction in response has no payload */ 740 741struct gb_gpio_direction_out_request { 742 __u8 which; 743 __u8 value; 744} __packed; 745/* direction out response has no payload */ 746 747struct gb_gpio_get_value_request { 748 __u8 which; 749} __packed; 750struct gb_gpio_get_value_response { 751 __u8 value; 752} __packed; 753 754struct gb_gpio_set_value_request { 755 __u8 which; 756 __u8 value; 757} __packed; 758/* set value response has no payload */ 759 760struct gb_gpio_set_debounce_request { 761 __u8 which; 762 __le16 usec; 763} __packed; 764/* debounce response has no payload */ 765 766struct gb_gpio_irq_type_request { 767 __u8 which; 768 __u8 type; 769} __packed; 770/* irq type response has no payload */ 771 772struct gb_gpio_irq_mask_request { 773 __u8 which; 774} __packed; 775/* irq mask response has no payload */ 776 777struct gb_gpio_irq_unmask_request { 778 __u8 which; 779} __packed; 780/* irq unmask response has no payload */ 781 782/* irq event requests originate on another module and are handled on the AP */ 783struct gb_gpio_irq_event_request { 784 __u8 which; 785} __packed; 786/* irq event has no response */ 787 788 789/* PWM */ 790 791/* Greybus PWM operation types */ 792#define GB_PWM_TYPE_PWM_COUNT 0x02 793#define GB_PWM_TYPE_ACTIVATE 0x03 794#define GB_PWM_TYPE_DEACTIVATE 0x04 795#define GB_PWM_TYPE_CONFIG 0x05 796#define GB_PWM_TYPE_POLARITY 0x06 797#define GB_PWM_TYPE_ENABLE 0x07 798#define GB_PWM_TYPE_DISABLE 0x08 799 800/* pwm count request has no payload */ 801struct gb_pwm_count_response { 802 __u8 count; 803} __packed; 804 805struct gb_pwm_activate_request { 806 __u8 which; 807} __packed; 808 809struct gb_pwm_deactivate_request { 810 __u8 which; 811} __packed; 812 813struct gb_pwm_config_request { 814 __u8 which; 815 __le32 duty; 816 __le32 period; 817} __packed; 818 819struct gb_pwm_polarity_request { 820 __u8 which; 821 __u8 polarity; 822} __packed; 823 824struct gb_pwm_enable_request { 825 __u8 which; 826} __packed; 827 828struct gb_pwm_disable_request { 829 __u8 which; 830} __packed; 831 832/* SPI */ 833 834/* Should match up with modes in linux/spi/spi.h */ 835#define GB_SPI_MODE_CPHA 0x01 /* clock phase */ 836#define GB_SPI_MODE_CPOL 0x02 /* clock polarity */ 837#define GB_SPI_MODE_MODE_0 (0 | 0) /* (original MicroWire) */ 838#define GB_SPI_MODE_MODE_1 (0 | GB_SPI_MODE_CPHA) 839#define GB_SPI_MODE_MODE_2 (GB_SPI_MODE_CPOL | 0) 840#define GB_SPI_MODE_MODE_3 (GB_SPI_MODE_CPOL | GB_SPI_MODE_CPHA) 841#define GB_SPI_MODE_CS_HIGH 0x04 /* chipselect active high? */ 842#define GB_SPI_MODE_LSB_FIRST 0x08 /* per-word bits-on-wire */ 843#define GB_SPI_MODE_3WIRE 0x10 /* SI/SO signals shared */ 844#define GB_SPI_MODE_LOOP 0x20 /* loopback mode */ 845#define GB_SPI_MODE_NO_CS 0x40 /* 1 dev/bus, no chipselect */ 846#define GB_SPI_MODE_READY 0x80 /* slave pulls low to pause */ 847 848/* Should match up with flags in linux/spi/spi.h */ 849#define GB_SPI_FLAG_HALF_DUPLEX BIT(0) /* can't do full duplex */ 850#define GB_SPI_FLAG_NO_RX BIT(1) /* can't do buffer read */ 851#define GB_SPI_FLAG_NO_TX BIT(2) /* can't do buffer write */ 852 853/* Greybus spi operation types */ 854#define GB_SPI_TYPE_MASTER_CONFIG 0x02 855#define GB_SPI_TYPE_DEVICE_CONFIG 0x03 856#define GB_SPI_TYPE_TRANSFER 0x04 857 858/* mode request has no payload */ 859struct gb_spi_master_config_response { 860 __le32 bits_per_word_mask; 861 __le32 min_speed_hz; 862 __le32 max_speed_hz; 863 __le16 mode; 864 __le16 flags; 865 __u8 num_chipselect; 866} __packed; 867 868struct gb_spi_device_config_request { 869 __u8 chip_select; 870} __packed; 871 872struct gb_spi_device_config_response { 873 __le16 mode; 874 __u8 bits_per_word; 875 __le32 max_speed_hz; 876 __u8 device_type; 877#define GB_SPI_SPI_DEV 0x00 878#define GB_SPI_SPI_NOR 0x01 879#define GB_SPI_SPI_MODALIAS 0x02 880 __u8 name[32]; 881} __packed; 882 883/** 884 * struct gb_spi_transfer - a read/write buffer pair 885 * @speed_hz: Select a speed other than the device default for this transfer. If 886 * 0 the default (from @spi_device) is used. 887 * @len: size of rx and tx buffers (in bytes) 888 * @delay_usecs: microseconds to delay after this transfer before (optionally) 889 * changing the chipselect status, then starting the next transfer or 890 * completing this spi_message. 891 * @cs_change: affects chipselect after this transfer completes 892 * @bits_per_word: select a bits_per_word other than the device default for this 893 * transfer. If 0 the default (from @spi_device) is used. 894 */ 895struct gb_spi_transfer { 896 __le32 speed_hz; 897 __le32 len; 898 __le16 delay_usecs; 899 __u8 cs_change; 900 __u8 bits_per_word; 901 __u8 xfer_flags; 902#define GB_SPI_XFER_READ 0x01 903#define GB_SPI_XFER_WRITE 0x02 904#define GB_SPI_XFER_INPROGRESS 0x04 905} __packed; 906 907struct gb_spi_transfer_request { 908 __u8 chip_select; /* of the spi device */ 909 __u8 mode; /* of the spi device */ 910 __le16 count; 911 struct gb_spi_transfer transfers[]; /* count of these */ 912} __packed; 913 914struct gb_spi_transfer_response { 915 __u8 data[0]; /* inbound data */ 916} __packed; 917 918/* Version of the Greybus SVC protocol we support */ 919#define GB_SVC_VERSION_MAJOR 0x00 920#define GB_SVC_VERSION_MINOR 0x01 921 922/* Greybus SVC request types */ 923#define GB_SVC_TYPE_PROTOCOL_VERSION 0x01 924#define GB_SVC_TYPE_SVC_HELLO 0x02 925#define GB_SVC_TYPE_INTF_DEVICE_ID 0x03 926#define GB_SVC_TYPE_INTF_RESET 0x06 927#define GB_SVC_TYPE_CONN_CREATE 0x07 928#define GB_SVC_TYPE_CONN_DESTROY 0x08 929#define GB_SVC_TYPE_DME_PEER_GET 0x09 930#define GB_SVC_TYPE_DME_PEER_SET 0x0a 931#define GB_SVC_TYPE_ROUTE_CREATE 0x0b 932#define GB_SVC_TYPE_ROUTE_DESTROY 0x0c 933#define GB_SVC_TYPE_TIMESYNC_ENABLE 0x0d 934#define GB_SVC_TYPE_TIMESYNC_DISABLE 0x0e 935#define GB_SVC_TYPE_TIMESYNC_AUTHORITATIVE 0x0f 936#define GB_SVC_TYPE_INTF_SET_PWRM 0x10 937#define GB_SVC_TYPE_INTF_EJECT 0x11 938#define GB_SVC_TYPE_PING 0x13 939#define GB_SVC_TYPE_PWRMON_RAIL_COUNT_GET 0x14 940#define GB_SVC_TYPE_PWRMON_RAIL_NAMES_GET 0x15 941#define GB_SVC_TYPE_PWRMON_SAMPLE_GET 0x16 942#define GB_SVC_TYPE_PWRMON_INTF_SAMPLE_GET 0x17 943#define GB_SVC_TYPE_TIMESYNC_WAKE_PINS_ACQUIRE 0x18 944#define GB_SVC_TYPE_TIMESYNC_WAKE_PINS_RELEASE 0x19 945#define GB_SVC_TYPE_TIMESYNC_PING 0x1a 946#define GB_SVC_TYPE_MODULE_INSERTED 0x1f 947#define GB_SVC_TYPE_MODULE_REMOVED 0x20 948#define GB_SVC_TYPE_INTF_VSYS_ENABLE 0x21 949#define GB_SVC_TYPE_INTF_VSYS_DISABLE 0x22 950#define GB_SVC_TYPE_INTF_REFCLK_ENABLE 0x23 951#define GB_SVC_TYPE_INTF_REFCLK_DISABLE 0x24 952#define GB_SVC_TYPE_INTF_UNIPRO_ENABLE 0x25 953#define GB_SVC_TYPE_INTF_UNIPRO_DISABLE 0x26 954#define GB_SVC_TYPE_INTF_ACTIVATE 0x27 955#define GB_SVC_TYPE_INTF_RESUME 0x28 956#define GB_SVC_TYPE_INTF_MAILBOX_EVENT 0x29 957#define GB_SVC_TYPE_INTF_OOPS 0x2a 958 959/* Greybus SVC protocol status values */ 960#define GB_SVC_OP_SUCCESS 0x00 961#define GB_SVC_OP_UNKNOWN_ERROR 0x01 962#define GB_SVC_INTF_NOT_DETECTED 0x02 963#define GB_SVC_INTF_NO_UPRO_LINK 0x03 964#define GB_SVC_INTF_UPRO_NOT_DOWN 0x04 965#define GB_SVC_INTF_UPRO_NOT_HIBERNATED 0x05 966#define GB_SVC_INTF_NO_V_SYS 0x06 967#define GB_SVC_INTF_V_CHG 0x07 968#define GB_SVC_INTF_WAKE_BUSY 0x08 969#define GB_SVC_INTF_NO_REFCLK 0x09 970#define GB_SVC_INTF_RELEASING 0x0a 971#define GB_SVC_INTF_NO_ORDER 0x0b 972#define GB_SVC_INTF_MBOX_SET 0x0c 973#define GB_SVC_INTF_BAD_MBOX 0x0d 974#define GB_SVC_INTF_OP_TIMEOUT 0x0e 975#define GB_SVC_PWRMON_OP_NOT_PRESENT 0x0f 976 977struct gb_svc_version_request { 978 __u8 major; 979 __u8 minor; 980} __packed; 981 982struct gb_svc_version_response { 983 __u8 major; 984 __u8 minor; 985} __packed; 986 987/* SVC protocol hello request */ 988struct gb_svc_hello_request { 989 __le16 endo_id; 990 __u8 interface_id; 991} __packed; 992/* hello response has no payload */ 993 994struct gb_svc_intf_device_id_request { 995 __u8 intf_id; 996 __u8 device_id; 997} __packed; 998/* device id response has no payload */ 999 1000struct gb_svc_intf_reset_request {
1001 __u8 intf_id; 1002} __packed; 1003/* interface reset response has no payload */ 1004 1005struct gb_svc_intf_eject_request { 1006 __u8 intf_id; 1007} __packed; 1008/* interface eject response has no payload */ 1009 1010struct gb_svc_conn_create_request { 1011 __u8 intf1_id; 1012 __le16 cport1_id; 1013 __u8 intf2_id; 1014 __le16 cport2_id; 1015 __u8 tc; 1016 __u8 flags; 1017} __packed; 1018/* connection create response has no payload */ 1019 1020struct gb_svc_conn_destroy_request { 1021 __u8 intf1_id; 1022 __le16 cport1_id; 1023 __u8 intf2_id; 1024 __le16 cport2_id; 1025} __packed; 1026/* connection destroy response has no payload */ 1027 1028struct gb_svc_dme_peer_get_request { 1029 __u8 intf_id; 1030 __le16 attr; 1031 __le16 selector; 1032} __packed; 1033 1034struct gb_svc_dme_peer_get_response { 1035 __le16 result_code; 1036 __le32 attr_value; 1037} __packed; 1038 1039struct gb_svc_dme_peer_set_request { 1040 __u8 intf_id; 1041 __le16 attr; 1042 __le16 selector; 1043 __le32 value; 1044} __packed; 1045 1046struct gb_svc_dme_peer_set_response { 1047 __le16 result_code; 1048} __packed; 1049 1050/* Greybus init-status values, currently retrieved using DME peer gets. */ 1051#define GB_INIT_SPI_BOOT_STARTED 0x02 1052#define GB_INIT_TRUSTED_SPI_BOOT_FINISHED 0x03 1053#define GB_INIT_UNTRUSTED_SPI_BOOT_FINISHED 0x04 1054#define GB_INIT_BOOTROM_UNIPRO_BOOT_STARTED 0x06 1055#define GB_INIT_BOOTROM_FALLBACK_UNIPRO_BOOT_STARTED 0x09 1056#define GB_INIT_S2_LOADER_BOOT_STARTED 0x0D 1057 1058struct gb_svc_route_create_request { 1059 __u8 intf1_id; 1060 __u8 dev1_id; 1061 __u8 intf2_id; 1062 __u8 dev2_id; 1063} __packed; 1064/* route create response has no payload */ 1065 1066struct gb_svc_route_destroy_request { 1067 __u8 intf1_id; 1068 __u8 intf2_id; 1069} __packed; 1070/* route destroy response has no payload */ 1071 1072/* used for svc_intf_vsys_{enable,disable} */ 1073struct gb_svc_intf_vsys_request { 1074 __u8 intf_id; 1075} __packed; 1076 1077struct gb_svc_intf_vsys_response { 1078 __u8 result_code; 1079#define GB_SVC_INTF_VSYS_OK 0x00 1080 /* 0x01 is reserved */ 1081#define GB_SVC_INTF_VSYS_FAIL 0x02 1082} __packed; 1083 1084/* used for svc_intf_refclk_{enable,disable} */ 1085struct gb_svc_intf_refclk_request { 1086 __u8 intf_id; 1087} __packed; 1088 1089struct gb_svc_intf_refclk_response { 1090 __u8 result_code; 1091#define GB_SVC_INTF_REFCLK_OK 0x00 1092 /* 0x01 is reserved */ 1093#define GB_SVC_INTF_REFCLK_FAIL 0x02 1094} __packed; 1095 1096/* used for svc_intf_unipro_{enable,disable} */ 1097struct gb_svc_intf_unipro_request { 1098 __u8 intf_id; 1099} __packed; 1100 1101struct gb_svc_intf_unipro_response { 1102 __u8 result_code; 1103#define GB_SVC_INTF_UNIPRO_OK 0x00 1104 /* 0x01 is reserved */ 1105#define GB_SVC_INTF_UNIPRO_FAIL 0x02 1106#define GB_SVC_INTF_UNIPRO_NOT_OFF 0x03 1107} __packed; 1108 1109#define GB_SVC_UNIPRO_FAST_MODE 0x01 1110#define GB_SVC_UNIPRO_SLOW_MODE 0x02 1111#define GB_SVC_UNIPRO_FAST_AUTO_MODE 0x04 1112#define GB_SVC_UNIPRO_SLOW_AUTO_MODE 0x05 1113#define GB_SVC_UNIPRO_MODE_UNCHANGED 0x07 1114#define GB_SVC_UNIPRO_HIBERNATE_MODE 0x11 1115#define GB_SVC_UNIPRO_OFF_MODE 0x12 1116 1117#define GB_SVC_SMALL_AMPLITUDE 0x01 1118#define GB_SVC_LARGE_AMPLITUDE 0x02 1119 1120#define GB_SVC_NO_DE_EMPHASIS 0x00 1121#define GB_SVC_SMALL_DE_EMPHASIS 0x01 1122#define GB_SVC_LARGE_DE_EMPHASIS 0x02 1123 1124#define GB_SVC_PWRM_RXTERMINATION 0x01 1125#define GB_SVC_PWRM_TXTERMINATION 0x02 1126#define GB_SVC_PWRM_LINE_RESET 0x04 1127#define GB_SVC_PWRM_SCRAMBLING 0x20 1128 1129#define GB_SVC_PWRM_QUIRK_HSSER 0x00000001 1130 1131#define GB_SVC_UNIPRO_HS_SERIES_A 0x01 1132#define GB_SVC_UNIPRO_HS_SERIES_B 0x02 1133 1134#define GB_SVC_SETPWRM_PWR_OK 0x00 1135#define GB_SVC_SETPWRM_PWR_LOCAL 0x01 1136#define GB_SVC_SETPWRM_PWR_REMOTE 0x02 1137#define GB_SVC_SETPWRM_PWR_BUSY 0x03 1138#define GB_SVC_SETPWRM_PWR_ERROR_CAP 0x04 1139#define GB_SVC_SETPWRM_PWR_FATAL_ERROR 0x05 1140 1141struct gb_svc_l2_timer_cfg { 1142 __le16 tsb_fc0_protection_timeout; 1143 __le16 tsb_tc0_replay_timeout; 1144 __le16 tsb_afc0_req_timeout; 1145 __le16 tsb_fc1_protection_timeout; 1146 __le16 tsb_tc1_replay_timeout; 1147 __le16 tsb_afc1_req_timeout; 1148 __le16 reserved_for_tc2[3]; 1149 __le16 reserved_for_tc3[3]; 1150} __packed; 1151 1152struct gb_svc_intf_set_pwrm_request { 1153 __u8 intf_id; 1154 __u8 hs_series; 1155 __u8 tx_mode; 1156 __u8 tx_gear; 1157 __u8 tx_nlanes; 1158 __u8 tx_amplitude; 1159 __u8 tx_hs_equalizer; 1160 __u8 rx_mode; 1161 __u8 rx_gear; 1162 __u8 rx_nlanes; 1163 __u8 flags; 1164 __le32 quirks; 1165 struct gb_svc_l2_timer_cfg local_l2timerdata, remote_l2timerdata; 1166} __packed; 1167 1168struct gb_svc_intf_set_pwrm_response { 1169 __u8 result_code; 1170} __packed; 1171 1172struct gb_svc_key_event_request { 1173 __le16 key_code; 1174#define GB_KEYCODE_ARA 0x00 1175 1176 __u8 key_event; 1177#define GB_SVC_KEY_RELEASED 0x00 1178#define GB_SVC_KEY_PRESSED 0x01 1179} __packed; 1180 1181#define GB_SVC_PWRMON_MAX_RAIL_COUNT 254 1182 1183struct gb_svc_pwrmon_rail_count_get_response { 1184 __u8 rail_count; 1185} __packed; 1186 1187#define GB_SVC_PWRMON_RAIL_NAME_BUFSIZE 32 1188 1189struct gb_svc_pwrmon_rail_names_get_response { 1190 __u8 status; 1191 __u8 name[][GB_SVC_PWRMON_RAIL_NAME_BUFSIZE]; 1192} __packed; 1193 1194#define GB_SVC_PWRMON_TYPE_CURR 0x01 1195#define GB_SVC_PWRMON_TYPE_VOL 0x02 1196#define GB_SVC_PWRMON_TYPE_PWR 0x03 1197 1198#define GB_SVC_PWRMON_GET_SAMPLE_OK 0x00 1199#define GB_SVC_PWRMON_GET_SAMPLE_INVAL 0x01 1200#define GB_SVC_PWRMON_GET_SAMPLE_NOSUPP 0x02 1201#define GB_SVC_PWRMON_GET_SAMPLE_HWERR 0x03 1202 1203struct gb_svc_pwrmon_sample_get_request { 1204 __u8 rail_id; 1205 __u8 measurement_type; 1206} __packed; 1207 1208struct gb_svc_pwrmon_sample_get_response { 1209 __u8 result; 1210 __le32 measurement; 1211} __packed; 1212 1213struct gb_svc_pwrmon_intf_sample_get_request { 1214 __u8 intf_id; 1215 __u8 measurement_type; 1216} __packed; 1217 1218struct gb_svc_pwrmon_intf_sample_get_response { 1219 __u8 result; 1220 __le32 measurement; 1221} __packed; 1222 1223#define GB_SVC_MODULE_INSERTED_FLAG_NO_PRIMARY 0x0001 1224 1225struct gb_svc_module_inserted_request { 1226 __u8 primary_intf_id; 1227 __u8 intf_count; 1228 __le16 flags; 1229} __packed; 1230/* module_inserted response has no payload */ 1231 1232struct gb_svc_module_removed_request { 1233 __u8 primary_intf_id; 1234} __packed; 1235/* module_removed response has no payload */ 1236 1237struct gb_svc_intf_activate_request { 1238 __u8 intf_id; 1239} __packed; 1240 1241#define GB_SVC_INTF_TYPE_UNKNOWN 0x00 1242#define GB_SVC_INTF_TYPE_DUMMY 0x01 1243#define GB_SVC_INTF_TYPE_UNIPRO 0x02 1244#define GB_SVC_INTF_TYPE_GREYBUS 0x03 1245 1246struct gb_svc_intf_activate_response { 1247 __u8 status; 1248 __u8 intf_type; 1249} __packed; 1250 1251struct gb_svc_intf_resume_request { 1252 __u8 intf_id; 1253} __packed; 1254 1255struct gb_svc_intf_resume_response { 1256 __u8 status; 1257} __packed; 1258 1259#define GB_SVC_INTF_MAILBOX_NONE 0x00 1260#define GB_SVC_INTF_MAILBOX_AP 0x01 1261#define GB_SVC_INTF_MAILBOX_GREYBUS 0x02 1262 1263struct gb_svc_intf_mailbox_event_request { 1264 __u8 intf_id; 1265 __le16 result_code; 1266 __le32 mailbox; 1267} __packed; 1268/* intf_mailbox_event response has no payload */ 1269 1270struct gb_svc_intf_oops_request { 1271 __u8 intf_id; 1272 __u8 reason; 1273} __packed; 1274/* intf_oops response has no payload */ 1275 1276 1277/* RAW */ 1278 1279/* Greybus raw request types */ 1280#define GB_RAW_TYPE_SEND 0x02 1281 1282struct gb_raw_send_request { 1283 __le32 len; 1284 __u8 data[]; 1285} __packed; 1286 1287 1288/* UART */ 1289 1290/* Greybus UART operation types */ 1291#define GB_UART_TYPE_SEND_DATA 0x02 1292#define GB_UART_TYPE_RECEIVE_DATA 0x03 /* Unsolicited data */ 1293#define GB_UART_TYPE_SET_LINE_CODING 0x04 1294#define GB_UART_TYPE_SET_CONTROL_LINE_STATE 0x05 1295#define GB_UART_TYPE_SEND_BREAK 0x06 1296#define GB_UART_TYPE_SERIAL_STATE 0x07 /* Unsolicited data */ 1297#define GB_UART_TYPE_RECEIVE_CREDITS 0x08 1298#define GB_UART_TYPE_FLUSH_FIFOS 0x09 1299 1300/* Represents data from AP -> Module */ 1301struct gb_uart_send_data_request { 1302 __le16 size; 1303 __u8 data[]; 1304} __packed; 1305 1306/* recv-data-request flags */ 1307#define GB_UART_RECV_FLAG_FRAMING 0x01 /* Framing error */ 1308#define GB_UART_RECV_FLAG_PARITY 0x02 /* Parity error */ 1309#define GB_UART_RECV_FLAG_OVERRUN 0x04 /* Overrun error */ 1310#define GB_UART_RECV_FLAG_BREAK 0x08 /* Break */ 1311 1312/* Represents data from Module -> AP */ 1313struct gb_uart_recv_data_request { 1314 __le16 size; 1315 __u8 flags; 1316 __u8 data[]; 1317} __packed; 1318 1319struct gb_uart_receive_credits_request { 1320 __le16 count; 1321} __packed; 1322 1323struct gb_uart_set_line_coding_request { 1324 __le32 rate; 1325 __u8 format; 1326#define GB_SERIAL_1_STOP_BITS 0 1327#define GB_SERIAL_1_5_STOP_BITS 1 1328#define GB_SERIAL_2_STOP_BITS 2 1329 1330 __u8 parity; 1331#define GB_SERIAL_NO_PARITY 0 1332#define GB_SERIAL_ODD_PARITY 1 1333#define GB_SERIAL_EVEN_PARITY 2 1334#define GB_SERIAL_MARK_PARITY 3 1335#define GB_SERIAL_SPACE_PARITY 4 1336 1337 __u8 data_bits; 1338 1339 __u8 flow_control; 1340#define GB_SERIAL_AUTO_RTSCTS_EN 0x1 1341} __packed; 1342 1343/* output control lines */ 1344#define GB_UART_CTRL_DTR 0x01 1345#define GB_UART_CTRL_RTS 0x02 1346 1347struct gb_uart_set_control_line_state_request { 1348 __u8 control; 1349} __packed; 1350 1351struct gb_uart_set_break_request { 1352 __u8 state; 1353} __packed; 1354 1355/* input control lines and line errors */ 1356#define GB_UART_CTRL_DCD 0x01 1357#define GB_UART_CTRL_DSR 0x02 1358#define GB_UART_CTRL_RI 0x04 1359 1360struct gb_uart_serial_state_request { 1361 __u8 control; 1362} __packed; 1363 1364struct gb_uart_serial_flush_request { 1365 __u8 flags; 1366#define GB_SERIAL_FLAG_FLUSH_TRANSMITTER 0x01 1367#define GB_SERIAL_FLAG_FLUSH_RECEIVER 0x02 1368} __packed; 1369 1370/* Loopback */ 1371 1372/* Greybus loopback request types */ 1373#define GB_LOOPBACK_TYPE_PING 0x02 1374#define GB_LOOPBACK_TYPE_TRANSFER 0x03 1375#define GB_LOOPBACK_TYPE_SINK 0x04 1376 1377/* 1378 * Loopback request/response header format should be identical 1379 * to simplify bandwidth and data movement analysis. 1380 */ 1381struct gb_loopback_transfer_request { 1382 __le32 len; 1383 __le32 reserved0; 1384 __le32 reserved1; 1385 __u8 data[]; 1386} __packed; 1387 1388struct gb_loopback_transfer_response { 1389 __le32 len; 1390 __le32 reserved0; 1391 __le32 reserved1; 1392 __u8 data[]; 1393} __packed; 1394 1395/* SDIO */ 1396/* Greybus SDIO operation types */ 1397#define GB_SDIO_TYPE_GET_CAPABILITIES 0x02 1398#define GB_SDIO_TYPE_SET_IOS 0x03 1399#define GB_SDIO_TYPE_COMMAND 0x04 1400#define GB_SDIO_TYPE_TRANSFER 0x05 1401#define GB_SDIO_TYPE_EVENT 0x06 1402 1403/* get caps response: request has no payload */ 1404struct gb_sdio_get_caps_response { 1405 __le32 caps; 1406#define GB_SDIO_CAP_NONREMOVABLE 0x00000001 1407#define GB_SDIO_CAP_4_BIT_DATA 0x00000002 1408#define GB_SDIO_CAP_8_BIT_DATA 0x00000004 1409#define GB_SDIO_CAP_MMC_HS 0x00000008 1410#define GB_SDIO_CAP_SD_HS 0x00000010 1411#define GB_SDIO_CAP_ERASE 0x00000020 1412#define GB_SDIO_CAP_1_2V_DDR 0x00000040 1413#define GB_SDIO_CAP_1_8V_DDR 0x00000080 1414#define GB_SDIO_CAP_POWER_OFF_CARD 0x00000100 1415#define GB_SDIO_CAP_UHS_SDR12 0x00000200 1416#define GB_SDIO_CAP_UHS_SDR25 0x00000400 1417#define GB_SDIO_CAP_UHS_SDR50 0x00000800 1418#define GB_SDIO_CAP_UHS_SDR104 0x00001000 1419#define GB_SDIO_CAP_UHS_DDR50 0x00002000 1420#define GB_SDIO_CAP_DRIVER_TYPE_A 0x00004000 1421#define GB_SDIO_CAP_DRIVER_TYPE_C 0x00008000 1422#define GB_SDIO_CAP_DRIVER_TYPE_D 0x00010000 1423#define GB_SDIO_CAP_HS200_1_2V 0x00020000 1424#define GB_SDIO_CAP_HS200_1_8V 0x00040000 1425#define GB_SDIO_CAP_HS400_1_2V 0x00080000 1426#define GB_SDIO_CAP_HS400_1_8V 0x00100000 1427 1428 /* see possible values below at vdd */ 1429 __le32 ocr; 1430 __le32 f_min; 1431 __le32 f_max; 1432 __le16 max_blk_count; 1433 __le16 max_blk_size; 1434} __packed; 1435 1436/* set ios request: response has no payload */ 1437struct gb_sdio_set_ios_request { 1438 __le32 clock; 1439 __le32 vdd; 1440#define GB_SDIO_VDD_165_195 0x00000001 1441#define GB_SDIO_VDD_20_21 0x00000002 1442#define GB_SDIO_VDD_21_22 0x00000004 1443#define GB_SDIO_VDD_22_23 0x00000008 1444#define GB_SDIO_VDD_23_24 0x00000010 1445#define GB_SDIO_VDD_24_25 0x00000020 1446#define GB_SDIO_VDD_25_26 0x00000040 1447#define GB_SDIO_VDD_26_27 0x00000080 1448#define GB_SDIO_VDD_27_28 0x00000100 1449#define GB_SDIO_VDD_28_29 0x00000200 1450#define GB_SDIO_VDD_29_30 0x00000400 1451#define GB_SDIO_VDD_30_31 0x00000800 1452#define GB_SDIO_VDD_31_32 0x00001000 1453#define GB_SDIO_VDD_32_33 0x00002000 1454#define GB_SDIO_VDD_33_34 0x00004000 1455#define GB_SDIO_VDD_34_35 0x00008000 1456#define GB_SDIO_VDD_35_36 0x00010000 1457 1458 __u8 bus_mode; 1459#define GB_SDIO_BUSMODE_OPENDRAIN 0x00 1460#define GB_SDIO_BUSMODE_PUSHPULL 0x01 1461 1462 __u8 power_mode; 1463#define GB_SDIO_POWER_OFF 0x00 1464#define GB_SDIO_POWER_UP 0x01 1465#define GB_SDIO_POWER_ON 0x02 1466#define GB_SDIO_POWER_UNDEFINED 0x03 1467 1468 __u8 bus_width; 1469#define GB_SDIO_BUS_WIDTH_1 0x00 1470#define GB_SDIO_BUS_WIDTH_4 0x02 1471#define GB_SDIO_BUS_WIDTH_8 0x03 1472 1473 __u8 timing; 1474#define GB_SDIO_TIMING_LEGACY 0x00 1475#define GB_SDIO_TIMING_MMC_HS 0x01 1476#define GB_SDIO_TIMING_SD_HS 0x02 1477#define GB_SDIO_TIMING_UHS_SDR12 0x03 1478#define GB_SDIO_TIMING_UHS_SDR25 0x04 1479#define GB_SDIO_TIMING_UHS_SDR50 0x05 1480#define GB_SDIO_TIMING_UHS_SDR104 0x06 1481#define GB_SDIO_TIMING_UHS_DDR50 0x07 1482#define GB_SDIO_TIMING_MMC_DDR52 0x08 1483#define GB_SDIO_TIMING_MMC_HS200 0x09 1484#define GB_SDIO_TIMING_MMC_HS400 0x0A 1485 1486 __u8 signal_voltage; 1487#define GB_SDIO_SIGNAL_VOLTAGE_330 0x00 1488#define GB_SDIO_SIGNAL_VOLTAGE_180 0x01 1489#define GB_SDIO_SIGNAL_VOLTAGE_120 0x02 1490 1491 __u8 drv_type; 1492#define GB_SDIO_SET_DRIVER_TYPE_B 0x00 1493#define GB_SDIO_SET_DRIVER_TYPE_A 0x01 1494#define GB_SDIO_SET_DRIVER_TYPE_C 0x02 1495#define GB_SDIO_SET_DRIVER_TYPE_D 0x03 1496} __packed; 1497 1498/* command request */ 1499struct gb_sdio_command_request { 1500 __u8 cmd; 1501 __u8 cmd_flags; 1502#define GB_SDIO_RSP_NONE 0x00 1503#define GB_SDIO_RSP_PRESENT 0x01 1504#define GB_SDIO_RSP_136 0x02 1505#define GB_SDIO_RSP_CRC 0x04 1506#define GB_SDIO_RSP_BUSY 0x08 1507#define GB_SDIO_RSP_OPCODE 0x10 1508 1509 __u8 cmd_type; 1510#define GB_SDIO_CMD_AC 0x00 1511#define GB_SDIO_CMD_ADTC 0x01 1512#define GB_SDIO_CMD_BC 0x02 1513#define GB_SDIO_CMD_BCR 0x03 1514 1515 __le32 cmd_arg; 1516 __le16 data_blocks; 1517 __le16 data_blksz; 1518} __packed; 1519 1520struct gb_sdio_command_response { 1521 __le32 resp[4]; 1522} __packed; 1523 1524/* transfer request */ 1525struct gb_sdio_transfer_request { 1526 __u8 data_flags; 1527#define GB_SDIO_DATA_WRITE 0x01 1528#define GB_SDIO_DATA_READ 0x02 1529#define GB_SDIO_DATA_STREAM 0x04 1530 1531 __le16 data_blocks; 1532 __le16 data_blksz; 1533 __u8 data[]; 1534} __packed; 1535 1536struct gb_sdio_transfer_response { 1537 __le16 data_blocks; 1538 __le16 data_blksz; 1539 __u8 data[]; 1540} __packed; 1541 1542/* event request: generated by module and is defined as unidirectional */ 1543struct gb_sdio_event_request { 1544 __u8 event; 1545#define GB_SDIO_CARD_INSERTED 0x01 1546#define GB_SDIO_CARD_REMOVED 0x02 1547#define GB_SDIO_WP 0x04 1548} __packed; 1549 1550/* Camera */ 1551 1552/* Greybus Camera request types */ 1553#define GB_CAMERA_TYPE_CAPABILITIES 0x02 1554#define GB_CAMERA_TYPE_CONFIGURE_STREAMS 0x03 1555#define GB_CAMERA_TYPE_CAPTURE 0x04 1556#define GB_CAMERA_TYPE_FLUSH 0x05 1557#define GB_CAMERA_TYPE_METADATA 0x06 1558 1559#define GB_CAMERA_MAX_STREAMS 4 1560#define GB_CAMERA_MAX_SETTINGS_SIZE 8192 1561 1562/* Greybus Camera Configure Streams request payload */ 1563struct gb_camera_stream_config_request { 1564 __le16 width; 1565 __le16 height; 1566 __le16 format; 1567 __le16 padding; 1568} __packed; 1569 1570struct gb_camera_configure_streams_request { 1571 __u8 num_streams; 1572 __u8 flags; 1573#define GB_CAMERA_CONFIGURE_STREAMS_TEST_ONLY 0x01 1574 __le16 padding; 1575 struct gb_camera_stream_config_request config[]; 1576} __packed; 1577 1578/* Greybus Camera Configure Streams response payload */ 1579struct gb_camera_stream_config_response { 1580 __le16 width; 1581 __le16 height; 1582 __le16 format; 1583 __u8 virtual_channel; 1584 __u8 data_type[2]; 1585 __le16 max_pkt_size; 1586 __u8 padding; 1587 __le32 max_size; 1588} __packed; 1589 1590struct gb_camera_configure_streams_response { 1591 __u8 num_streams; 1592#define GB_CAMERA_CONFIGURE_STREAMS_ADJUSTED 0x01 1593 __u8 flags; 1594 __u8 padding[2]; 1595 __le32 data_rate; 1596 struct gb_camera_stream_config_response config[]; 1597}; 1598 1599/* Greybus Camera Capture request payload - response has no payload */ 1600struct gb_camera_capture_request { 1601 __le32 request_id; 1602 __u8 streams; 1603 __u8 padding; 1604 __le16 num_frames; 1605 __u8 settings[]; 1606} __packed; 1607 1608/* Greybus Camera Flush response payload - request has no payload */ 1609struct gb_camera_flush_response { 1610 __le32 request_id; 1611} __packed; 1612 1613/* Greybus Camera Metadata request payload - operation has no response */ 1614struct gb_camera_metadata_request { 1615 __le32 request_id; 1616 __le16 frame_number; 1617 __u8 stream; 1618 __u8 padding; 1619 __u8 metadata[]; 1620} __packed; 1621 1622/* Lights */ 1623 1624/* Greybus Lights request types */ 1625#define GB_LIGHTS_TYPE_GET_LIGHTS 0x02 1626#define GB_LIGHTS_TYPE_GET_LIGHT_CONFIG 0x03 1627#define GB_LIGHTS_TYPE_GET_CHANNEL_CONFIG 0x04 1628#define GB_LIGHTS_TYPE_GET_CHANNEL_FLASH_CONFIG 0x05 1629#define GB_LIGHTS_TYPE_SET_BRIGHTNESS 0x06 1630#define GB_LIGHTS_TYPE_SET_BLINK 0x07 1631#define GB_LIGHTS_TYPE_SET_COLOR 0x08 1632#define GB_LIGHTS_TYPE_SET_FADE 0x09 1633#define GB_LIGHTS_TYPE_EVENT 0x0A 1634#define GB_LIGHTS_TYPE_SET_FLASH_INTENSITY 0x0B 1635#define GB_LIGHTS_TYPE_SET_FLASH_STROBE 0x0C 1636#define GB_LIGHTS_TYPE_SET_FLASH_TIMEOUT 0x0D 1637#define GB_LIGHTS_TYPE_GET_FLASH_FAULT 0x0E 1638 1639/* Greybus Light modes */ 1640 1641/* 1642 * if you add any specific mode below, update also the 1643 * GB_CHANNEL_MODE_DEFINED_RANGE value accordingly 1644 */ 1645#define GB_CHANNEL_MODE_NONE 0x00000000 1646#define GB_CHANNEL_MODE_BATTERY 0x00000001 1647#define GB_CHANNEL_MODE_POWER 0x00000002 1648#define GB_CHANNEL_MODE_WIRELESS 0x00000004 1649#define GB_CHANNEL_MODE_BLUETOOTH 0x00000008 1650#define GB_CHANNEL_MODE_KEYBOARD 0x00000010 1651#define GB_CHANNEL_MODE_BUTTONS 0x00000020 1652#define GB_CHANNEL_MODE_NOTIFICATION 0x00000040 1653#define GB_CHANNEL_MODE_ATTENTION 0x00000080 1654#define GB_CHANNEL_MODE_FLASH 0x00000100 1655#define GB_CHANNEL_MODE_TORCH 0x00000200 1656#define GB_CHANNEL_MODE_INDICATOR 0x00000400 1657 1658/* Lights Mode valid bit values */ 1659#define GB_CHANNEL_MODE_DEFINED_RANGE 0x000004FF 1660#define GB_CHANNEL_MODE_VENDOR_RANGE 0x00F00000 1661 1662/* Greybus Light Channels Flags */ 1663#define GB_LIGHT_CHANNEL_MULTICOLOR 0x00000001 1664#define GB_LIGHT_CHANNEL_FADER 0x00000002 1665#define GB_LIGHT_CHANNEL_BLINK 0x00000004 1666 1667/* get count of lights in module */ 1668struct gb_lights_get_lights_response { 1669 __u8 lights_count; 1670} __packed; 1671 1672/* light config request payload */ 1673struct gb_lights_get_light_config_request { 1674 __u8 id; 1675} __packed; 1676 1677/* light config response payload */ 1678struct gb_lights_get_light_config_response { 1679 __u8 channel_count; 1680 __u8 name[32]; 1681} __packed; 1682 1683/* channel config request payload */ 1684struct gb_lights_get_channel_config_request { 1685 __u8 light_id; 1686 __u8 channel_id; 1687} __packed; 1688 1689/* channel flash config request payload */ 1690struct gb_lights_get_channel_flash_config_request { 1691 __u8 light_id; 1692 __u8 channel_id; 1693} __packed; 1694 1695/* channel config response payload */ 1696struct gb_lights_get_channel_config_response { 1697 __u8 max_brightness; 1698 __le32 flags; 1699 __le32 color; 1700 __u8 color_name[32]; 1701 __le32 mode; 1702 __u8 mode_name[32]; 1703} __packed; 1704 1705/* channel flash config response payload */ 1706struct gb_lights_get_channel_flash_config_response { 1707 __le32 intensity_min_uA; 1708 __le32 intensity_max_uA; 1709 __le32 intensity_step_uA; 1710 __le32 timeout_min_us; 1711 __le32 timeout_max_us; 1712 __le32 timeout_step_us; 1713} __packed; 1714 1715/* blink request payload: response have no payload */ 1716struct gb_lights_blink_request { 1717 __u8 light_id; 1718 __u8 channel_id; 1719 __le16 time_on_ms; 1720 __le16 time_off_ms; 1721} __packed; 1722 1723/* set brightness request payload: response have no payload */ 1724struct gb_lights_set_brightness_request { 1725 __u8 light_id; 1726 __u8 channel_id; 1727 __u8 brightness; 1728} __packed; 1729 1730/* set color request payload: response have no payload */ 1731struct gb_lights_set_color_request { 1732 __u8 light_id; 1733 __u8 channel_id; 1734 __le32 color; 1735} __packed; 1736 1737/* set fade request payload: response have no payload */ 1738struct gb_lights_set_fade_request { 1739 __u8 light_id; 1740 __u8 channel_id; 1741 __u8 fade_in; 1742 __u8 fade_out; 1743} __packed; 1744 1745/* event request: generated by module */ 1746struct gb_lights_event_request { 1747 __u8 light_id; 1748 __u8 event; 1749#define GB_LIGHTS_LIGHT_CONFIG 0x01 1750} __packed; 1751 1752/* set flash intensity request payload: response have no payload */ 1753struct gb_lights_set_flash_intensity_request { 1754 __u8 light_id; 1755 __u8 channel_id; 1756 __le32 intensity_uA; 1757} __packed; 1758 1759/* set flash strobe state request payload: response have no payload */ 1760struct gb_lights_set_flash_strobe_request { 1761 __u8 light_id; 1762 __u8 channel_id; 1763 __u8 state; 1764} __packed; 1765 1766/* set flash timeout request payload: response have no payload */ 1767struct gb_lights_set_flash_timeout_request { 1768 __u8 light_id; 1769 __u8 channel_id; 1770 __le32 timeout_us; 1771} __packed; 1772 1773/* get flash fault request payload */ 1774struct gb_lights_get_flash_fault_request { 1775 __u8 light_id; 1776 __u8 channel_id; 1777} __packed; 1778 1779/* get flash fault response payload */ 1780struct gb_lights_get_flash_fault_response { 1781 __le32 fault; 1782#define GB_LIGHTS_FLASH_FAULT_OVER_VOLTAGE 0x00000000 1783#define GB_LIGHTS_FLASH_FAULT_TIMEOUT 0x00000001 1784#define GB_LIGHTS_FLASH_FAULT_OVER_TEMPERATURE 0x00000002 1785#define GB_LIGHTS_FLASH_FAULT_SHORT_CIRCUIT 0x00000004 1786#define GB_LIGHTS_FLASH_FAULT_OVER_CURRENT 0x00000008 1787#define GB_LIGHTS_FLASH_FAULT_INDICATOR 0x00000010 1788#define GB_LIGHTS_FLASH_FAULT_UNDER_VOLTAGE 0x00000020 1789#define GB_LIGHTS_FLASH_FAULT_INPUT_VOLTAGE 0x00000040 1790#define GB_LIGHTS_FLASH_FAULT_LED_OVER_TEMPERATURE 0x00000080 1791} __packed; 1792 1793/* Audio */ 1794 1795#define GB_AUDIO_TYPE_GET_TOPOLOGY_SIZE 0x02 1796#define GB_AUDIO_TYPE_GET_TOPOLOGY 0x03 1797#define GB_AUDIO_TYPE_GET_CONTROL 0x04 1798#define GB_AUDIO_TYPE_SET_CONTROL 0x05 1799#define GB_AUDIO_TYPE_ENABLE_WIDGET 0x06 1800#define GB_AUDIO_TYPE_DISABLE_WIDGET 0x07 1801#define GB_AUDIO_TYPE_GET_PCM 0x08 1802#define GB_AUDIO_TYPE_SET_PCM 0x09 1803#define GB_AUDIO_TYPE_SET_TX_DATA_SIZE 0x0a 1804 /* 0x0b unused */ 1805#define GB_AUDIO_TYPE_ACTIVATE_TX 0x0c 1806#define GB_AUDIO_TYPE_DEACTIVATE_TX 0x0d 1807#define GB_AUDIO_TYPE_SET_RX_DATA_SIZE 0x0e 1808 /* 0x0f unused */ 1809#define GB_AUDIO_TYPE_ACTIVATE_RX 0x10 1810#define GB_AUDIO_TYPE_DEACTIVATE_RX 0x11 1811#define GB_AUDIO_TYPE_JACK_EVENT 0x12 1812#define GB_AUDIO_TYPE_BUTTON_EVENT 0x13 1813#define GB_AUDIO_TYPE_STREAMING_EVENT 0x14 1814#define GB_AUDIO_TYPE_SEND_DATA 0x15 1815 1816/* Module must be able to buffer 10ms of audio data, minimum */ 1817#define GB_AUDIO_SAMPLE_BUFFER_MIN_US 10000 1818 1819#define GB_AUDIO_PCM_NAME_MAX 32 1820#define AUDIO_DAI_NAME_MAX 32 1821#define AUDIO_CONTROL_NAME_MAX 32 1822#define AUDIO_CTL_ELEM_NAME_MAX 44 1823#define AUDIO_ENUM_NAME_MAX 64 1824#define AUDIO_WIDGET_NAME_MAX 32 1825 1826/* See SNDRV_PCM_FMTBIT_* in Linux source */ 1827#define GB_AUDIO_PCM_FMT_S8 BIT(0) 1828#define GB_AUDIO_PCM_FMT_U8 BIT(1) 1829#define GB_AUDIO_PCM_FMT_S16_LE BIT(2) 1830#define GB_AUDIO_PCM_FMT_S16_BE BIT(3) 1831#define GB_AUDIO_PCM_FMT_U16_LE BIT(4) 1832#define GB_AUDIO_PCM_FMT_U16_BE BIT(5) 1833#define GB_AUDIO_PCM_FMT_S24_LE BIT(6) 1834#define GB_AUDIO_PCM_FMT_S24_BE BIT(7) 1835#define GB_AUDIO_PCM_FMT_U24_LE BIT(8) 1836#define GB_AUDIO_PCM_FMT_U24_BE BIT(9) 1837#define GB_AUDIO_PCM_FMT_S32_LE BIT(10) 1838#define GB_AUDIO_PCM_FMT_S32_BE BIT(11) 1839#define GB_AUDIO_PCM_FMT_U32_LE BIT(12) 1840#define GB_AUDIO_PCM_FMT_U32_BE BIT(13) 1841 1842/* See SNDRV_PCM_RATE_* in Linux source */ 1843#define GB_AUDIO_PCM_RATE_5512 BIT(0) 1844#define GB_AUDIO_PCM_RATE_8000 BIT(1) 1845#define GB_AUDIO_PCM_RATE_11025 BIT(2) 1846#define GB_AUDIO_PCM_RATE_16000 BIT(3) 1847#define GB_AUDIO_PCM_RATE_22050 BIT(4) 1848#define GB_AUDIO_PCM_RATE_32000 BIT(5) 1849#define GB_AUDIO_PCM_RATE_44100 BIT(6) 1850#define GB_AUDIO_PCM_RATE_48000 BIT(7) 1851#define GB_AUDIO_PCM_RATE_64000 BIT(8) 1852#define GB_AUDIO_PCM_RATE_88200 BIT(9) 1853#define GB_AUDIO_PCM_RATE_96000 BIT(10) 1854#define GB_AUDIO_PCM_RATE_176400 BIT(11) 1855#define GB_AUDIO_PCM_RATE_192000 BIT(12) 1856 1857#define GB_AUDIO_STREAM_TYPE_CAPTURE 0x1 1858#define GB_AUDIO_STREAM_TYPE_PLAYBACK 0x2 1859 1860#define GB_AUDIO_CTL_ELEM_ACCESS_READ BIT(0) 1861#define GB_AUDIO_CTL_ELEM_ACCESS_WRITE BIT(1) 1862 1863/* See SNDRV_CTL_ELEM_TYPE_* in Linux source */ 1864#define GB_AUDIO_CTL_ELEM_TYPE_BOOLEAN 0x01 1865#define GB_AUDIO_CTL_ELEM_TYPE_INTEGER 0x02 1866#define GB_AUDIO_CTL_ELEM_TYPE_ENUMERATED 0x03 1867#define GB_AUDIO_CTL_ELEM_TYPE_INTEGER64 0x06 1868 1869/* See SNDRV_CTL_ELEM_IFACE_* in Linux source */ 1870#define GB_AUDIO_CTL_ELEM_IFACE_CARD 0x00 1871#define GB_AUDIO_CTL_ELEM_IFACE_HWDEP 0x01 1872#define GB_AUDIO_CTL_ELEM_IFACE_MIXER 0x02 1873#define GB_AUDIO_CTL_ELEM_IFACE_PCM 0x03 1874#define GB_AUDIO_CTL_ELEM_IFACE_RAWMIDI 0x04 1875#define GB_AUDIO_CTL_ELEM_IFACE_TIMER 0x05 1876#define GB_AUDIO_CTL_ELEM_IFACE_SEQUENCER 0x06 1877 1878/* SNDRV_CTL_ELEM_ACCESS_* in Linux source */ 1879#define GB_AUDIO_ACCESS_READ BIT(0) 1880#define GB_AUDIO_ACCESS_WRITE BIT(1) 1881#define GB_AUDIO_ACCESS_VOLATILE BIT(2) 1882#define GB_AUDIO_ACCESS_TIMESTAMP BIT(3) 1883#define GB_AUDIO_ACCESS_TLV_READ BIT(4) 1884#define GB_AUDIO_ACCESS_TLV_WRITE BIT(5) 1885#define GB_AUDIO_ACCESS_TLV_COMMAND BIT(6) 1886#define GB_AUDIO_ACCESS_INACTIVE BIT(7) 1887#define GB_AUDIO_ACCESS_LOCK BIT(8) 1888#define GB_AUDIO_ACCESS_OWNER BIT(9) 1889 1890/* enum snd_soc_dapm_type */ 1891#define GB_AUDIO_WIDGET_TYPE_INPUT 0x0 1892#define GB_AUDIO_WIDGET_TYPE_OUTPUT 0x1 1893#define GB_AUDIO_WIDGET_TYPE_MUX 0x2 1894#define GB_AUDIO_WIDGET_TYPE_VIRT_MUX 0x3 1895#define GB_AUDIO_WIDGET_TYPE_VALUE_MUX 0x4 1896#define GB_AUDIO_WIDGET_TYPE_MIXER 0x5 1897#define GB_AUDIO_WIDGET_TYPE_MIXER_NAMED_CTL 0x6 1898#define GB_AUDIO_WIDGET_TYPE_PGA 0x7 1899#define GB_AUDIO_WIDGET_TYPE_OUT_DRV 0x8 1900#define GB_AUDIO_WIDGET_TYPE_ADC 0x9 1901#define GB_AUDIO_WIDGET_TYPE_DAC 0xa 1902#define GB_AUDIO_WIDGET_TYPE_MICBIAS 0xb 1903#define GB_AUDIO_WIDGET_TYPE_MIC 0xc 1904#define GB_AUDIO_WIDGET_TYPE_HP 0xd 1905#define GB_AUDIO_WIDGET_TYPE_SPK 0xe 1906#define GB_AUDIO_WIDGET_TYPE_LINE 0xf 1907#define GB_AUDIO_WIDGET_TYPE_SWITCH 0x10 1908#define GB_AUDIO_WIDGET_TYPE_VMID 0x11 1909#define GB_AUDIO_WIDGET_TYPE_PRE 0x12 1910#define GB_AUDIO_WIDGET_TYPE_POST 0x13 1911#define GB_AUDIO_WIDGET_TYPE_SUPPLY 0x14 1912#define GB_AUDIO_WIDGET_TYPE_REGULATOR_SUPPLY 0x15 1913#define GB_AUDIO_WIDGET_TYPE_CLOCK_SUPPLY 0x16 1914#define GB_AUDIO_WIDGET_TYPE_AIF_IN 0x17 1915#define GB_AUDIO_WIDGET_TYPE_AIF_OUT 0x18 1916#define GB_AUDIO_WIDGET_TYPE_SIGGEN 0x19 1917#define GB_AUDIO_WIDGET_TYPE_DAI_IN 0x1a 1918#define GB_AUDIO_WIDGET_TYPE_DAI_OUT 0x1b 1919#define GB_AUDIO_WIDGET_TYPE_DAI_LINK 0x1c 1920 1921#define GB_AUDIO_WIDGET_STATE_DISABLED 0x01 1922#define GB_AUDIO_WIDGET_STATE_ENAABLED 0x02 1923 1924#define GB_AUDIO_JACK_EVENT_INSERTION 0x1 1925#define GB_AUDIO_JACK_EVENT_REMOVAL 0x2 1926 1927#define GB_AUDIO_BUTTON_EVENT_PRESS 0x1 1928#define GB_AUDIO_BUTTON_EVENT_RELEASE 0x2 1929 1930#define GB_AUDIO_STREAMING_EVENT_UNSPECIFIED 0x1 1931#define GB_AUDIO_STREAMING_EVENT_HALT 0x2 1932#define GB_AUDIO_STREAMING_EVENT_INTERNAL_ERROR 0x3 1933#define GB_AUDIO_STREAMING_EVENT_PROTOCOL_ERROR 0x4 1934#define GB_AUDIO_STREAMING_EVENT_FAILURE 0x5 1935#define GB_AUDIO_STREAMING_EVENT_UNDERRUN 0x6 1936#define GB_AUDIO_STREAMING_EVENT_OVERRUN 0x7 1937#define GB_AUDIO_STREAMING_EVENT_CLOCKING 0x8 1938#define GB_AUDIO_STREAMING_EVENT_DATA_LEN 0x9 1939 1940#define GB_AUDIO_INVALID_INDEX 0xff 1941 1942/* enum snd_jack_types */ 1943#define GB_AUDIO_JACK_HEADPHONE 0x0000001 1944#define GB_AUDIO_JACK_MICROPHONE 0x0000002 1945#define GB_AUDIO_JACK_HEADSET (GB_AUDIO_JACK_HEADPHONE | \ 1946 GB_AUDIO_JACK_MICROPHONE) 1947#define GB_AUDIO_JACK_LINEOUT 0x0000004 1948#define GB_AUDIO_JACK_MECHANICAL 0x0000008 1949#define GB_AUDIO_JACK_VIDEOOUT 0x0000010 1950#define GB_AUDIO_JACK_AVOUT (GB_AUDIO_JACK_LINEOUT | \ 1951 GB_AUDIO_JACK_VIDEOOUT) 1952#define GB_AUDIO_JACK_LINEIN 0x0000020 1953#define GB_AUDIO_JACK_OC_HPHL 0x0000040 1954#define GB_AUDIO_JACK_OC_HPHR 0x0000080 1955#define GB_AUDIO_JACK_MICROPHONE2 0x0000200 1956#define GB_AUDIO_JACK_ANC_HEADPHONE (GB_AUDIO_JACK_HEADPHONE | \ 1957 GB_AUDIO_JACK_MICROPHONE | \ 1958 GB_AUDIO_JACK_MICROPHONE2) 1959/* Kept separate from switches to facilitate implementation */ 1960#define GB_AUDIO_JACK_BTN_0 0x4000000 1961#define GB_AUDIO_JACK_BTN_1 0x2000000 1962#define GB_AUDIO_JACK_BTN_2 0x1000000 1963#define GB_AUDIO_JACK_BTN_3 0x0800000 1964 1965struct gb_audio_pcm { 1966 __u8 stream_name[GB_AUDIO_PCM_NAME_MAX]; 1967 __le32 formats; /* GB_AUDIO_PCM_FMT_* */ 1968 __le32 rates; /* GB_AUDIO_PCM_RATE_* */ 1969 __u8 chan_min; 1970 __u8 chan_max; 1971 __u8 sig_bits; /* number of bits of content */ 1972} __packed; 1973 1974struct gb_audio_dai { 1975 __u8 name[AUDIO_DAI_NAME_MAX]; 1976 __le16 data_cport; 1977 struct gb_audio_pcm capture; 1978 struct gb_audio_pcm playback; 1979} __packed; 1980 1981struct gb_audio_integer { 1982 __le32 min; 1983 __le32 max; 1984 __le32 step; 1985} __packed; 1986 1987struct gb_audio_integer64 { 1988 __le64 min; 1989 __le64 max; 1990 __le64 step; 1991} __packed; 1992 1993struct gb_audio_enumerated { 1994 __le32 items; 1995 __le16 names_length; 1996 __u8 names[]; 1997} __packed; 1998 1999struct gb_audio_ctl_elem_info { /* See snd_ctl_elem_info in Linux source */ 2000 __u8 type; /* GB_AUDIO_CTL_ELEM_TYPE_* */
2001 __le16 dimen[4]; 2002 union { 2003 struct gb_audio_integer integer; 2004 struct gb_audio_integer64 integer64; 2005 struct gb_audio_enumerated enumerated; 2006 } value; 2007} __packed; 2008 2009struct gb_audio_ctl_elem_value { /* See snd_ctl_elem_value in Linux source */ 2010 __le64 timestamp; /* XXX needed? */ 2011 union { 2012 __le32 integer_value[2]; /* consider CTL_DOUBLE_xxx */ 2013 __le64 integer64_value[2]; 2014 __le32 enumerated_item[2]; 2015 } value; 2016} __packed; 2017 2018struct gb_audio_control { 2019 __u8 name[AUDIO_CONTROL_NAME_MAX]; 2020 __u8 id; /* 0-63 */ 2021 __u8 iface; /* GB_AUDIO_IFACE_* */ 2022 __le16 data_cport; 2023 __le32 access; /* GB_AUDIO_ACCESS_* */ 2024 __u8 count; /* count of same elements */ 2025 __u8 count_values; /* count of values, max=2 for CTL_DOUBLE_xxx */ 2026 struct gb_audio_ctl_elem_info info; 2027} __packed; 2028 2029struct gb_audio_widget { 2030 __u8 name[AUDIO_WIDGET_NAME_MAX]; 2031 __u8 sname[AUDIO_WIDGET_NAME_MAX]; 2032 __u8 id; 2033 __u8 type; /* GB_AUDIO_WIDGET_TYPE_* */ 2034 __u8 state; /* GB_AUDIO_WIDGET_STATE_* */ 2035 __u8 ncontrols; 2036 struct gb_audio_control ctl[]; /* 'ncontrols' entries */ 2037} __packed; 2038 2039struct gb_audio_route { 2040 __u8 source_id; /* widget id */ 2041 __u8 destination_id; /* widget id */ 2042 __u8 control_id; /* 0-63 */ 2043 __u8 index; /* Selection within the control */ 2044} __packed; 2045 2046struct gb_audio_topology { 2047 __u8 num_dais; 2048 __u8 num_controls; 2049 __u8 num_widgets; 2050 __u8 num_routes; 2051 __le32 size_dais; 2052 __le32 size_controls; 2053 __le32 size_widgets; 2054 __le32 size_routes; 2055 __le32 jack_type; 2056 /* 2057 * struct gb_audio_dai dai[num_dais]; 2058 * struct gb_audio_control controls[num_controls]; 2059 * struct gb_audio_widget widgets[num_widgets]; 2060 * struct gb_audio_route routes[num_routes]; 2061 */ 2062 __u8 data[]; 2063} __packed; 2064 2065struct gb_audio_get_topology_size_response { 2066 __le16 size; 2067} __packed; 2068 2069struct gb_audio_get_topology_response { 2070 struct gb_audio_topology topology; 2071} __packed; 2072 2073struct gb_audio_get_control_request { 2074 __u8 control_id; 2075 __u8 index; 2076} __packed; 2077 2078struct gb_audio_get_control_response { 2079 struct gb_audio_ctl_elem_value value; 2080} __packed; 2081 2082struct gb_audio_set_control_request { 2083 __u8 control_id; 2084 __u8 index; 2085 struct gb_audio_ctl_elem_value value; 2086} __packed; 2087 2088struct gb_audio_enable_widget_request { 2089 __u8 widget_id; 2090} __packed; 2091 2092struct gb_audio_disable_widget_request { 2093 __u8 widget_id; 2094} __packed; 2095 2096struct gb_audio_get_pcm_request { 2097 __le16 data_cport; 2098} __packed; 2099 2100struct gb_audio_get_pcm_response { 2101 __le32 format; 2102 __le32 rate; 2103 __u8 channels; 2104 __u8 sig_bits; 2105} __packed; 2106 2107struct gb_audio_set_pcm_request { 2108 __le16 data_cport; 2109 __le32 format; 2110 __le32 rate; 2111 __u8 channels; 2112 __u8 sig_bits; 2113} __packed; 2114 2115struct gb_audio_set_tx_data_size_request { 2116 __le16 data_cport; 2117 __le16 size; 2118} __packed; 2119 2120struct gb_audio_activate_tx_request { 2121 __le16 data_cport; 2122} __packed; 2123 2124struct gb_audio_deactivate_tx_request { 2125 __le16 data_cport; 2126} __packed; 2127 2128struct gb_audio_set_rx_data_size_request { 2129 __le16 data_cport; 2130 __le16 size; 2131} __packed; 2132 2133struct gb_audio_activate_rx_request { 2134 __le16 data_cport; 2135} __packed; 2136 2137struct gb_audio_deactivate_rx_request { 2138 __le16 data_cport; 2139} __packed; 2140 2141struct gb_audio_jack_event_request { 2142 __u8 widget_id; 2143 __u8 jack_attribute; 2144 __u8 event; 2145} __packed; 2146 2147struct gb_audio_button_event_request { 2148 __u8 widget_id; 2149 __u8 button_id; 2150 __u8 event; 2151} __packed; 2152 2153struct gb_audio_streaming_event_request { 2154 __le16 data_cport; 2155 __u8 event; 2156} __packed; 2157 2158struct gb_audio_send_data_request { 2159 __le64 timestamp; 2160 __u8 data[]; 2161} __packed; 2162 2163 2164/* Log */ 2165 2166/* operations */ 2167#define GB_LOG_TYPE_SEND_LOG 0x02 2168 2169/* length */ 2170#define GB_LOG_MAX_LEN 1024 2171 2172struct gb_log_send_log_request { 2173 __le16 len; 2174 __u8 msg[]; 2175} __packed; 2176 2177#endif /* __GREYBUS_PROTOCOLS_H */ 2178 2179