1 /* SPDX-License-Identifier: (GPL-2.0 OR BSD-3-Clause) */
3 * Copyright(c) 2014 - 2015 Google Inc. All rights reserved.
4 * Copyright(c) 2014 - 2015 Linaro Ltd. All rights reserved.
7 #ifndef __GREYBUS_PROTOCOLS_H
8 #define __GREYBUS_PROTOCOLS_H
10 #include <linux/types.h>
12 /* Fixed IDs for control/svc protocols */
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
20 #define GB_SVC_CPORT_ID 0
21 #define GB_CONTROL_BUNDLE_ID 0
22 #define GB_CONTROL_CPORT_ID 0
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).
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.
42 * The wire format for all numeric fields in the header is little
43 * endian. Any operation-specific data begins immediately after the
46 struct 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) */
55 /* Generic request types */
56 #define GB_REQUEST_TYPE_CPORT_SHUTDOWN 0x00
57 #define GB_REQUEST_TYPE_INVALID 0x7f
59 struct gb_cport_shutdown_request
{
64 /* Control Protocol */
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
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
89 struct gb_control_version_request
{
94 struct gb_control_version_response
{
99 struct gb_control_bundle_version_request
{
103 struct gb_control_bundle_version_response
{
108 /* Control protocol manifest get size request has no payload*/
109 struct gb_control_get_manifest_size_response
{
113 /* Control protocol manifest get request has no payload */
114 struct gb_control_get_manifest_response
{
118 /* Control protocol [dis]connected request */
119 struct gb_control_connected_request
{
123 struct gb_control_disconnecting_request
{
126 /* disconnecting response has no payload */
128 struct gb_control_disconnected_request
{
131 /* Control protocol [dis]connected response has no payload */
134 * All Bundle power management operations use the same request and response
135 * layout and status codes.
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
144 struct gb_control_bundle_pm_request
{
148 struct gb_control_bundle_pm_response
{
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.
158 #define GB_CONTROL_INTF_PM_OK 0x00
159 #define GB_CONTROL_INTF_PM_BUSY 0x01
160 #define GB_CONTROL_INTF_PM_NA 0x02
162 struct gb_control_intf_pm_response
{
166 /* APBridge protocol */
168 /* request APB1 log */
169 #define GB_APB_REQUEST_LOG 0x02
171 /* request to map a cport to bulk in and bulk out endpoints */
172 #define GB_APB_REQUEST_EP_MAPPING 0x03
174 /* request to get the number of cports available */
175 #define GB_APB_REQUEST_CPORT_COUNT 0x04
177 /* request to reset a cport state */
178 #define GB_APB_REQUEST_RESET_CPORT 0x05
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
184 /* request to control the CSI transmitter */
185 #define GB_APB_REQUEST_CSI_TX_CONTROL 0x08
187 /* request to control audio streaming */
188 #define GB_APB_REQUEST_AUDIO_CONTROL 0x09
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
196 /* requests to set Greybus CPort flags */
197 #define GB_APB_REQUEST_CPORT_FLAGS 0x11
200 #define GB_APB_REQUEST_ARPC_RUN 0x12
202 struct gb_apb_request_cport_flags
{
204 #define GB_APB_CPORT_FLAG_CONTROL 0x01
205 #define GB_APB_CPORT_FLAG_HIGH_PRIO 0x02
209 /* Firmware Download Protocol */
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
216 #define GB_FIRMWARE_TAG_MAX_SIZE 10
218 /* firmware download find firmware request/response */
219 struct gb_fw_download_find_firmware_request
{
220 __u8 firmware_tag
[GB_FIRMWARE_TAG_MAX_SIZE
];
223 struct gb_fw_download_find_firmware_response
{
228 /* firmware download fetch firmware request/response */
229 struct gb_fw_download_fetch_firmware_request
{
235 /* gb_fw_download_fetch_firmware_response contains no other data */
237 /* firmware download release firmware request */
238 struct gb_fw_download_release_firmware_request
{
241 /* firmware download release firmware response has no payload */
244 /* Firmware Management Protocol */
247 #define GB_FW_MGMT_TYPE_INTERFACE_FW_VERSION 0x01
248 #define GB_FW_MGMT_TYPE_LOAD_AND_VALIDATE_FW 0x02
249 #define GB_FW_MGMT_TYPE_LOADED_FW 0x03
250 #define GB_FW_MGMT_TYPE_BACKEND_FW_VERSION 0x04
251 #define GB_FW_MGMT_TYPE_BACKEND_FW_UPDATE 0x05
252 #define GB_FW_MGMT_TYPE_BACKEND_FW_UPDATED 0x06
254 #define GB_FW_LOAD_METHOD_UNIPRO 0x01
255 #define GB_FW_LOAD_METHOD_INTERNAL 0x02
257 #define GB_FW_LOAD_STATUS_FAILED 0x00
258 #define GB_FW_LOAD_STATUS_UNVALIDATED 0x01
259 #define GB_FW_LOAD_STATUS_VALIDATED 0x02
260 #define GB_FW_LOAD_STATUS_VALIDATION_FAILED 0x03
262 #define GB_FW_BACKEND_FW_STATUS_SUCCESS 0x01
263 #define GB_FW_BACKEND_FW_STATUS_FAIL_FIND 0x02
264 #define GB_FW_BACKEND_FW_STATUS_FAIL_FETCH 0x03
265 #define GB_FW_BACKEND_FW_STATUS_FAIL_WRITE 0x04
266 #define GB_FW_BACKEND_FW_STATUS_INT 0x05
267 #define GB_FW_BACKEND_FW_STATUS_RETRY 0x06
268 #define GB_FW_BACKEND_FW_STATUS_NOT_SUPPORTED 0x07
270 #define GB_FW_BACKEND_VERSION_STATUS_SUCCESS 0x01
271 #define GB_FW_BACKEND_VERSION_STATUS_NOT_AVAILABLE 0x02
272 #define GB_FW_BACKEND_VERSION_STATUS_NOT_SUPPORTED 0x03
273 #define GB_FW_BACKEND_VERSION_STATUS_RETRY 0x04
274 #define GB_FW_BACKEND_VERSION_STATUS_FAIL_INT 0x05
276 /* firmware management interface firmware version request has no payload */
277 struct gb_fw_mgmt_interface_fw_version_response
{
278 __u8 firmware_tag
[GB_FIRMWARE_TAG_MAX_SIZE
];
283 /* firmware management load and validate firmware request/response */
284 struct gb_fw_mgmt_load_and_validate_fw_request
{
287 __u8 firmware_tag
[GB_FIRMWARE_TAG_MAX_SIZE
];
289 /* firmware management load and validate firmware response has no payload*/
291 /* firmware management loaded firmware request */
292 struct gb_fw_mgmt_loaded_fw_request
{
298 /* firmware management loaded firmware response has no payload */
300 /* firmware management backend firmware version request/response */
301 struct gb_fw_mgmt_backend_fw_version_request
{
302 __u8 firmware_tag
[GB_FIRMWARE_TAG_MAX_SIZE
];
305 struct gb_fw_mgmt_backend_fw_version_response
{
311 /* firmware management backend firmware update request */
312 struct gb_fw_mgmt_backend_fw_update_request
{
314 __u8 firmware_tag
[GB_FIRMWARE_TAG_MAX_SIZE
];
316 /* firmware management backend firmware update response has no payload */
318 /* firmware management backend firmware updated request */
319 struct gb_fw_mgmt_backend_fw_updated_request
{
323 /* firmware management backend firmware updated response has no payload */
326 /* Component Authentication Protocol (CAP) */
329 #define GB_CAP_TYPE_GET_ENDPOINT_UID 0x01
330 #define GB_CAP_TYPE_GET_IMS_CERTIFICATE 0x02
331 #define GB_CAP_TYPE_AUTHENTICATE 0x03
333 /* CAP get endpoint uid request has no payload */
334 struct gb_cap_get_endpoint_uid_response
{
338 /* CAP get endpoint ims certificate request/response */
339 struct gb_cap_get_ims_certificate_request
{
340 __le32 certificate_class
;
341 __le32 certificate_id
;
344 struct gb_cap_get_ims_certificate_response
{
349 /* CAP authenticate request/response */
350 struct gb_cap_authenticate_request
{
356 struct gb_cap_authenticate_response
{
363 /* Bootrom Protocol */
365 /* Version of the Greybus bootrom protocol we support */
366 #define GB_BOOTROM_VERSION_MAJOR 0x00
367 #define GB_BOOTROM_VERSION_MINOR 0x01
369 /* Greybus bootrom request types */
370 #define GB_BOOTROM_TYPE_VERSION 0x01
371 #define GB_BOOTROM_TYPE_FIRMWARE_SIZE 0x02
372 #define GB_BOOTROM_TYPE_GET_FIRMWARE 0x03
373 #define GB_BOOTROM_TYPE_READY_TO_BOOT 0x04
374 #define GB_BOOTROM_TYPE_AP_READY 0x05 /* Request with no-payload */
375 #define GB_BOOTROM_TYPE_GET_VID_PID 0x06 /* Request with no-payload */
377 /* Greybus bootrom boot stages */
378 #define GB_BOOTROM_BOOT_STAGE_ONE 0x01 /* Reserved for the boot ROM */
379 #define GB_BOOTROM_BOOT_STAGE_TWO 0x02 /* Bootrom package to be loaded by the boot ROM */
380 #define GB_BOOTROM_BOOT_STAGE_THREE 0x03 /* Module personality package loaded by Stage 2 firmware */
382 /* Greybus bootrom ready to boot status */
383 #define GB_BOOTROM_BOOT_STATUS_INVALID 0x00 /* Firmware blob could not be validated */
384 #define GB_BOOTROM_BOOT_STATUS_INSECURE 0x01 /* Firmware blob is valid but insecure */
385 #define GB_BOOTROM_BOOT_STATUS_SECURE 0x02 /* Firmware blob is valid and secure */
387 /* Max bootrom data fetch size in bytes */
388 #define GB_BOOTROM_FETCH_MAX 2000
390 struct gb_bootrom_version_request
{
395 struct gb_bootrom_version_response
{
400 /* Bootrom protocol firmware size request/response */
401 struct gb_bootrom_firmware_size_request
{
405 struct gb_bootrom_firmware_size_response
{
409 /* Bootrom protocol get firmware request/response */
410 struct gb_bootrom_get_firmware_request
{
415 /* gb_bootrom_get_firmware_response contains no other data */
417 /* Bootrom protocol Ready to boot request */
418 struct gb_bootrom_ready_to_boot_request
{
421 /* Bootrom protocol Ready to boot response has no payload */
423 /* Bootrom protocol get VID/PID request has no payload */
424 struct gb_bootrom_get_vid_pid_response
{
432 /* Greybus power supply request types */
433 #define GB_POWER_SUPPLY_TYPE_GET_SUPPLIES 0x02
434 #define GB_POWER_SUPPLY_TYPE_GET_DESCRIPTION 0x03
435 #define GB_POWER_SUPPLY_TYPE_GET_PROP_DESCRIPTORS 0x04
436 #define GB_POWER_SUPPLY_TYPE_GET_PROPERTY 0x05
437 #define GB_POWER_SUPPLY_TYPE_SET_PROPERTY 0x06
438 #define GB_POWER_SUPPLY_TYPE_EVENT 0x07
440 /* Greybus power supply battery technologies types */
441 #define GB_POWER_SUPPLY_TECH_UNKNOWN 0x0000
442 #define GB_POWER_SUPPLY_TECH_NiMH 0x0001
443 #define GB_POWER_SUPPLY_TECH_LION 0x0002
444 #define GB_POWER_SUPPLY_TECH_LIPO 0x0003
445 #define GB_POWER_SUPPLY_TECH_LiFe 0x0004
446 #define GB_POWER_SUPPLY_TECH_NiCd 0x0005
447 #define GB_POWER_SUPPLY_TECH_LiMn 0x0006
449 /* Greybus power supply types */
450 #define GB_POWER_SUPPLY_UNKNOWN_TYPE 0x0000
451 #define GB_POWER_SUPPLY_BATTERY_TYPE 0x0001
452 #define GB_POWER_SUPPLY_UPS_TYPE 0x0002
453 #define GB_POWER_SUPPLY_MAINS_TYPE 0x0003
454 #define GB_POWER_SUPPLY_USB_TYPE 0x0004
455 #define GB_POWER_SUPPLY_USB_DCP_TYPE 0x0005
456 #define GB_POWER_SUPPLY_USB_CDP_TYPE 0x0006
457 #define GB_POWER_SUPPLY_USB_ACA_TYPE 0x0007
459 /* Greybus power supply health values */
460 #define GB_POWER_SUPPLY_HEALTH_UNKNOWN 0x0000
461 #define GB_POWER_SUPPLY_HEALTH_GOOD 0x0001
462 #define GB_POWER_SUPPLY_HEALTH_OVERHEAT 0x0002
463 #define GB_POWER_SUPPLY_HEALTH_DEAD 0x0003
464 #define GB_POWER_SUPPLY_HEALTH_OVERVOLTAGE 0x0004
465 #define GB_POWER_SUPPLY_HEALTH_UNSPEC_FAILURE 0x0005
466 #define GB_POWER_SUPPLY_HEALTH_COLD 0x0006
467 #define GB_POWER_SUPPLY_HEALTH_WATCHDOG_TIMER_EXPIRE 0x0007
468 #define GB_POWER_SUPPLY_HEALTH_SAFETY_TIMER_EXPIRE 0x0008
470 /* Greybus power supply status values */
471 #define GB_POWER_SUPPLY_STATUS_UNKNOWN 0x0000
472 #define GB_POWER_SUPPLY_STATUS_CHARGING 0x0001
473 #define GB_POWER_SUPPLY_STATUS_DISCHARGING 0x0002
474 #define GB_POWER_SUPPLY_STATUS_NOT_CHARGING 0x0003
475 #define GB_POWER_SUPPLY_STATUS_FULL 0x0004
477 /* Greybus power supply capacity level values */
478 #define GB_POWER_SUPPLY_CAPACITY_LEVEL_UNKNOWN 0x0000
479 #define GB_POWER_SUPPLY_CAPACITY_LEVEL_CRITICAL 0x0001
480 #define GB_POWER_SUPPLY_CAPACITY_LEVEL_LOW 0x0002
481 #define GB_POWER_SUPPLY_CAPACITY_LEVEL_NORMAL 0x0003
482 #define GB_POWER_SUPPLY_CAPACITY_LEVEL_HIGH 0x0004
483 #define GB_POWER_SUPPLY_CAPACITY_LEVEL_FULL 0x0005
485 /* Greybus power supply scope values */
486 #define GB_POWER_SUPPLY_SCOPE_UNKNOWN 0x0000
487 #define GB_POWER_SUPPLY_SCOPE_SYSTEM 0x0001
488 #define GB_POWER_SUPPLY_SCOPE_DEVICE 0x0002
490 struct gb_power_supply_get_supplies_response
{
494 struct gb_power_supply_get_description_request
{
498 struct gb_power_supply_get_description_response
{
499 __u8 manufacturer
[32];
501 __u8 serial_number
[32];
503 __u8 properties_count
;
506 struct gb_power_supply_props_desc
{
508 #define GB_POWER_SUPPLY_PROP_STATUS 0x00
509 #define GB_POWER_SUPPLY_PROP_CHARGE_TYPE 0x01
510 #define GB_POWER_SUPPLY_PROP_HEALTH 0x02
511 #define GB_POWER_SUPPLY_PROP_PRESENT 0x03
512 #define GB_POWER_SUPPLY_PROP_ONLINE 0x04
513 #define GB_POWER_SUPPLY_PROP_AUTHENTIC 0x05
514 #define GB_POWER_SUPPLY_PROP_TECHNOLOGY 0x06
515 #define GB_POWER_SUPPLY_PROP_CYCLE_COUNT 0x07
516 #define GB_POWER_SUPPLY_PROP_VOLTAGE_MAX 0x08
517 #define GB_POWER_SUPPLY_PROP_VOLTAGE_MIN 0x09
518 #define GB_POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN 0x0A
519 #define GB_POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN 0x0B
520 #define GB_POWER_SUPPLY_PROP_VOLTAGE_NOW 0x0C
521 #define GB_POWER_SUPPLY_PROP_VOLTAGE_AVG 0x0D
522 #define GB_POWER_SUPPLY_PROP_VOLTAGE_OCV 0x0E
523 #define GB_POWER_SUPPLY_PROP_VOLTAGE_BOOT 0x0F
524 #define GB_POWER_SUPPLY_PROP_CURRENT_MAX 0x10
525 #define GB_POWER_SUPPLY_PROP_CURRENT_NOW 0x11
526 #define GB_POWER_SUPPLY_PROP_CURRENT_AVG 0x12
527 #define GB_POWER_SUPPLY_PROP_CURRENT_BOOT 0x13
528 #define GB_POWER_SUPPLY_PROP_POWER_NOW 0x14
529 #define GB_POWER_SUPPLY_PROP_POWER_AVG 0x15
530 #define GB_POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN 0x16
531 #define GB_POWER_SUPPLY_PROP_CHARGE_EMPTY_DESIGN 0x17
532 #define GB_POWER_SUPPLY_PROP_CHARGE_FULL 0x18
533 #define GB_POWER_SUPPLY_PROP_CHARGE_EMPTY 0x19
534 #define GB_POWER_SUPPLY_PROP_CHARGE_NOW 0x1A
535 #define GB_POWER_SUPPLY_PROP_CHARGE_AVG 0x1B
536 #define GB_POWER_SUPPLY_PROP_CHARGE_COUNTER 0x1C
537 #define GB_POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT 0x1D
538 #define GB_POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT_MAX 0x1E
539 #define GB_POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE 0x1F
540 #define GB_POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE_MAX 0x20
541 #define GB_POWER_SUPPLY_PROP_CHARGE_CONTROL_LIMIT 0x21
542 #define GB_POWER_SUPPLY_PROP_CHARGE_CONTROL_LIMIT_MAX 0x22
543 #define GB_POWER_SUPPLY_PROP_INPUT_CURRENT_LIMIT 0x23
544 #define GB_POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN 0x24
545 #define GB_POWER_SUPPLY_PROP_ENERGY_EMPTY_DESIGN 0x25
546 #define GB_POWER_SUPPLY_PROP_ENERGY_FULL 0x26
547 #define GB_POWER_SUPPLY_PROP_ENERGY_EMPTY 0x27
548 #define GB_POWER_SUPPLY_PROP_ENERGY_NOW 0x28
549 #define GB_POWER_SUPPLY_PROP_ENERGY_AVG 0x29
550 #define GB_POWER_SUPPLY_PROP_CAPACITY 0x2A
551 #define GB_POWER_SUPPLY_PROP_CAPACITY_ALERT_MIN 0x2B
552 #define GB_POWER_SUPPLY_PROP_CAPACITY_ALERT_MAX 0x2C
553 #define GB_POWER_SUPPLY_PROP_CAPACITY_LEVEL 0x2D
554 #define GB_POWER_SUPPLY_PROP_TEMP 0x2E
555 #define GB_POWER_SUPPLY_PROP_TEMP_MAX 0x2F
556 #define GB_POWER_SUPPLY_PROP_TEMP_MIN 0x30
557 #define GB_POWER_SUPPLY_PROP_TEMP_ALERT_MIN 0x31
558 #define GB_POWER_SUPPLY_PROP_TEMP_ALERT_MAX 0x32
559 #define GB_POWER_SUPPLY_PROP_TEMP_AMBIENT 0x33
560 #define GB_POWER_SUPPLY_PROP_TEMP_AMBIENT_ALERT_MIN 0x34
561 #define GB_POWER_SUPPLY_PROP_TEMP_AMBIENT_ALERT_MAX 0x35
562 #define GB_POWER_SUPPLY_PROP_TIME_TO_EMPTY_NOW 0x36
563 #define GB_POWER_SUPPLY_PROP_TIME_TO_EMPTY_AVG 0x37
564 #define GB_POWER_SUPPLY_PROP_TIME_TO_FULL_NOW 0x38
565 #define GB_POWER_SUPPLY_PROP_TIME_TO_FULL_AVG 0x39
566 #define GB_POWER_SUPPLY_PROP_TYPE 0x3A
567 #define GB_POWER_SUPPLY_PROP_SCOPE 0x3B
568 #define GB_POWER_SUPPLY_PROP_CHARGE_TERM_CURRENT 0x3C
569 #define GB_POWER_SUPPLY_PROP_CALIBRATE 0x3D
573 struct gb_power_supply_get_property_descriptors_request
{
577 struct gb_power_supply_get_property_descriptors_response
{
578 __u8 properties_count
;
579 struct gb_power_supply_props_desc props
[];
582 struct gb_power_supply_get_property_request
{
587 struct gb_power_supply_get_property_response
{
591 struct gb_power_supply_set_property_request
{
597 struct gb_power_supply_event_request
{
600 #define GB_POWER_SUPPLY_UPDATE 0x01
606 /* Greybus HID operation types */
607 #define GB_HID_TYPE_GET_DESC 0x02
608 #define GB_HID_TYPE_GET_REPORT_DESC 0x03
609 #define GB_HID_TYPE_PWR_ON 0x04
610 #define GB_HID_TYPE_PWR_OFF 0x05
611 #define GB_HID_TYPE_GET_REPORT 0x06
612 #define GB_HID_TYPE_SET_REPORT 0x07
613 #define GB_HID_TYPE_IRQ_EVENT 0x08
616 #define GB_HID_INPUT_REPORT 0
617 #define GB_HID_OUTPUT_REPORT 1
618 #define GB_HID_FEATURE_REPORT 2
620 /* Different request/response structures */
621 /* HID get descriptor response */
622 struct gb_hid_desc_response
{
624 __le16 wReportDescLength
;
631 /* HID get report request/response */
632 struct gb_hid_get_report_request
{
637 /* HID set report request */
638 struct gb_hid_set_report_request
{
644 /* HID input report request, via interrupt pipe */
645 struct gb_hid_input_report_request
{
652 /* Greybus i2c request types */
653 #define GB_I2C_TYPE_FUNCTIONALITY 0x02
654 #define GB_I2C_TYPE_TRANSFER 0x05
656 /* functionality request has no payload */
657 struct gb_i2c_functionality_response
{
658 __le32 functionality
;
662 * Outgoing data immediately follows the op count and ops array.
663 * The data for each write (master -> slave) op in the array is sent
664 * in order, with no (e.g. pad) bytes separating them.
666 * Short reads cause the entire transfer request to fail So response
667 * payload consists only of bytes read, and the number of bytes is
668 * exactly what was specified in the corresponding op. Like
669 * outgoing data, the incoming data is in order and contiguous.
671 struct gb_i2c_transfer_op
{
677 struct gb_i2c_transfer_request
{
679 struct gb_i2c_transfer_op ops
[]; /* op_count of these */
681 struct gb_i2c_transfer_response
{
682 __u8 data
[0]; /* inbound data */
688 /* Greybus GPIO request types */
689 #define GB_GPIO_TYPE_LINE_COUNT 0x02
690 #define GB_GPIO_TYPE_ACTIVATE 0x03
691 #define GB_GPIO_TYPE_DEACTIVATE 0x04
692 #define GB_GPIO_TYPE_GET_DIRECTION 0x05
693 #define GB_GPIO_TYPE_DIRECTION_IN 0x06
694 #define GB_GPIO_TYPE_DIRECTION_OUT 0x07
695 #define GB_GPIO_TYPE_GET_VALUE 0x08
696 #define GB_GPIO_TYPE_SET_VALUE 0x09
697 #define GB_GPIO_TYPE_SET_DEBOUNCE 0x0a
698 #define GB_GPIO_TYPE_IRQ_TYPE 0x0b
699 #define GB_GPIO_TYPE_IRQ_MASK 0x0c
700 #define GB_GPIO_TYPE_IRQ_UNMASK 0x0d
701 #define GB_GPIO_TYPE_IRQ_EVENT 0x0e
703 #define GB_GPIO_IRQ_TYPE_NONE 0x00
704 #define GB_GPIO_IRQ_TYPE_EDGE_RISING 0x01
705 #define GB_GPIO_IRQ_TYPE_EDGE_FALLING 0x02
706 #define GB_GPIO_IRQ_TYPE_EDGE_BOTH 0x03
707 #define GB_GPIO_IRQ_TYPE_LEVEL_HIGH 0x04
708 #define GB_GPIO_IRQ_TYPE_LEVEL_LOW 0x08
710 /* line count request has no payload */
711 struct gb_gpio_line_count_response
{
715 struct gb_gpio_activate_request
{
718 /* activate response has no payload */
720 struct gb_gpio_deactivate_request
{
723 /* deactivate response has no payload */
725 struct gb_gpio_get_direction_request
{
728 struct gb_gpio_get_direction_response
{
732 struct gb_gpio_direction_in_request
{
735 /* direction in response has no payload */
737 struct gb_gpio_direction_out_request
{
741 /* direction out response has no payload */
743 struct gb_gpio_get_value_request
{
746 struct gb_gpio_get_value_response
{
750 struct gb_gpio_set_value_request
{
754 /* set value response has no payload */
756 struct gb_gpio_set_debounce_request
{
760 /* debounce response has no payload */
762 struct gb_gpio_irq_type_request
{
766 /* irq type response has no payload */
768 struct gb_gpio_irq_mask_request
{
771 /* irq mask response has no payload */
773 struct gb_gpio_irq_unmask_request
{
776 /* irq unmask response has no payload */
778 /* irq event requests originate on another module and are handled on the AP */
779 struct gb_gpio_irq_event_request
{
782 /* irq event has no response */
787 /* Greybus PWM operation types */
788 #define GB_PWM_TYPE_PWM_COUNT 0x02
789 #define GB_PWM_TYPE_ACTIVATE 0x03
790 #define GB_PWM_TYPE_DEACTIVATE 0x04
791 #define GB_PWM_TYPE_CONFIG 0x05
792 #define GB_PWM_TYPE_POLARITY 0x06
793 #define GB_PWM_TYPE_ENABLE 0x07
794 #define GB_PWM_TYPE_DISABLE 0x08
796 /* pwm count request has no payload */
797 struct gb_pwm_count_response
{
801 struct gb_pwm_activate_request
{
805 struct gb_pwm_deactivate_request
{
809 struct gb_pwm_config_request
{
815 struct gb_pwm_polarity_request
{
820 struct gb_pwm_enable_request
{
824 struct gb_pwm_disable_request
{
830 /* Should match up with modes in linux/spi/spi.h */
831 #define GB_SPI_MODE_CPHA 0x01 /* clock phase */
832 #define GB_SPI_MODE_CPOL 0x02 /* clock polarity */
833 #define GB_SPI_MODE_MODE_0 (0 | 0) /* (original MicroWire) */
834 #define GB_SPI_MODE_MODE_1 (0 | GB_SPI_MODE_CPHA)
835 #define GB_SPI_MODE_MODE_2 (GB_SPI_MODE_CPOL | 0)
836 #define GB_SPI_MODE_MODE_3 (GB_SPI_MODE_CPOL | GB_SPI_MODE_CPHA)
837 #define GB_SPI_MODE_CS_HIGH 0x04 /* chipselect active high? */
838 #define GB_SPI_MODE_LSB_FIRST 0x08 /* per-word bits-on-wire */
839 #define GB_SPI_MODE_3WIRE 0x10 /* SI/SO signals shared */
840 #define GB_SPI_MODE_LOOP 0x20 /* loopback mode */
841 #define GB_SPI_MODE_NO_CS 0x40 /* 1 dev/bus, no chipselect */
842 #define GB_SPI_MODE_READY 0x80 /* slave pulls low to pause */
844 /* Should match up with flags in linux/spi/spi.h */
845 #define GB_SPI_FLAG_HALF_DUPLEX BIT(0) /* can't do full duplex */
846 #define GB_SPI_FLAG_NO_RX BIT(1) /* can't do buffer read */
847 #define GB_SPI_FLAG_NO_TX BIT(2) /* can't do buffer write */
849 /* Greybus spi operation types */
850 #define GB_SPI_TYPE_MASTER_CONFIG 0x02
851 #define GB_SPI_TYPE_DEVICE_CONFIG 0x03
852 #define GB_SPI_TYPE_TRANSFER 0x04
854 /* mode request has no payload */
855 struct gb_spi_master_config_response
{
856 __le32 bits_per_word_mask
;
864 struct gb_spi_device_config_request
{
868 struct gb_spi_device_config_response
{
873 #define GB_SPI_SPI_DEV 0x00
874 #define GB_SPI_SPI_NOR 0x01
875 #define GB_SPI_SPI_MODALIAS 0x02
880 * struct gb_spi_transfer - a read/write buffer pair
881 * @speed_hz: Select a speed other than the device default for this transfer. If
882 * 0 the default (from @spi_device) is used.
883 * @len: size of rx and tx buffers (in bytes)
884 * @delay_usecs: microseconds to delay after this transfer before (optionally)
885 * changing the chipselect status, then starting the next transfer or
886 * completing this spi_message.
887 * @cs_change: affects chipselect after this transfer completes
888 * @bits_per_word: select a bits_per_word other than the device default for this
889 * transfer. If 0 the default (from @spi_device) is used.
891 struct gb_spi_transfer
{
898 #define GB_SPI_XFER_READ 0x01
899 #define GB_SPI_XFER_WRITE 0x02
900 #define GB_SPI_XFER_INPROGRESS 0x04
903 struct gb_spi_transfer_request
{
904 __u8 chip_select
; /* of the spi device */
905 __u8 mode
; /* of the spi device */
907 struct gb_spi_transfer transfers
[]; /* count of these */
910 struct gb_spi_transfer_response
{
911 __u8 data
[0]; /* inbound data */
914 /* Version of the Greybus SVC protocol we support */
915 #define GB_SVC_VERSION_MAJOR 0x00
916 #define GB_SVC_VERSION_MINOR 0x01
918 /* Greybus SVC request types */
919 #define GB_SVC_TYPE_PROTOCOL_VERSION 0x01
920 #define GB_SVC_TYPE_SVC_HELLO 0x02
921 #define GB_SVC_TYPE_INTF_DEVICE_ID 0x03
922 #define GB_SVC_TYPE_INTF_RESET 0x06
923 #define GB_SVC_TYPE_CONN_CREATE 0x07
924 #define GB_SVC_TYPE_CONN_DESTROY 0x08
925 #define GB_SVC_TYPE_DME_PEER_GET 0x09
926 #define GB_SVC_TYPE_DME_PEER_SET 0x0a
927 #define GB_SVC_TYPE_ROUTE_CREATE 0x0b
928 #define GB_SVC_TYPE_ROUTE_DESTROY 0x0c
929 #define GB_SVC_TYPE_TIMESYNC_ENABLE 0x0d
930 #define GB_SVC_TYPE_TIMESYNC_DISABLE 0x0e
931 #define GB_SVC_TYPE_TIMESYNC_AUTHORITATIVE 0x0f
932 #define GB_SVC_TYPE_INTF_SET_PWRM 0x10
933 #define GB_SVC_TYPE_INTF_EJECT 0x11
934 #define GB_SVC_TYPE_PING 0x13
935 #define GB_SVC_TYPE_PWRMON_RAIL_COUNT_GET 0x14
936 #define GB_SVC_TYPE_PWRMON_RAIL_NAMES_GET 0x15
937 #define GB_SVC_TYPE_PWRMON_SAMPLE_GET 0x16
938 #define GB_SVC_TYPE_PWRMON_INTF_SAMPLE_GET 0x17
939 #define GB_SVC_TYPE_TIMESYNC_WAKE_PINS_ACQUIRE 0x18
940 #define GB_SVC_TYPE_TIMESYNC_WAKE_PINS_RELEASE 0x19
941 #define GB_SVC_TYPE_TIMESYNC_PING 0x1a
942 #define GB_SVC_TYPE_MODULE_INSERTED 0x1f
943 #define GB_SVC_TYPE_MODULE_REMOVED 0x20
944 #define GB_SVC_TYPE_INTF_VSYS_ENABLE 0x21
945 #define GB_SVC_TYPE_INTF_VSYS_DISABLE 0x22
946 #define GB_SVC_TYPE_INTF_REFCLK_ENABLE 0x23
947 #define GB_SVC_TYPE_INTF_REFCLK_DISABLE 0x24
948 #define GB_SVC_TYPE_INTF_UNIPRO_ENABLE 0x25
949 #define GB_SVC_TYPE_INTF_UNIPRO_DISABLE 0x26
950 #define GB_SVC_TYPE_INTF_ACTIVATE 0x27
951 #define GB_SVC_TYPE_INTF_RESUME 0x28
952 #define GB_SVC_TYPE_INTF_MAILBOX_EVENT 0x29
953 #define GB_SVC_TYPE_INTF_OOPS 0x2a
955 /* Greybus SVC protocol status values */
956 #define GB_SVC_OP_SUCCESS 0x00
957 #define GB_SVC_OP_UNKNOWN_ERROR 0x01
958 #define GB_SVC_INTF_NOT_DETECTED 0x02
959 #define GB_SVC_INTF_NO_UPRO_LINK 0x03
960 #define GB_SVC_INTF_UPRO_NOT_DOWN 0x04
961 #define GB_SVC_INTF_UPRO_NOT_HIBERNATED 0x05
962 #define GB_SVC_INTF_NO_V_SYS 0x06
963 #define GB_SVC_INTF_V_CHG 0x07
964 #define GB_SVC_INTF_WAKE_BUSY 0x08
965 #define GB_SVC_INTF_NO_REFCLK 0x09
966 #define GB_SVC_INTF_RELEASING 0x0a
967 #define GB_SVC_INTF_NO_ORDER 0x0b
968 #define GB_SVC_INTF_MBOX_SET 0x0c
969 #define GB_SVC_INTF_BAD_MBOX 0x0d
970 #define GB_SVC_INTF_OP_TIMEOUT 0x0e
971 #define GB_SVC_PWRMON_OP_NOT_PRESENT 0x0f
973 struct gb_svc_version_request
{
978 struct gb_svc_version_response
{
983 /* SVC protocol hello request */
984 struct gb_svc_hello_request
{
988 /* hello response has no payload */
990 struct gb_svc_intf_device_id_request
{
994 /* device id response has no payload */
996 struct gb_svc_intf_reset_request
{
999 /* interface reset response has no payload */
1001 struct gb_svc_intf_eject_request
{
1004 /* interface eject response has no payload */
1006 struct gb_svc_conn_create_request
{
1014 /* connection create response has no payload */
1016 struct gb_svc_conn_destroy_request
{
1022 /* connection destroy response has no payload */
1024 struct gb_svc_dme_peer_get_request
{
1030 struct gb_svc_dme_peer_get_response
{
1035 struct gb_svc_dme_peer_set_request
{
1042 struct gb_svc_dme_peer_set_response
{
1046 /* Greybus init-status values, currently retrieved using DME peer gets. */
1047 #define GB_INIT_SPI_BOOT_STARTED 0x02
1048 #define GB_INIT_TRUSTED_SPI_BOOT_FINISHED 0x03
1049 #define GB_INIT_UNTRUSTED_SPI_BOOT_FINISHED 0x04
1050 #define GB_INIT_BOOTROM_UNIPRO_BOOT_STARTED 0x06
1051 #define GB_INIT_BOOTROM_FALLBACK_UNIPRO_BOOT_STARTED 0x09
1052 #define GB_INIT_S2_LOADER_BOOT_STARTED 0x0D
1054 struct gb_svc_route_create_request
{
1060 /* route create response has no payload */
1062 struct gb_svc_route_destroy_request
{
1066 /* route destroy response has no payload */
1068 /* used for svc_intf_vsys_{enable,disable} */
1069 struct gb_svc_intf_vsys_request
{
1073 struct gb_svc_intf_vsys_response
{
1075 #define GB_SVC_INTF_VSYS_OK 0x00
1076 /* 0x01 is reserved */
1077 #define GB_SVC_INTF_VSYS_FAIL 0x02
1080 /* used for svc_intf_refclk_{enable,disable} */
1081 struct gb_svc_intf_refclk_request
{
1085 struct gb_svc_intf_refclk_response
{
1087 #define GB_SVC_INTF_REFCLK_OK 0x00
1088 /* 0x01 is reserved */
1089 #define GB_SVC_INTF_REFCLK_FAIL 0x02
1092 /* used for svc_intf_unipro_{enable,disable} */
1093 struct gb_svc_intf_unipro_request
{
1097 struct gb_svc_intf_unipro_response
{
1099 #define GB_SVC_INTF_UNIPRO_OK 0x00
1100 /* 0x01 is reserved */
1101 #define GB_SVC_INTF_UNIPRO_FAIL 0x02
1102 #define GB_SVC_INTF_UNIPRO_NOT_OFF 0x03
1105 #define GB_SVC_UNIPRO_FAST_MODE 0x01
1106 #define GB_SVC_UNIPRO_SLOW_MODE 0x02
1107 #define GB_SVC_UNIPRO_FAST_AUTO_MODE 0x04
1108 #define GB_SVC_UNIPRO_SLOW_AUTO_MODE 0x05
1109 #define GB_SVC_UNIPRO_MODE_UNCHANGED 0x07
1110 #define GB_SVC_UNIPRO_HIBERNATE_MODE 0x11
1111 #define GB_SVC_UNIPRO_OFF_MODE 0x12
1113 #define GB_SVC_SMALL_AMPLITUDE 0x01
1114 #define GB_SVC_LARGE_AMPLITUDE 0x02
1116 #define GB_SVC_NO_DE_EMPHASIS 0x00
1117 #define GB_SVC_SMALL_DE_EMPHASIS 0x01
1118 #define GB_SVC_LARGE_DE_EMPHASIS 0x02
1120 #define GB_SVC_PWRM_RXTERMINATION 0x01
1121 #define GB_SVC_PWRM_TXTERMINATION 0x02
1122 #define GB_SVC_PWRM_LINE_RESET 0x04
1123 #define GB_SVC_PWRM_SCRAMBLING 0x20
1125 #define GB_SVC_PWRM_QUIRK_HSSER 0x00000001
1127 #define GB_SVC_UNIPRO_HS_SERIES_A 0x01
1128 #define GB_SVC_UNIPRO_HS_SERIES_B 0x02
1130 #define GB_SVC_SETPWRM_PWR_OK 0x00
1131 #define GB_SVC_SETPWRM_PWR_LOCAL 0x01
1132 #define GB_SVC_SETPWRM_PWR_REMOTE 0x02
1133 #define GB_SVC_SETPWRM_PWR_BUSY 0x03
1134 #define GB_SVC_SETPWRM_PWR_ERROR_CAP 0x04
1135 #define GB_SVC_SETPWRM_PWR_FATAL_ERROR 0x05
1137 struct gb_svc_l2_timer_cfg
{
1138 __le16 tsb_fc0_protection_timeout
;
1139 __le16 tsb_tc0_replay_timeout
;
1140 __le16 tsb_afc0_req_timeout
;
1141 __le16 tsb_fc1_protection_timeout
;
1142 __le16 tsb_tc1_replay_timeout
;
1143 __le16 tsb_afc1_req_timeout
;
1144 __le16 reserved_for_tc2
[3];
1145 __le16 reserved_for_tc3
[3];
1148 struct gb_svc_intf_set_pwrm_request
{
1155 __u8 tx_hs_equalizer
;
1161 struct gb_svc_l2_timer_cfg local_l2timerdata
, remote_l2timerdata
;
1164 struct gb_svc_intf_set_pwrm_response
{
1168 struct gb_svc_key_event_request
{
1170 #define GB_KEYCODE_ARA 0x00
1173 #define GB_SVC_KEY_RELEASED 0x00
1174 #define GB_SVC_KEY_PRESSED 0x01
1177 #define GB_SVC_PWRMON_MAX_RAIL_COUNT 254
1179 struct gb_svc_pwrmon_rail_count_get_response
{
1183 #define GB_SVC_PWRMON_RAIL_NAME_BUFSIZE 32
1185 struct gb_svc_pwrmon_rail_names_get_response
{
1187 __u8 name
[][GB_SVC_PWRMON_RAIL_NAME_BUFSIZE
];
1190 #define GB_SVC_PWRMON_TYPE_CURR 0x01
1191 #define GB_SVC_PWRMON_TYPE_VOL 0x02
1192 #define GB_SVC_PWRMON_TYPE_PWR 0x03
1194 #define GB_SVC_PWRMON_GET_SAMPLE_OK 0x00
1195 #define GB_SVC_PWRMON_GET_SAMPLE_INVAL 0x01
1196 #define GB_SVC_PWRMON_GET_SAMPLE_NOSUPP 0x02
1197 #define GB_SVC_PWRMON_GET_SAMPLE_HWERR 0x03
1199 struct gb_svc_pwrmon_sample_get_request
{
1201 __u8 measurement_type
;
1204 struct gb_svc_pwrmon_sample_get_response
{
1209 struct gb_svc_pwrmon_intf_sample_get_request
{
1211 __u8 measurement_type
;
1214 struct gb_svc_pwrmon_intf_sample_get_response
{
1219 #define GB_SVC_MODULE_INSERTED_FLAG_NO_PRIMARY 0x0001
1221 struct gb_svc_module_inserted_request
{
1222 __u8 primary_intf_id
;
1226 /* module_inserted response has no payload */
1228 struct gb_svc_module_removed_request
{
1229 __u8 primary_intf_id
;
1231 /* module_removed response has no payload */
1233 struct gb_svc_intf_activate_request
{
1237 #define GB_SVC_INTF_TYPE_UNKNOWN 0x00
1238 #define GB_SVC_INTF_TYPE_DUMMY 0x01
1239 #define GB_SVC_INTF_TYPE_UNIPRO 0x02
1240 #define GB_SVC_INTF_TYPE_GREYBUS 0x03
1242 struct gb_svc_intf_activate_response
{
1247 struct gb_svc_intf_resume_request
{
1251 struct gb_svc_intf_resume_response
{
1255 #define GB_SVC_INTF_MAILBOX_NONE 0x00
1256 #define GB_SVC_INTF_MAILBOX_AP 0x01
1257 #define GB_SVC_INTF_MAILBOX_GREYBUS 0x02
1259 struct gb_svc_intf_mailbox_event_request
{
1264 /* intf_mailbox_event response has no payload */
1266 struct gb_svc_intf_oops_request
{
1270 /* intf_oops response has no payload */
1275 /* Greybus raw request types */
1276 #define GB_RAW_TYPE_SEND 0x02
1278 struct gb_raw_send_request
{
1286 /* Greybus UART operation types */
1287 #define GB_UART_TYPE_SEND_DATA 0x02
1288 #define GB_UART_TYPE_RECEIVE_DATA 0x03 /* Unsolicited data */
1289 #define GB_UART_TYPE_SET_LINE_CODING 0x04
1290 #define GB_UART_TYPE_SET_CONTROL_LINE_STATE 0x05
1291 #define GB_UART_TYPE_SEND_BREAK 0x06
1292 #define GB_UART_TYPE_SERIAL_STATE 0x07 /* Unsolicited data */
1293 #define GB_UART_TYPE_RECEIVE_CREDITS 0x08
1294 #define GB_UART_TYPE_FLUSH_FIFOS 0x09
1296 /* Represents data from AP -> Module */
1297 struct gb_uart_send_data_request
{
1302 /* recv-data-request flags */
1303 #define GB_UART_RECV_FLAG_FRAMING 0x01 /* Framing error */
1304 #define GB_UART_RECV_FLAG_PARITY 0x02 /* Parity error */
1305 #define GB_UART_RECV_FLAG_OVERRUN 0x04 /* Overrun error */
1306 #define GB_UART_RECV_FLAG_BREAK 0x08 /* Break */
1308 /* Represents data from Module -> AP */
1309 struct gb_uart_recv_data_request
{
1315 struct gb_uart_receive_credits_request
{
1319 struct gb_uart_set_line_coding_request
{
1322 #define GB_SERIAL_1_STOP_BITS 0
1323 #define GB_SERIAL_1_5_STOP_BITS 1
1324 #define GB_SERIAL_2_STOP_BITS 2
1327 #define GB_SERIAL_NO_PARITY 0
1328 #define GB_SERIAL_ODD_PARITY 1
1329 #define GB_SERIAL_EVEN_PARITY 2
1330 #define GB_SERIAL_MARK_PARITY 3
1331 #define GB_SERIAL_SPACE_PARITY 4
1336 #define GB_SERIAL_AUTO_RTSCTS_EN 0x1
1339 /* output control lines */
1340 #define GB_UART_CTRL_DTR 0x01
1341 #define GB_UART_CTRL_RTS 0x02
1343 struct gb_uart_set_control_line_state_request
{
1347 struct gb_uart_set_break_request
{
1351 /* input control lines and line errors */
1352 #define GB_UART_CTRL_DCD 0x01
1353 #define GB_UART_CTRL_DSR 0x02
1354 #define GB_UART_CTRL_RI 0x04
1356 struct gb_uart_serial_state_request
{
1360 struct gb_uart_serial_flush_request
{
1362 #define GB_SERIAL_FLAG_FLUSH_TRANSMITTER 0x01
1363 #define GB_SERIAL_FLAG_FLUSH_RECEIVER 0x02
1368 /* Greybus loopback request types */
1369 #define GB_LOOPBACK_TYPE_PING 0x02
1370 #define GB_LOOPBACK_TYPE_TRANSFER 0x03
1371 #define GB_LOOPBACK_TYPE_SINK 0x04
1374 * Loopback request/response header format should be identical
1375 * to simplify bandwidth and data movement analysis.
1377 struct gb_loopback_transfer_request
{
1384 struct gb_loopback_transfer_response
{
1392 /* Greybus SDIO operation types */
1393 #define GB_SDIO_TYPE_GET_CAPABILITIES 0x02
1394 #define GB_SDIO_TYPE_SET_IOS 0x03
1395 #define GB_SDIO_TYPE_COMMAND 0x04
1396 #define GB_SDIO_TYPE_TRANSFER 0x05
1397 #define GB_SDIO_TYPE_EVENT 0x06
1399 /* get caps response: request has no payload */
1400 struct gb_sdio_get_caps_response
{
1402 #define GB_SDIO_CAP_NONREMOVABLE 0x00000001
1403 #define GB_SDIO_CAP_4_BIT_DATA 0x00000002
1404 #define GB_SDIO_CAP_8_BIT_DATA 0x00000004
1405 #define GB_SDIO_CAP_MMC_HS 0x00000008
1406 #define GB_SDIO_CAP_SD_HS 0x00000010
1407 #define GB_SDIO_CAP_ERASE 0x00000020
1408 #define GB_SDIO_CAP_1_2V_DDR 0x00000040
1409 #define GB_SDIO_CAP_1_8V_DDR 0x00000080
1410 #define GB_SDIO_CAP_POWER_OFF_CARD 0x00000100
1411 #define GB_SDIO_CAP_UHS_SDR12 0x00000200
1412 #define GB_SDIO_CAP_UHS_SDR25 0x00000400
1413 #define GB_SDIO_CAP_UHS_SDR50 0x00000800
1414 #define GB_SDIO_CAP_UHS_SDR104 0x00001000
1415 #define GB_SDIO_CAP_UHS_DDR50 0x00002000
1416 #define GB_SDIO_CAP_DRIVER_TYPE_A 0x00004000
1417 #define GB_SDIO_CAP_DRIVER_TYPE_C 0x00008000
1418 #define GB_SDIO_CAP_DRIVER_TYPE_D 0x00010000
1419 #define GB_SDIO_CAP_HS200_1_2V 0x00020000
1420 #define GB_SDIO_CAP_HS200_1_8V 0x00040000
1421 #define GB_SDIO_CAP_HS400_1_2V 0x00080000
1422 #define GB_SDIO_CAP_HS400_1_8V 0x00100000
1424 /* see possible values below at vdd */
1428 __le16 max_blk_count
;
1429 __le16 max_blk_size
;
1432 /* set ios request: response has no payload */
1433 struct gb_sdio_set_ios_request
{
1436 #define GB_SDIO_VDD_165_195 0x00000001
1437 #define GB_SDIO_VDD_20_21 0x00000002
1438 #define GB_SDIO_VDD_21_22 0x00000004
1439 #define GB_SDIO_VDD_22_23 0x00000008
1440 #define GB_SDIO_VDD_23_24 0x00000010
1441 #define GB_SDIO_VDD_24_25 0x00000020
1442 #define GB_SDIO_VDD_25_26 0x00000040
1443 #define GB_SDIO_VDD_26_27 0x00000080
1444 #define GB_SDIO_VDD_27_28 0x00000100
1445 #define GB_SDIO_VDD_28_29 0x00000200
1446 #define GB_SDIO_VDD_29_30 0x00000400
1447 #define GB_SDIO_VDD_30_31 0x00000800
1448 #define GB_SDIO_VDD_31_32 0x00001000
1449 #define GB_SDIO_VDD_32_33 0x00002000
1450 #define GB_SDIO_VDD_33_34 0x00004000
1451 #define GB_SDIO_VDD_34_35 0x00008000
1452 #define GB_SDIO_VDD_35_36 0x00010000
1455 #define GB_SDIO_BUSMODE_OPENDRAIN 0x00
1456 #define GB_SDIO_BUSMODE_PUSHPULL 0x01
1459 #define GB_SDIO_POWER_OFF 0x00
1460 #define GB_SDIO_POWER_UP 0x01
1461 #define GB_SDIO_POWER_ON 0x02
1462 #define GB_SDIO_POWER_UNDEFINED 0x03
1465 #define GB_SDIO_BUS_WIDTH_1 0x00
1466 #define GB_SDIO_BUS_WIDTH_4 0x02
1467 #define GB_SDIO_BUS_WIDTH_8 0x03
1470 #define GB_SDIO_TIMING_LEGACY 0x00
1471 #define GB_SDIO_TIMING_MMC_HS 0x01
1472 #define GB_SDIO_TIMING_SD_HS 0x02
1473 #define GB_SDIO_TIMING_UHS_SDR12 0x03
1474 #define GB_SDIO_TIMING_UHS_SDR25 0x04
1475 #define GB_SDIO_TIMING_UHS_SDR50 0x05
1476 #define GB_SDIO_TIMING_UHS_SDR104 0x06
1477 #define GB_SDIO_TIMING_UHS_DDR50 0x07
1478 #define GB_SDIO_TIMING_MMC_DDR52 0x08
1479 #define GB_SDIO_TIMING_MMC_HS200 0x09
1480 #define GB_SDIO_TIMING_MMC_HS400 0x0A
1482 __u8 signal_voltage
;
1483 #define GB_SDIO_SIGNAL_VOLTAGE_330 0x00
1484 #define GB_SDIO_SIGNAL_VOLTAGE_180 0x01
1485 #define GB_SDIO_SIGNAL_VOLTAGE_120 0x02
1488 #define GB_SDIO_SET_DRIVER_TYPE_B 0x00
1489 #define GB_SDIO_SET_DRIVER_TYPE_A 0x01
1490 #define GB_SDIO_SET_DRIVER_TYPE_C 0x02
1491 #define GB_SDIO_SET_DRIVER_TYPE_D 0x03
1494 /* command request */
1495 struct gb_sdio_command_request
{
1498 #define GB_SDIO_RSP_NONE 0x00
1499 #define GB_SDIO_RSP_PRESENT 0x01
1500 #define GB_SDIO_RSP_136 0x02
1501 #define GB_SDIO_RSP_CRC 0x04
1502 #define GB_SDIO_RSP_BUSY 0x08
1503 #define GB_SDIO_RSP_OPCODE 0x10
1506 #define GB_SDIO_CMD_AC 0x00
1507 #define GB_SDIO_CMD_ADTC 0x01
1508 #define GB_SDIO_CMD_BC 0x02
1509 #define GB_SDIO_CMD_BCR 0x03
1516 struct gb_sdio_command_response
{
1520 /* transfer request */
1521 struct gb_sdio_transfer_request
{
1523 #define GB_SDIO_DATA_WRITE 0x01
1524 #define GB_SDIO_DATA_READ 0x02
1525 #define GB_SDIO_DATA_STREAM 0x04
1532 struct gb_sdio_transfer_response
{
1538 /* event request: generated by module and is defined as unidirectional */
1539 struct gb_sdio_event_request
{
1541 #define GB_SDIO_CARD_INSERTED 0x01
1542 #define GB_SDIO_CARD_REMOVED 0x02
1543 #define GB_SDIO_WP 0x04
1548 /* Greybus Camera request types */
1549 #define GB_CAMERA_TYPE_CAPABILITIES 0x02
1550 #define GB_CAMERA_TYPE_CONFIGURE_STREAMS 0x03
1551 #define GB_CAMERA_TYPE_CAPTURE 0x04
1552 #define GB_CAMERA_TYPE_FLUSH 0x05
1553 #define GB_CAMERA_TYPE_METADATA 0x06
1555 #define GB_CAMERA_MAX_STREAMS 4
1556 #define GB_CAMERA_MAX_SETTINGS_SIZE 8192
1558 /* Greybus Camera Configure Streams request payload */
1559 struct gb_camera_stream_config_request
{
1566 struct gb_camera_configure_streams_request
{
1569 #define GB_CAMERA_CONFIGURE_STREAMS_TEST_ONLY 0x01
1571 struct gb_camera_stream_config_request config
[];
1574 /* Greybus Camera Configure Streams response payload */
1575 struct gb_camera_stream_config_response
{
1579 __u8 virtual_channel
;
1581 __le16 max_pkt_size
;
1586 struct gb_camera_configure_streams_response
{
1588 #define GB_CAMERA_CONFIGURE_STREAMS_ADJUSTED 0x01
1592 struct gb_camera_stream_config_response config
[];
1595 /* Greybus Camera Capture request payload - response has no payload */
1596 struct gb_camera_capture_request
{
1604 /* Greybus Camera Flush response payload - request has no payload */
1605 struct gb_camera_flush_response
{
1609 /* Greybus Camera Metadata request payload - operation has no response */
1610 struct gb_camera_metadata_request
{
1612 __le16 frame_number
;
1620 /* Greybus Lights request types */
1621 #define GB_LIGHTS_TYPE_GET_LIGHTS 0x02
1622 #define GB_LIGHTS_TYPE_GET_LIGHT_CONFIG 0x03
1623 #define GB_LIGHTS_TYPE_GET_CHANNEL_CONFIG 0x04
1624 #define GB_LIGHTS_TYPE_GET_CHANNEL_FLASH_CONFIG 0x05
1625 #define GB_LIGHTS_TYPE_SET_BRIGHTNESS 0x06
1626 #define GB_LIGHTS_TYPE_SET_BLINK 0x07
1627 #define GB_LIGHTS_TYPE_SET_COLOR 0x08
1628 #define GB_LIGHTS_TYPE_SET_FADE 0x09
1629 #define GB_LIGHTS_TYPE_EVENT 0x0A
1630 #define GB_LIGHTS_TYPE_SET_FLASH_INTENSITY 0x0B
1631 #define GB_LIGHTS_TYPE_SET_FLASH_STROBE 0x0C
1632 #define GB_LIGHTS_TYPE_SET_FLASH_TIMEOUT 0x0D
1633 #define GB_LIGHTS_TYPE_GET_FLASH_FAULT 0x0E
1635 /* Greybus Light modes */
1638 * if you add any specific mode below, update also the
1639 * GB_CHANNEL_MODE_DEFINED_RANGE value accordingly
1641 #define GB_CHANNEL_MODE_NONE 0x00000000
1642 #define GB_CHANNEL_MODE_BATTERY 0x00000001
1643 #define GB_CHANNEL_MODE_POWER 0x00000002
1644 #define GB_CHANNEL_MODE_WIRELESS 0x00000004
1645 #define GB_CHANNEL_MODE_BLUETOOTH 0x00000008
1646 #define GB_CHANNEL_MODE_KEYBOARD 0x00000010
1647 #define GB_CHANNEL_MODE_BUTTONS 0x00000020
1648 #define GB_CHANNEL_MODE_NOTIFICATION 0x00000040
1649 #define GB_CHANNEL_MODE_ATTENTION 0x00000080
1650 #define GB_CHANNEL_MODE_FLASH 0x00000100
1651 #define GB_CHANNEL_MODE_TORCH 0x00000200
1652 #define GB_CHANNEL_MODE_INDICATOR 0x00000400
1654 /* Lights Mode valid bit values */
1655 #define GB_CHANNEL_MODE_DEFINED_RANGE 0x000004FF
1656 #define GB_CHANNEL_MODE_VENDOR_RANGE 0x00F00000
1658 /* Greybus Light Channels Flags */
1659 #define GB_LIGHT_CHANNEL_MULTICOLOR 0x00000001
1660 #define GB_LIGHT_CHANNEL_FADER 0x00000002
1661 #define GB_LIGHT_CHANNEL_BLINK 0x00000004
1663 /* get count of lights in module */
1664 struct gb_lights_get_lights_response
{
1668 /* light config request payload */
1669 struct gb_lights_get_light_config_request
{
1673 /* light config response payload */
1674 struct gb_lights_get_light_config_response
{
1679 /* channel config request payload */
1680 struct gb_lights_get_channel_config_request
{
1685 /* channel flash config request payload */
1686 struct gb_lights_get_channel_flash_config_request
{
1691 /* channel config response payload */
1692 struct gb_lights_get_channel_config_response
{
1693 __u8 max_brightness
;
1696 __u8 color_name
[32];
1701 /* channel flash config response payload */
1702 struct gb_lights_get_channel_flash_config_response
{
1703 __le32 intensity_min_uA
;
1704 __le32 intensity_max_uA
;
1705 __le32 intensity_step_uA
;
1706 __le32 timeout_min_us
;
1707 __le32 timeout_max_us
;
1708 __le32 timeout_step_us
;
1711 /* blink request payload: response have no payload */
1712 struct gb_lights_blink_request
{
1719 /* set brightness request payload: response have no payload */
1720 struct gb_lights_set_brightness_request
{
1726 /* set color request payload: response have no payload */
1727 struct gb_lights_set_color_request
{
1733 /* set fade request payload: response have no payload */
1734 struct gb_lights_set_fade_request
{
1741 /* event request: generated by module */
1742 struct gb_lights_event_request
{
1745 #define GB_LIGHTS_LIGHT_CONFIG 0x01
1748 /* set flash intensity request payload: response have no payload */
1749 struct gb_lights_set_flash_intensity_request
{
1752 __le32 intensity_uA
;
1755 /* set flash strobe state request payload: response have no payload */
1756 struct gb_lights_set_flash_strobe_request
{
1762 /* set flash timeout request payload: response have no payload */
1763 struct gb_lights_set_flash_timeout_request
{
1769 /* get flash fault request payload */
1770 struct gb_lights_get_flash_fault_request
{
1775 /* get flash fault response payload */
1776 struct gb_lights_get_flash_fault_response
{
1778 #define GB_LIGHTS_FLASH_FAULT_OVER_VOLTAGE 0x00000000
1779 #define GB_LIGHTS_FLASH_FAULT_TIMEOUT 0x00000001
1780 #define GB_LIGHTS_FLASH_FAULT_OVER_TEMPERATURE 0x00000002
1781 #define GB_LIGHTS_FLASH_FAULT_SHORT_CIRCUIT 0x00000004
1782 #define GB_LIGHTS_FLASH_FAULT_OVER_CURRENT 0x00000008
1783 #define GB_LIGHTS_FLASH_FAULT_INDICATOR 0x00000010
1784 #define GB_LIGHTS_FLASH_FAULT_UNDER_VOLTAGE 0x00000020
1785 #define GB_LIGHTS_FLASH_FAULT_INPUT_VOLTAGE 0x00000040
1786 #define GB_LIGHTS_FLASH_FAULT_LED_OVER_TEMPERATURE 0x00000080
1791 #define GB_AUDIO_TYPE_GET_TOPOLOGY_SIZE 0x02
1792 #define GB_AUDIO_TYPE_GET_TOPOLOGY 0x03
1793 #define GB_AUDIO_TYPE_GET_CONTROL 0x04
1794 #define GB_AUDIO_TYPE_SET_CONTROL 0x05
1795 #define GB_AUDIO_TYPE_ENABLE_WIDGET 0x06
1796 #define GB_AUDIO_TYPE_DISABLE_WIDGET 0x07
1797 #define GB_AUDIO_TYPE_GET_PCM 0x08
1798 #define GB_AUDIO_TYPE_SET_PCM 0x09
1799 #define GB_AUDIO_TYPE_SET_TX_DATA_SIZE 0x0a
1801 #define GB_AUDIO_TYPE_ACTIVATE_TX 0x0c
1802 #define GB_AUDIO_TYPE_DEACTIVATE_TX 0x0d
1803 #define GB_AUDIO_TYPE_SET_RX_DATA_SIZE 0x0e
1805 #define GB_AUDIO_TYPE_ACTIVATE_RX 0x10
1806 #define GB_AUDIO_TYPE_DEACTIVATE_RX 0x11
1807 #define GB_AUDIO_TYPE_JACK_EVENT 0x12
1808 #define GB_AUDIO_TYPE_BUTTON_EVENT 0x13
1809 #define GB_AUDIO_TYPE_STREAMING_EVENT 0x14
1810 #define GB_AUDIO_TYPE_SEND_DATA 0x15
1812 /* Module must be able to buffer 10ms of audio data, minimum */
1813 #define GB_AUDIO_SAMPLE_BUFFER_MIN_US 10000
1815 #define GB_AUDIO_PCM_NAME_MAX 32
1816 #define AUDIO_DAI_NAME_MAX 32
1817 #define AUDIO_CONTROL_NAME_MAX 32
1818 #define AUDIO_CTL_ELEM_NAME_MAX 44
1819 #define AUDIO_ENUM_NAME_MAX 64
1820 #define AUDIO_WIDGET_NAME_MAX 32
1822 /* See SNDRV_PCM_FMTBIT_* in Linux source */
1823 #define GB_AUDIO_PCM_FMT_S8 BIT(0)
1824 #define GB_AUDIO_PCM_FMT_U8 BIT(1)
1825 #define GB_AUDIO_PCM_FMT_S16_LE BIT(2)
1826 #define GB_AUDIO_PCM_FMT_S16_BE BIT(3)
1827 #define GB_AUDIO_PCM_FMT_U16_LE BIT(4)
1828 #define GB_AUDIO_PCM_FMT_U16_BE BIT(5)
1829 #define GB_AUDIO_PCM_FMT_S24_LE BIT(6)
1830 #define GB_AUDIO_PCM_FMT_S24_BE BIT(7)
1831 #define GB_AUDIO_PCM_FMT_U24_LE BIT(8)
1832 #define GB_AUDIO_PCM_FMT_U24_BE BIT(9)
1833 #define GB_AUDIO_PCM_FMT_S32_LE BIT(10)
1834 #define GB_AUDIO_PCM_FMT_S32_BE BIT(11)
1835 #define GB_AUDIO_PCM_FMT_U32_LE BIT(12)
1836 #define GB_AUDIO_PCM_FMT_U32_BE BIT(13)
1838 /* See SNDRV_PCM_RATE_* in Linux source */
1839 #define GB_AUDIO_PCM_RATE_5512 BIT(0)
1840 #define GB_AUDIO_PCM_RATE_8000 BIT(1)
1841 #define GB_AUDIO_PCM_RATE_11025 BIT(2)
1842 #define GB_AUDIO_PCM_RATE_16000 BIT(3)
1843 #define GB_AUDIO_PCM_RATE_22050 BIT(4)
1844 #define GB_AUDIO_PCM_RATE_32000 BIT(5)
1845 #define GB_AUDIO_PCM_RATE_44100 BIT(6)
1846 #define GB_AUDIO_PCM_RATE_48000 BIT(7)
1847 #define GB_AUDIO_PCM_RATE_64000 BIT(8)
1848 #define GB_AUDIO_PCM_RATE_88200 BIT(9)
1849 #define GB_AUDIO_PCM_RATE_96000 BIT(10)
1850 #define GB_AUDIO_PCM_RATE_176400 BIT(11)
1851 #define GB_AUDIO_PCM_RATE_192000 BIT(12)
1853 #define GB_AUDIO_STREAM_TYPE_CAPTURE 0x1
1854 #define GB_AUDIO_STREAM_TYPE_PLAYBACK 0x2
1856 #define GB_AUDIO_CTL_ELEM_ACCESS_READ BIT(0)
1857 #define GB_AUDIO_CTL_ELEM_ACCESS_WRITE BIT(1)
1859 /* See SNDRV_CTL_ELEM_TYPE_* in Linux source */
1860 #define GB_AUDIO_CTL_ELEM_TYPE_BOOLEAN 0x01
1861 #define GB_AUDIO_CTL_ELEM_TYPE_INTEGER 0x02
1862 #define GB_AUDIO_CTL_ELEM_TYPE_ENUMERATED 0x03
1863 #define GB_AUDIO_CTL_ELEM_TYPE_INTEGER64 0x06
1865 /* See SNDRV_CTL_ELEM_IFACE_* in Linux source */
1866 #define GB_AUDIO_CTL_ELEM_IFACE_CARD 0x00
1867 #define GB_AUDIO_CTL_ELEM_IFACE_HWDEP 0x01
1868 #define GB_AUDIO_CTL_ELEM_IFACE_MIXER 0x02
1869 #define GB_AUDIO_CTL_ELEM_IFACE_PCM 0x03
1870 #define GB_AUDIO_CTL_ELEM_IFACE_RAWMIDI 0x04
1871 #define GB_AUDIO_CTL_ELEM_IFACE_TIMER 0x05
1872 #define GB_AUDIO_CTL_ELEM_IFACE_SEQUENCER 0x06
1874 /* SNDRV_CTL_ELEM_ACCESS_* in Linux source */
1875 #define GB_AUDIO_ACCESS_READ BIT(0)
1876 #define GB_AUDIO_ACCESS_WRITE BIT(1)
1877 #define GB_AUDIO_ACCESS_VOLATILE BIT(2)
1878 #define GB_AUDIO_ACCESS_TIMESTAMP BIT(3)
1879 #define GB_AUDIO_ACCESS_TLV_READ BIT(4)
1880 #define GB_AUDIO_ACCESS_TLV_WRITE BIT(5)
1881 #define GB_AUDIO_ACCESS_TLV_COMMAND BIT(6)
1882 #define GB_AUDIO_ACCESS_INACTIVE BIT(7)
1883 #define GB_AUDIO_ACCESS_LOCK BIT(8)
1884 #define GB_AUDIO_ACCESS_OWNER BIT(9)
1886 /* enum snd_soc_dapm_type */
1887 #define GB_AUDIO_WIDGET_TYPE_INPUT 0x0
1888 #define GB_AUDIO_WIDGET_TYPE_OUTPUT 0x1
1889 #define GB_AUDIO_WIDGET_TYPE_MUX 0x2
1890 #define GB_AUDIO_WIDGET_TYPE_VIRT_MUX 0x3
1891 #define GB_AUDIO_WIDGET_TYPE_VALUE_MUX 0x4
1892 #define GB_AUDIO_WIDGET_TYPE_MIXER 0x5
1893 #define GB_AUDIO_WIDGET_TYPE_MIXER_NAMED_CTL 0x6
1894 #define GB_AUDIO_WIDGET_TYPE_PGA 0x7
1895 #define GB_AUDIO_WIDGET_TYPE_OUT_DRV 0x8
1896 #define GB_AUDIO_WIDGET_TYPE_ADC 0x9
1897 #define GB_AUDIO_WIDGET_TYPE_DAC 0xa
1898 #define GB_AUDIO_WIDGET_TYPE_MICBIAS 0xb
1899 #define GB_AUDIO_WIDGET_TYPE_MIC 0xc
1900 #define GB_AUDIO_WIDGET_TYPE_HP 0xd
1901 #define GB_AUDIO_WIDGET_TYPE_SPK 0xe
1902 #define GB_AUDIO_WIDGET_TYPE_LINE 0xf
1903 #define GB_AUDIO_WIDGET_TYPE_SWITCH 0x10
1904 #define GB_AUDIO_WIDGET_TYPE_VMID 0x11
1905 #define GB_AUDIO_WIDGET_TYPE_PRE 0x12
1906 #define GB_AUDIO_WIDGET_TYPE_POST 0x13
1907 #define GB_AUDIO_WIDGET_TYPE_SUPPLY 0x14
1908 #define GB_AUDIO_WIDGET_TYPE_REGULATOR_SUPPLY 0x15
1909 #define GB_AUDIO_WIDGET_TYPE_CLOCK_SUPPLY 0x16
1910 #define GB_AUDIO_WIDGET_TYPE_AIF_IN 0x17
1911 #define GB_AUDIO_WIDGET_TYPE_AIF_OUT 0x18
1912 #define GB_AUDIO_WIDGET_TYPE_SIGGEN 0x19
1913 #define GB_AUDIO_WIDGET_TYPE_DAI_IN 0x1a
1914 #define GB_AUDIO_WIDGET_TYPE_DAI_OUT 0x1b
1915 #define GB_AUDIO_WIDGET_TYPE_DAI_LINK 0x1c
1917 #define GB_AUDIO_WIDGET_STATE_DISABLED 0x01
1918 #define GB_AUDIO_WIDGET_STATE_ENAABLED 0x02
1920 #define GB_AUDIO_JACK_EVENT_INSERTION 0x1
1921 #define GB_AUDIO_JACK_EVENT_REMOVAL 0x2
1923 #define GB_AUDIO_BUTTON_EVENT_PRESS 0x1
1924 #define GB_AUDIO_BUTTON_EVENT_RELEASE 0x2
1926 #define GB_AUDIO_STREAMING_EVENT_UNSPECIFIED 0x1
1927 #define GB_AUDIO_STREAMING_EVENT_HALT 0x2
1928 #define GB_AUDIO_STREAMING_EVENT_INTERNAL_ERROR 0x3
1929 #define GB_AUDIO_STREAMING_EVENT_PROTOCOL_ERROR 0x4
1930 #define GB_AUDIO_STREAMING_EVENT_FAILURE 0x5
1931 #define GB_AUDIO_STREAMING_EVENT_UNDERRUN 0x6
1932 #define GB_AUDIO_STREAMING_EVENT_OVERRUN 0x7
1933 #define GB_AUDIO_STREAMING_EVENT_CLOCKING 0x8
1934 #define GB_AUDIO_STREAMING_EVENT_DATA_LEN 0x9
1936 #define GB_AUDIO_INVALID_INDEX 0xff
1938 /* enum snd_jack_types */
1939 #define GB_AUDIO_JACK_HEADPHONE 0x0000001
1940 #define GB_AUDIO_JACK_MICROPHONE 0x0000002
1941 #define GB_AUDIO_JACK_HEADSET (GB_AUDIO_JACK_HEADPHONE | \
1942 GB_AUDIO_JACK_MICROPHONE)
1943 #define GB_AUDIO_JACK_LINEOUT 0x0000004
1944 #define GB_AUDIO_JACK_MECHANICAL 0x0000008
1945 #define GB_AUDIO_JACK_VIDEOOUT 0x0000010
1946 #define GB_AUDIO_JACK_AVOUT (GB_AUDIO_JACK_LINEOUT | \
1947 GB_AUDIO_JACK_VIDEOOUT)
1948 #define GB_AUDIO_JACK_LINEIN 0x0000020
1949 #define GB_AUDIO_JACK_OC_HPHL 0x0000040
1950 #define GB_AUDIO_JACK_OC_HPHR 0x0000080
1951 #define GB_AUDIO_JACK_MICROPHONE2 0x0000200
1952 #define GB_AUDIO_JACK_ANC_HEADPHONE (GB_AUDIO_JACK_HEADPHONE | \
1953 GB_AUDIO_JACK_MICROPHONE | \
1954 GB_AUDIO_JACK_MICROPHONE2)
1955 /* Kept separate from switches to facilitate implementation */
1956 #define GB_AUDIO_JACK_BTN_0 0x4000000
1957 #define GB_AUDIO_JACK_BTN_1 0x2000000
1958 #define GB_AUDIO_JACK_BTN_2 0x1000000
1959 #define GB_AUDIO_JACK_BTN_3 0x0800000
1961 struct gb_audio_pcm
{
1962 __u8 stream_name
[GB_AUDIO_PCM_NAME_MAX
];
1963 __le32 formats
; /* GB_AUDIO_PCM_FMT_* */
1964 __le32 rates
; /* GB_AUDIO_PCM_RATE_* */
1967 __u8 sig_bits
; /* number of bits of content */
1970 struct gb_audio_dai
{
1971 __u8 name
[AUDIO_DAI_NAME_MAX
];
1973 struct gb_audio_pcm capture
;
1974 struct gb_audio_pcm playback
;
1977 struct gb_audio_integer
{
1983 struct gb_audio_integer64
{
1989 struct gb_audio_enumerated
{
1991 __le16 names_length
;
1995 struct gb_audio_ctl_elem_info
{ /* See snd_ctl_elem_info in Linux source */
1996 __u8 type
; /* GB_AUDIO_CTL_ELEM_TYPE_* */
1999 struct gb_audio_integer integer
;
2000 struct gb_audio_integer64 integer64
;
2001 struct gb_audio_enumerated enumerated
;
2005 struct gb_audio_ctl_elem_value
{ /* See snd_ctl_elem_value in Linux source */
2006 __le64 timestamp
; /* XXX needed? */
2008 __le32 integer_value
[2]; /* consider CTL_DOUBLE_xxx */
2009 __le64 integer64_value
[2];
2010 __le32 enumerated_item
[2];
2014 struct gb_audio_control
{
2015 __u8 name
[AUDIO_CONTROL_NAME_MAX
];
2017 __u8 iface
; /* GB_AUDIO_IFACE_* */
2019 __le32 access
; /* GB_AUDIO_ACCESS_* */
2020 __u8 count
; /* count of same elements */
2021 __u8 count_values
; /* count of values, max=2 for CTL_DOUBLE_xxx */
2022 struct gb_audio_ctl_elem_info info
;
2025 struct gb_audio_widget
{
2026 __u8 name
[AUDIO_WIDGET_NAME_MAX
];
2027 __u8 sname
[AUDIO_WIDGET_NAME_MAX
];
2029 __u8 type
; /* GB_AUDIO_WIDGET_TYPE_* */
2030 __u8 state
; /* GB_AUDIO_WIDGET_STATE_* */
2032 struct gb_audio_control ctl
[]; /* 'ncontrols' entries */
2035 struct gb_audio_route
{
2036 __u8 source_id
; /* widget id */
2037 __u8 destination_id
; /* widget id */
2038 __u8 control_id
; /* 0-63 */
2039 __u8 index
; /* Selection within the control */
2042 struct gb_audio_topology
{
2048 __le32 size_controls
;
2049 __le32 size_widgets
;
2053 * struct gb_audio_dai dai[num_dais];
2054 * struct gb_audio_control controls[num_controls];
2055 * struct gb_audio_widget widgets[num_widgets];
2056 * struct gb_audio_route routes[num_routes];
2061 struct gb_audio_get_topology_size_response
{
2065 struct gb_audio_get_topology_response
{
2066 struct gb_audio_topology topology
;
2069 struct gb_audio_get_control_request
{
2074 struct gb_audio_get_control_response
{
2075 struct gb_audio_ctl_elem_value value
;
2078 struct gb_audio_set_control_request
{
2081 struct gb_audio_ctl_elem_value value
;
2084 struct gb_audio_enable_widget_request
{
2088 struct gb_audio_disable_widget_request
{
2092 struct gb_audio_get_pcm_request
{
2096 struct gb_audio_get_pcm_response
{
2103 struct gb_audio_set_pcm_request
{
2111 struct gb_audio_set_tx_data_size_request
{
2116 struct gb_audio_activate_tx_request
{
2120 struct gb_audio_deactivate_tx_request
{
2124 struct gb_audio_set_rx_data_size_request
{
2129 struct gb_audio_activate_rx_request
{
2133 struct gb_audio_deactivate_rx_request
{
2137 struct gb_audio_jack_event_request
{
2139 __u8 jack_attribute
;
2143 struct gb_audio_button_event_request
{
2149 struct gb_audio_streaming_event_request
{
2154 struct gb_audio_send_data_request
{
2163 #define GB_LOG_TYPE_SEND_LOG 0x02
2166 #define GB_LOG_MAX_LEN 1024
2168 struct gb_log_send_log_request
{
2173 #endif /* __GREYBUS_PROTOCOLS_H */