2 * This file is provided under a dual BSD/GPLv2 license. When using or
3 * redistributing this file, you may do so under either license.
7 * Copyright(c) 2014 - 2015 Google Inc. All rights reserved.
8 * Copyright(c) 2014 - 2015 Linaro Ltd. All rights reserved.
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of version 2 of the GNU General Public License as
12 * published by the Free Software Foundation.
14 * This program is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * General Public License version 2 for more details.
21 * Copyright(c) 2014 - 2015 Google Inc. All rights reserved.
22 * Copyright(c) 2014 - 2015 Linaro Ltd. All rights reserved.
24 * Redistribution and use in source and binary forms, with or without
25 * modification, are permitted provided that the following conditions
28 * * Redistributions of source code must retain the above copyright
29 * notice, this list of conditions and the following disclaimer.
30 * * Redistributions in binary form must reproduce the above copyright
31 * notice, this list of conditions and the following disclaimer in
32 * the documentation and/or other materials provided with the
34 * * Neither the name of Google Inc. or Linaro Ltd. nor the names of
35 * its contributors may be used to endorse or promote products
36 * derived from this software without specific prior written
39 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
40 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
41 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
42 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GOOGLE INC. OR
43 * LINARO LTD. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
44 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
45 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
46 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
47 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
48 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
49 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
52 #ifndef __GREYBUS_PROTOCOLS_H
53 #define __GREYBUS_PROTOCOLS_H
55 /* Fixed IDs for control/svc protocols */
57 /* SVC switch-port device ids */
58 #define GB_SVC_DEVICE_ID_SVC 0
59 #define GB_SVC_DEVICE_ID_AP 1
60 #define GB_SVC_DEVICE_ID_MIN 2
61 #define GB_SVC_DEVICE_ID_MAX 31
63 #define GB_SVC_CPORT_ID 0
64 #define GB_CONTROL_BUNDLE_ID 0
65 #define GB_CONTROL_CPORT_ID 0
69 * All operation messages (both requests and responses) begin with
70 * a header that encodes the size of the message (header included).
71 * This header also contains a unique identifier, that associates a
72 * response message with its operation. The header contains an
73 * operation type field, whose interpretation is dependent on what
74 * type of protocol is used over the connection. The high bit
75 * (0x80) of the operation type field is used to indicate whether
76 * the message is a request (clear) or a response (set).
78 * Response messages include an additional result byte, which
79 * communicates the result of the corresponding request. A zero
80 * result value means the operation completed successfully. Any
81 * other value indicates an error; in this case, the payload of the
82 * response message (if any) is ignored. The result byte must be
83 * zero in the header for a request message.
85 * The wire format for all numeric fields in the header is little
86 * endian. Any operation-specific data begins immediately after the
89 struct gb_operation_msg_hdr {
90 __le16 size; /* Size in bytes of header + payload */
91 __le16 operation_id; /* Operation unique id */
92 __u8 type; /* E.g GB_I2C_TYPE_* or GB_GPIO_TYPE_* */
93 __u8 result; /* Result of request (in responses only) */
94 __u8 pad[2]; /* must be zero (ignore when read) */
98 /* Generic request types */
99 #define GB_REQUEST_TYPE_CPORT_SHUTDOWN 0x00
100 #define GB_REQUEST_TYPE_INVALID 0x7f
102 struct gb_cport_shutdown_request {
107 /* Control Protocol */
109 /* Greybus control request types */
110 #define GB_CONTROL_TYPE_VERSION 0x01
111 #define GB_CONTROL_TYPE_PROBE_AP 0x02
112 #define GB_CONTROL_TYPE_GET_MANIFEST_SIZE 0x03
113 #define GB_CONTROL_TYPE_GET_MANIFEST 0x04
114 #define GB_CONTROL_TYPE_CONNECTED 0x05
115 #define GB_CONTROL_TYPE_DISCONNECTED 0x06
116 #define GB_CONTROL_TYPE_TIMESYNC_ENABLE 0x07
117 #define GB_CONTROL_TYPE_TIMESYNC_DISABLE 0x08
118 #define GB_CONTROL_TYPE_TIMESYNC_AUTHORITATIVE 0x09
120 #define GB_CONTROL_TYPE_BUNDLE_VERSION 0x0b
121 #define GB_CONTROL_TYPE_DISCONNECTING 0x0c
122 #define GB_CONTROL_TYPE_TIMESYNC_GET_LAST_EVENT 0x0d
123 #define GB_CONTROL_TYPE_MODE_SWITCH 0x0e
124 #define GB_CONTROL_TYPE_BUNDLE_SUSPEND 0x0f
125 #define GB_CONTROL_TYPE_BUNDLE_RESUME 0x10
126 #define GB_CONTROL_TYPE_BUNDLE_DEACTIVATE 0x11
127 #define GB_CONTROL_TYPE_BUNDLE_ACTIVATE 0x12
128 #define GB_CONTROL_TYPE_INTF_SUSPEND_PREPARE 0x13
129 #define GB_CONTROL_TYPE_INTF_DEACTIVATE_PREPARE 0x14
130 #define GB_CONTROL_TYPE_INTF_HIBERNATE_ABORT 0x15
132 struct gb_control_version_request {
137 struct gb_control_version_response {
142 struct gb_control_bundle_version_request {
146 struct gb_control_bundle_version_response {
151 /* Control protocol manifest get size request has no payload*/
152 struct gb_control_get_manifest_size_response {
156 /* Control protocol manifest get request has no payload */
157 struct gb_control_get_manifest_response {
161 /* Control protocol [dis]connected request */
162 struct gb_control_connected_request {
166 struct gb_control_disconnecting_request {
169 /* disconnecting response has no payload */
171 struct gb_control_disconnected_request {
174 /* Control protocol [dis]connected response has no payload */
176 #define GB_TIMESYNC_MAX_STROBES 0x04
178 struct gb_control_timesync_enable_request {
184 /* timesync enable response has no payload */
186 struct gb_control_timesync_authoritative_request {
187 __le64 frame_time[GB_TIMESYNC_MAX_STROBES];
189 /* timesync authoritative response has no payload */
191 /* timesync get_last_event_request has no payload */
192 struct gb_control_timesync_get_last_event_response {
197 * All Bundle power management operations use the same request and response
198 * layout and status codes.
201 #define GB_CONTROL_BUNDLE_PM_OK 0x00
202 #define GB_CONTROL_BUNDLE_PM_INVAL 0x01
203 #define GB_CONTROL_BUNDLE_PM_BUSY 0x02
204 #define GB_CONTROL_BUNDLE_PM_FAIL 0x03
205 #define GB_CONTROL_BUNDLE_PM_NA 0x04
207 struct gb_control_bundle_pm_request {
211 struct gb_control_bundle_pm_response {
216 * Interface Suspend Prepare and Deactivate Prepare operations use the same
217 * response layout and error codes. Define a single response structure and reuse
218 * it. Both operations have no payload.
221 #define GB_CONTROL_INTF_PM_OK 0x00
222 #define GB_CONTROL_INTF_PM_BUSY 0x01
223 #define GB_CONTROL_INTF_PM_NA 0x02
225 struct gb_control_intf_pm_response {
229 /* APBridge protocol */
231 /* request APB1 log */
232 #define GB_APB_REQUEST_LOG 0x02
234 /* request to map a cport to bulk in and bulk out endpoints */
235 #define GB_APB_REQUEST_EP_MAPPING 0x03
237 /* request to get the number of cports available */
238 #define GB_APB_REQUEST_CPORT_COUNT 0x04
240 /* request to reset a cport state */
241 #define GB_APB_REQUEST_RESET_CPORT 0x05
243 /* request to time the latency of messages on a given cport */
244 #define GB_APB_REQUEST_LATENCY_TAG_EN 0x06
245 #define GB_APB_REQUEST_LATENCY_TAG_DIS 0x07
247 /* request to control the CSI transmitter */
248 #define GB_APB_REQUEST_CSI_TX_CONTROL 0x08
250 /* request to control audio streaming */
251 #define GB_APB_REQUEST_AUDIO_CONTROL 0x09
253 /* vendor requests to enable/disable CPort features */
254 #define GB_APB_REQUEST_CPORT_FEAT_EN 0x0b
255 #define GB_APB_REQUEST_CPORT_FEAT_DIS 0x0c
257 /* TimeSync requests */
258 #define GB_APB_REQUEST_TIMESYNC_ENABLE 0x0d
259 #define GB_APB_REQUEST_TIMESYNC_DISABLE 0x0e
260 #define GB_APB_REQUEST_TIMESYNC_AUTHORITATIVE 0x0f
261 #define GB_APB_REQUEST_TIMESYNC_GET_LAST_EVENT 0x10
263 /* requests to set Greybus CPort flags */
264 #define GB_APB_REQUEST_CPORT_FLAGS 0x11
267 #define GB_APB_REQUEST_ARPC_RUN 0x12
269 struct gb_apb_request_cport_flags {
271 #define GB_APB_CPORT_FLAG_CONTROL 0x01
272 #define GB_APB_CPORT_FLAG_HIGH_PRIO 0x02
276 /* Firmware Download Protocol */
279 #define GB_FW_DOWNLOAD_TYPE_FIND_FIRMWARE 0x01
280 #define GB_FW_DOWNLOAD_TYPE_FETCH_FIRMWARE 0x02
281 #define GB_FW_DOWNLOAD_TYPE_RELEASE_FIRMWARE 0x03
283 #define GB_FIRMWARE_TAG_MAX_SIZE 10
285 /* firmware download find firmware request/response */
286 struct gb_fw_download_find_firmware_request {
287 __u8 firmware_tag[GB_FIRMWARE_TAG_MAX_SIZE];
290 struct gb_fw_download_find_firmware_response {
295 /* firmware download fetch firmware request/response */
296 struct gb_fw_download_fetch_firmware_request {
302 struct gb_fw_download_fetch_firmware_response {
306 /* firmware download release firmware request */
307 struct gb_fw_download_release_firmware_request {
310 /* firmware download release firmware response has no payload */
313 /* Firmware Management Protocol */
316 #define GB_FW_MGMT_TYPE_INTERFACE_FW_VERSION 0x01
317 #define GB_FW_MGMT_TYPE_LOAD_AND_VALIDATE_FW 0x02
318 #define GB_FW_MGMT_TYPE_LOADED_FW 0x03
319 #define GB_FW_MGMT_TYPE_BACKEND_FW_VERSION 0x04
320 #define GB_FW_MGMT_TYPE_BACKEND_FW_UPDATE 0x05
321 #define GB_FW_MGMT_TYPE_BACKEND_FW_UPDATED 0x06
323 #define GB_FW_LOAD_METHOD_UNIPRO 0x01
324 #define GB_FW_LOAD_METHOD_INTERNAL 0x02
326 #define GB_FW_LOAD_STATUS_FAILED 0x00
327 #define GB_FW_LOAD_STATUS_UNVALIDATED 0x01
328 #define GB_FW_LOAD_STATUS_VALIDATED 0x02
329 #define GB_FW_LOAD_STATUS_VALIDATION_FAILED 0x03
331 #define GB_FW_BACKEND_FW_STATUS_SUCCESS 0x01
332 #define GB_FW_BACKEND_FW_STATUS_FAIL_FIND 0x02
333 #define GB_FW_BACKEND_FW_STATUS_FAIL_FETCH 0x03
334 #define GB_FW_BACKEND_FW_STATUS_FAIL_WRITE 0x04
335 #define GB_FW_BACKEND_FW_STATUS_INT 0x05
336 #define GB_FW_BACKEND_FW_STATUS_RETRY 0x06
337 #define GB_FW_BACKEND_FW_STATUS_NOT_SUPPORTED 0x07
339 #define GB_FW_BACKEND_VERSION_STATUS_SUCCESS 0x01
340 #define GB_FW_BACKEND_VERSION_STATUS_NOT_AVAILABLE 0x02
341 #define GB_FW_BACKEND_VERSION_STATUS_NOT_SUPPORTED 0x03
342 #define GB_FW_BACKEND_VERSION_STATUS_RETRY 0x04
343 #define GB_FW_BACKEND_VERSION_STATUS_FAIL_INT 0x05
345 /* firmware management interface firmware version request has no payload */
346 struct gb_fw_mgmt_interface_fw_version_response {
347 __u8 firmware_tag[GB_FIRMWARE_TAG_MAX_SIZE];
352 /* firmware management load and validate firmware request/response */
353 struct gb_fw_mgmt_load_and_validate_fw_request {
356 __u8 firmware_tag[GB_FIRMWARE_TAG_MAX_SIZE];
358 /* firmware management load and validate firmware response has no payload*/
360 /* firmware management loaded firmware request */
361 struct gb_fw_mgmt_loaded_fw_request {
367 /* firmware management loaded firmware response has no payload */
369 /* firmware management backend firmware version request/response */
370 struct gb_fw_mgmt_backend_fw_version_request {
371 __u8 firmware_tag[GB_FIRMWARE_TAG_MAX_SIZE];
374 struct gb_fw_mgmt_backend_fw_version_response {
380 /* firmware management backend firmware update request */
381 struct gb_fw_mgmt_backend_fw_update_request {
383 __u8 firmware_tag[GB_FIRMWARE_TAG_MAX_SIZE];
385 /* firmware management backend firmware update response has no payload */
387 /* firmware management backend firmware updated request */
388 struct gb_fw_mgmt_backend_fw_updated_request {
392 /* firmware management backend firmware updated response has no payload */
395 /* Component Authentication Protocol (CAP) */
398 #define GB_CAP_TYPE_GET_ENDPOINT_UID 0x01
399 #define GB_CAP_TYPE_GET_IMS_CERTIFICATE 0x02
400 #define GB_CAP_TYPE_AUTHENTICATE 0x03
402 /* CAP get endpoint uid request has no payload */
403 struct gb_cap_get_endpoint_uid_response {
407 /* CAP get endpoint ims certificate request/response */
408 struct gb_cap_get_ims_certificate_request {
409 __le32 certificate_class;
410 __le32 certificate_id;
413 struct gb_cap_get_ims_certificate_response {
418 /* CAP authenticate request/response */
419 struct gb_cap_authenticate_request {
425 struct gb_cap_authenticate_response {
432 /* Bootrom Protocol */
434 /* Version of the Greybus bootrom protocol we support */
435 #define GB_BOOTROM_VERSION_MAJOR 0x00
436 #define GB_BOOTROM_VERSION_MINOR 0x01
438 /* Greybus bootrom request types */
439 #define GB_BOOTROM_TYPE_VERSION 0x01
440 #define GB_BOOTROM_TYPE_FIRMWARE_SIZE 0x02
441 #define GB_BOOTROM_TYPE_GET_FIRMWARE 0x03
442 #define GB_BOOTROM_TYPE_READY_TO_BOOT 0x04
443 #define GB_BOOTROM_TYPE_AP_READY 0x05 /* Request with no-payload */
444 #define GB_BOOTROM_TYPE_GET_VID_PID 0x06 /* Request with no-payload */
446 /* Greybus bootrom boot stages */
447 #define GB_BOOTROM_BOOT_STAGE_ONE 0x01 /* Reserved for the boot ROM */
448 #define GB_BOOTROM_BOOT_STAGE_TWO 0x02 /* Bootrom package to be loaded by the boot ROM */
449 #define GB_BOOTROM_BOOT_STAGE_THREE 0x03 /* Module personality package loaded by Stage 2 firmware */
451 /* Greybus bootrom ready to boot status */
452 #define GB_BOOTROM_BOOT_STATUS_INVALID 0x00 /* Firmware blob could not be validated */
453 #define GB_BOOTROM_BOOT_STATUS_INSECURE 0x01 /* Firmware blob is valid but insecure */
454 #define GB_BOOTROM_BOOT_STATUS_SECURE 0x02 /* Firmware blob is valid and secure */
456 /* Max bootrom data fetch size in bytes */
457 #define GB_BOOTROM_FETCH_MAX 2000
459 struct gb_bootrom_version_request {
464 struct gb_bootrom_version_response {
469 /* Bootrom protocol firmware size request/response */
470 struct gb_bootrom_firmware_size_request {
474 struct gb_bootrom_firmware_size_response {
478 /* Bootrom protocol get firmware request/response */
479 struct gb_bootrom_get_firmware_request {
484 struct gb_bootrom_get_firmware_response {
488 /* Bootrom protocol Ready to boot request */
489 struct gb_bootrom_ready_to_boot_request {
492 /* Bootrom protocol Ready to boot response has no payload */
494 /* Bootrom protocol get VID/PID request has no payload */
495 struct gb_bootrom_get_vid_pid_response {
503 /* Greybus power supply request types */
504 #define GB_POWER_SUPPLY_TYPE_GET_SUPPLIES 0x02
505 #define GB_POWER_SUPPLY_TYPE_GET_DESCRIPTION 0x03
506 #define GB_POWER_SUPPLY_TYPE_GET_PROP_DESCRIPTORS 0x04
507 #define GB_POWER_SUPPLY_TYPE_GET_PROPERTY 0x05
508 #define GB_POWER_SUPPLY_TYPE_SET_PROPERTY 0x06
509 #define GB_POWER_SUPPLY_TYPE_EVENT 0x07
511 /* Greybus power supply battery technologies types */
512 #define GB_POWER_SUPPLY_TECH_UNKNOWN 0x0000
513 #define GB_POWER_SUPPLY_TECH_NiMH 0x0001
514 #define GB_POWER_SUPPLY_TECH_LION 0x0002
515 #define GB_POWER_SUPPLY_TECH_LIPO 0x0003
516 #define GB_POWER_SUPPLY_TECH_LiFe 0x0004
517 #define GB_POWER_SUPPLY_TECH_NiCd 0x0005
518 #define GB_POWER_SUPPLY_TECH_LiMn 0x0006
520 /* Greybus power supply types */
521 #define GB_POWER_SUPPLY_UNKNOWN_TYPE 0x0000
522 #define GB_POWER_SUPPLY_BATTERY_TYPE 0x0001
523 #define GB_POWER_SUPPLY_UPS_TYPE 0x0002
524 #define GB_POWER_SUPPLY_MAINS_TYPE 0x0003
525 #define GB_POWER_SUPPLY_USB_TYPE 0x0004
526 #define GB_POWER_SUPPLY_USB_DCP_TYPE 0x0005
527 #define GB_POWER_SUPPLY_USB_CDP_TYPE 0x0006
528 #define GB_POWER_SUPPLY_USB_ACA_TYPE 0x0007
530 /* Greybus power supply health values */
531 #define GB_POWER_SUPPLY_HEALTH_UNKNOWN 0x0000
532 #define GB_POWER_SUPPLY_HEALTH_GOOD 0x0001
533 #define GB_POWER_SUPPLY_HEALTH_OVERHEAT 0x0002
534 #define GB_POWER_SUPPLY_HEALTH_DEAD 0x0003
535 #define GB_POWER_SUPPLY_HEALTH_OVERVOLTAGE 0x0004
536 #define GB_POWER_SUPPLY_HEALTH_UNSPEC_FAILURE 0x0005
537 #define GB_POWER_SUPPLY_HEALTH_COLD 0x0006
538 #define GB_POWER_SUPPLY_HEALTH_WATCHDOG_TIMER_EXPIRE 0x0007
539 #define GB_POWER_SUPPLY_HEALTH_SAFETY_TIMER_EXPIRE 0x0008
541 /* Greybus power supply status values */
542 #define GB_POWER_SUPPLY_STATUS_UNKNOWN 0x0000
543 #define GB_POWER_SUPPLY_STATUS_CHARGING 0x0001
544 #define GB_POWER_SUPPLY_STATUS_DISCHARGING 0x0002
545 #define GB_POWER_SUPPLY_STATUS_NOT_CHARGING 0x0003
546 #define GB_POWER_SUPPLY_STATUS_FULL 0x0004
548 /* Greybus power supply capacity level values */
549 #define GB_POWER_SUPPLY_CAPACITY_LEVEL_UNKNOWN 0x0000
550 #define GB_POWER_SUPPLY_CAPACITY_LEVEL_CRITICAL 0x0001
551 #define GB_POWER_SUPPLY_CAPACITY_LEVEL_LOW 0x0002
552 #define GB_POWER_SUPPLY_CAPACITY_LEVEL_NORMAL 0x0003
553 #define GB_POWER_SUPPLY_CAPACITY_LEVEL_HIGH 0x0004
554 #define GB_POWER_SUPPLY_CAPACITY_LEVEL_FULL 0x0005
556 /* Greybus power supply scope values */
557 #define GB_POWER_SUPPLY_SCOPE_UNKNOWN 0x0000
558 #define GB_POWER_SUPPLY_SCOPE_SYSTEM 0x0001
559 #define GB_POWER_SUPPLY_SCOPE_DEVICE 0x0002
561 struct gb_power_supply_get_supplies_response {
565 struct gb_power_supply_get_description_request {
569 struct gb_power_supply_get_description_response {
570 __u8 manufacturer[32];
572 __u8 serial_number[32];
574 __u8 properties_count;
577 struct gb_power_supply_props_desc {
579 #define GB_POWER_SUPPLY_PROP_STATUS 0x00
580 #define GB_POWER_SUPPLY_PROP_CHARGE_TYPE 0x01
581 #define GB_POWER_SUPPLY_PROP_HEALTH 0x02
582 #define GB_POWER_SUPPLY_PROP_PRESENT 0x03
583 #define GB_POWER_SUPPLY_PROP_ONLINE 0x04
584 #define GB_POWER_SUPPLY_PROP_AUTHENTIC 0x05
585 #define GB_POWER_SUPPLY_PROP_TECHNOLOGY 0x06
586 #define GB_POWER_SUPPLY_PROP_CYCLE_COUNT 0x07
587 #define GB_POWER_SUPPLY_PROP_VOLTAGE_MAX 0x08
588 #define GB_POWER_SUPPLY_PROP_VOLTAGE_MIN 0x09
589 #define GB_POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN 0x0A
590 #define GB_POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN 0x0B
591 #define GB_POWER_SUPPLY_PROP_VOLTAGE_NOW 0x0C
592 #define GB_POWER_SUPPLY_PROP_VOLTAGE_AVG 0x0D
593 #define GB_POWER_SUPPLY_PROP_VOLTAGE_OCV 0x0E
594 #define GB_POWER_SUPPLY_PROP_VOLTAGE_BOOT 0x0F
595 #define GB_POWER_SUPPLY_PROP_CURRENT_MAX 0x10
596 #define GB_POWER_SUPPLY_PROP_CURRENT_NOW 0x11
597 #define GB_POWER_SUPPLY_PROP_CURRENT_AVG 0x12
598 #define GB_POWER_SUPPLY_PROP_CURRENT_BOOT 0x13
599 #define GB_POWER_SUPPLY_PROP_POWER_NOW 0x14
600 #define GB_POWER_SUPPLY_PROP_POWER_AVG 0x15
601 #define GB_POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN 0x16
602 #define GB_POWER_SUPPLY_PROP_CHARGE_EMPTY_DESIGN 0x17
603 #define GB_POWER_SUPPLY_PROP_CHARGE_FULL 0x18
604 #define GB_POWER_SUPPLY_PROP_CHARGE_EMPTY 0x19
605 #define GB_POWER_SUPPLY_PROP_CHARGE_NOW 0x1A
606 #define GB_POWER_SUPPLY_PROP_CHARGE_AVG 0x1B
607 #define GB_POWER_SUPPLY_PROP_CHARGE_COUNTER 0x1C
608 #define GB_POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT 0x1D
609 #define GB_POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT_MAX 0x1E
610 #define GB_POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE 0x1F
611 #define GB_POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE_MAX 0x20
612 #define GB_POWER_SUPPLY_PROP_CHARGE_CONTROL_LIMIT 0x21
613 #define GB_POWER_SUPPLY_PROP_CHARGE_CONTROL_LIMIT_MAX 0x22
614 #define GB_POWER_SUPPLY_PROP_INPUT_CURRENT_LIMIT 0x23
615 #define GB_POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN 0x24
616 #define GB_POWER_SUPPLY_PROP_ENERGY_EMPTY_DESIGN 0x25
617 #define GB_POWER_SUPPLY_PROP_ENERGY_FULL 0x26
618 #define GB_POWER_SUPPLY_PROP_ENERGY_EMPTY 0x27
619 #define GB_POWER_SUPPLY_PROP_ENERGY_NOW 0x28
620 #define GB_POWER_SUPPLY_PROP_ENERGY_AVG 0x29
621 #define GB_POWER_SUPPLY_PROP_CAPACITY 0x2A
622 #define GB_POWER_SUPPLY_PROP_CAPACITY_ALERT_MIN 0x2B
623 #define GB_POWER_SUPPLY_PROP_CAPACITY_ALERT_MAX 0x2C
624 #define GB_POWER_SUPPLY_PROP_CAPACITY_LEVEL 0x2D
625 #define GB_POWER_SUPPLY_PROP_TEMP 0x2E
626 #define GB_POWER_SUPPLY_PROP_TEMP_MAX 0x2F
627 #define GB_POWER_SUPPLY_PROP_TEMP_MIN 0x30
628 #define GB_POWER_SUPPLY_PROP_TEMP_ALERT_MIN 0x31
629 #define GB_POWER_SUPPLY_PROP_TEMP_ALERT_MAX 0x32
630 #define GB_POWER_SUPPLY_PROP_TEMP_AMBIENT 0x33
631 #define GB_POWER_SUPPLY_PROP_TEMP_AMBIENT_ALERT_MIN 0x34
632 #define GB_POWER_SUPPLY_PROP_TEMP_AMBIENT_ALERT_MAX 0x35
633 #define GB_POWER_SUPPLY_PROP_TIME_TO_EMPTY_NOW 0x36
634 #define GB_POWER_SUPPLY_PROP_TIME_TO_EMPTY_AVG 0x37
635 #define GB_POWER_SUPPLY_PROP_TIME_TO_FULL_NOW 0x38
636 #define GB_POWER_SUPPLY_PROP_TIME_TO_FULL_AVG 0x39
637 #define GB_POWER_SUPPLY_PROP_TYPE 0x3A
638 #define GB_POWER_SUPPLY_PROP_SCOPE 0x3B
639 #define GB_POWER_SUPPLY_PROP_CHARGE_TERM_CURRENT 0x3C
640 #define GB_POWER_SUPPLY_PROP_CALIBRATE 0x3D
644 struct gb_power_supply_get_property_descriptors_request {
648 struct gb_power_supply_get_property_descriptors_response {
649 __u8 properties_count;
650 struct gb_power_supply_props_desc props[];
653 struct gb_power_supply_get_property_request {
658 struct gb_power_supply_get_property_response {
662 struct gb_power_supply_set_property_request {
668 struct gb_power_supply_event_request {
671 #define GB_POWER_SUPPLY_UPDATE 0x01
677 /* Greybus HID operation types */
678 #define GB_HID_TYPE_GET_DESC 0x02
679 #define GB_HID_TYPE_GET_REPORT_DESC 0x03
680 #define GB_HID_TYPE_PWR_ON 0x04
681 #define GB_HID_TYPE_PWR_OFF 0x05
682 #define GB_HID_TYPE_GET_REPORT 0x06
683 #define GB_HID_TYPE_SET_REPORT 0x07
684 #define GB_HID_TYPE_IRQ_EVENT 0x08
687 #define GB_HID_INPUT_REPORT 0
688 #define GB_HID_OUTPUT_REPORT 1
689 #define GB_HID_FEATURE_REPORT 2
691 /* Different request/response structures */
692 /* HID get descriptor response */
693 struct gb_hid_desc_response {
695 __le16 wReportDescLength;
702 /* HID get report request/response */
703 struct gb_hid_get_report_request {
708 /* HID set report request */
709 struct gb_hid_set_report_request {
715 /* HID input report request, via interrupt pipe */
716 struct gb_hid_input_report_request {
723 /* Greybus i2c request types */
724 #define GB_I2C_TYPE_FUNCTIONALITY 0x02
725 #define GB_I2C_TYPE_TRANSFER 0x05
727 /* functionality request has no payload */
728 struct gb_i2c_functionality_response {
729 __le32 functionality;
733 * Outgoing data immediately follows the op count and ops array.
734 * The data for each write (master -> slave) op in the array is sent
735 * in order, with no (e.g. pad) bytes separating them.
737 * Short reads cause the entire transfer request to fail So response
738 * payload consists only of bytes read, and the number of bytes is
739 * exactly what was specified in the corresponding op. Like
740 * outgoing data, the incoming data is in order and contiguous.
742 struct gb_i2c_transfer_op {
748 struct gb_i2c_transfer_request {
750 struct gb_i2c_transfer_op ops[0]; /* op_count of these */
752 struct gb_i2c_transfer_response {
753 __u8 data[0]; /* inbound data */
759 /* Greybus GPIO request types */
760 #define GB_GPIO_TYPE_LINE_COUNT 0x02
761 #define GB_GPIO_TYPE_ACTIVATE 0x03
762 #define GB_GPIO_TYPE_DEACTIVATE 0x04
763 #define GB_GPIO_TYPE_GET_DIRECTION 0x05
764 #define GB_GPIO_TYPE_DIRECTION_IN 0x06
765 #define GB_GPIO_TYPE_DIRECTION_OUT 0x07
766 #define GB_GPIO_TYPE_GET_VALUE 0x08
767 #define GB_GPIO_TYPE_SET_VALUE 0x09
768 #define GB_GPIO_TYPE_SET_DEBOUNCE 0x0a
769 #define GB_GPIO_TYPE_IRQ_TYPE 0x0b
770 #define GB_GPIO_TYPE_IRQ_MASK 0x0c
771 #define GB_GPIO_TYPE_IRQ_UNMASK 0x0d
772 #define GB_GPIO_TYPE_IRQ_EVENT 0x0e
774 #define GB_GPIO_IRQ_TYPE_NONE 0x00
775 #define GB_GPIO_IRQ_TYPE_EDGE_RISING 0x01
776 #define GB_GPIO_IRQ_TYPE_EDGE_FALLING 0x02
777 #define GB_GPIO_IRQ_TYPE_EDGE_BOTH 0x03
778 #define GB_GPIO_IRQ_TYPE_LEVEL_HIGH 0x04
779 #define GB_GPIO_IRQ_TYPE_LEVEL_LOW 0x08
781 /* line count request has no payload */
782 struct gb_gpio_line_count_response {
786 struct gb_gpio_activate_request {
789 /* activate response has no payload */
791 struct gb_gpio_deactivate_request {
794 /* deactivate response has no payload */
796 struct gb_gpio_get_direction_request {
799 struct gb_gpio_get_direction_response {
803 struct gb_gpio_direction_in_request {
806 /* direction in response has no payload */
808 struct gb_gpio_direction_out_request {
812 /* direction out response has no payload */
814 struct gb_gpio_get_value_request {
817 struct gb_gpio_get_value_response {
821 struct gb_gpio_set_value_request {
825 /* set value response has no payload */
827 struct gb_gpio_set_debounce_request {
831 /* debounce response has no payload */
833 struct gb_gpio_irq_type_request {
837 /* irq type response has no payload */
839 struct gb_gpio_irq_mask_request {
842 /* irq mask response has no payload */
844 struct gb_gpio_irq_unmask_request {
847 /* irq unmask response has no payload */
849 /* irq event requests originate on another module and are handled on the AP */
850 struct gb_gpio_irq_event_request {
853 /* irq event has no response */
858 /* Greybus PWM operation types */
859 #define GB_PWM_TYPE_PWM_COUNT 0x02
860 #define GB_PWM_TYPE_ACTIVATE 0x03
861 #define GB_PWM_TYPE_DEACTIVATE 0x04
862 #define GB_PWM_TYPE_CONFIG 0x05
863 #define GB_PWM_TYPE_POLARITY 0x06
864 #define GB_PWM_TYPE_ENABLE 0x07
865 #define GB_PWM_TYPE_DISABLE 0x08
867 /* pwm count request has no payload */
868 struct gb_pwm_count_response {
872 struct gb_pwm_activate_request {
876 struct gb_pwm_deactivate_request {
880 struct gb_pwm_config_request {
886 struct gb_pwm_polarity_request {
891 struct gb_pwm_enable_request {
895 struct gb_pwm_disable_request {
901 /* Should match up with modes in linux/spi/spi.h */
902 #define GB_SPI_MODE_CPHA 0x01 /* clock phase */
903 #define GB_SPI_MODE_CPOL 0x02 /* clock polarity */
904 #define GB_SPI_MODE_MODE_0 (0|0) /* (original MicroWire) */
905 #define GB_SPI_MODE_MODE_1 (0|GB_SPI_MODE_CPHA)
906 #define GB_SPI_MODE_MODE_2 (GB_SPI_MODE_CPOL|0)
907 #define GB_SPI_MODE_MODE_3 (GB_SPI_MODE_CPOL|GB_SPI_MODE_CPHA)
908 #define GB_SPI_MODE_CS_HIGH 0x04 /* chipselect active high? */
909 #define GB_SPI_MODE_LSB_FIRST 0x08 /* per-word bits-on-wire */
910 #define GB_SPI_MODE_3WIRE 0x10 /* SI/SO signals shared */
911 #define GB_SPI_MODE_LOOP 0x20 /* loopback mode */
912 #define GB_SPI_MODE_NO_CS 0x40 /* 1 dev/bus, no chipselect */
913 #define GB_SPI_MODE_READY 0x80 /* slave pulls low to pause */
915 /* Should match up with flags in linux/spi/spi.h */
916 #define GB_SPI_FLAG_HALF_DUPLEX BIT(0) /* can't do full duplex */
917 #define GB_SPI_FLAG_NO_RX BIT(1) /* can't do buffer read */
918 #define GB_SPI_FLAG_NO_TX BIT(2) /* can't do buffer write */
920 /* Greybus spi operation types */
921 #define GB_SPI_TYPE_MASTER_CONFIG 0x02
922 #define GB_SPI_TYPE_DEVICE_CONFIG 0x03
923 #define GB_SPI_TYPE_TRANSFER 0x04
925 /* mode request has no payload */
926 struct gb_spi_master_config_response {
927 __le32 bits_per_word_mask;
935 struct gb_spi_device_config_request {
939 struct gb_spi_device_config_response {
944 #define GB_SPI_SPI_DEV 0x00
945 #define GB_SPI_SPI_NOR 0x01
946 #define GB_SPI_SPI_MODALIAS 0x02
951 * struct gb_spi_transfer - a read/write buffer pair
952 * @speed_hz: Select a speed other than the device default for this transfer. If
953 * 0 the default (from @spi_device) is used.
954 * @len: size of rx and tx buffers (in bytes)
955 * @delay_usecs: microseconds to delay after this transfer before (optionally)
956 * changing the chipselect status, then starting the next transfer or
957 * completing this spi_message.
958 * @cs_change: affects chipselect after this transfer completes
959 * @bits_per_word: select a bits_per_word other than the device default for this
960 * transfer. If 0 the default (from @spi_device) is used.
962 struct gb_spi_transfer {
969 #define GB_SPI_XFER_READ 0x01
970 #define GB_SPI_XFER_WRITE 0x02
971 #define GB_SPI_XFER_INPROGRESS 0x04
974 struct gb_spi_transfer_request {
975 __u8 chip_select; /* of the spi device */
976 __u8 mode; /* of the spi device */
978 struct gb_spi_transfer transfers[0]; /* count of these */
981 struct gb_spi_transfer_response {
982 __u8 data[0]; /* inbound data */
985 /* Version of the Greybus SVC protocol we support */
986 #define GB_SVC_VERSION_MAJOR 0x00
987 #define GB_SVC_VERSION_MINOR 0x01
989 /* Greybus SVC request types */
990 #define GB_SVC_TYPE_PROTOCOL_VERSION 0x01
991 #define GB_SVC_TYPE_SVC_HELLO 0x02
992 #define GB_SVC_TYPE_INTF_DEVICE_ID 0x03
993 #define GB_SVC_TYPE_INTF_RESET 0x06
994 #define GB_SVC_TYPE_CONN_CREATE 0x07
995 #define GB_SVC_TYPE_CONN_DESTROY 0x08
996 #define GB_SVC_TYPE_DME_PEER_GET 0x09
997 #define GB_SVC_TYPE_DME_PEER_SET 0x0a
998 #define GB_SVC_TYPE_ROUTE_CREATE 0x0b
999 #define GB_SVC_TYPE_ROUTE_DESTROY 0x0c
1000 #define GB_SVC_TYPE_TIMESYNC_ENABLE 0x0d
1001 #define GB_SVC_TYPE_TIMESYNC_DISABLE 0x0e
1002 #define GB_SVC_TYPE_TIMESYNC_AUTHORITATIVE 0x0f
1003 #define GB_SVC_TYPE_INTF_SET_PWRM 0x10
1004 #define GB_SVC_TYPE_INTF_EJECT 0x11
1005 #define GB_SVC_TYPE_KEY_EVENT 0x12
1006 #define GB_SVC_TYPE_PING 0x13
1007 #define GB_SVC_TYPE_PWRMON_RAIL_COUNT_GET 0x14
1008 #define GB_SVC_TYPE_PWRMON_RAIL_NAMES_GET 0x15
1009 #define GB_SVC_TYPE_PWRMON_SAMPLE_GET 0x16
1010 #define GB_SVC_TYPE_PWRMON_INTF_SAMPLE_GET 0x17
1011 #define GB_SVC_TYPE_TIMESYNC_WAKE_PINS_ACQUIRE 0x18
1012 #define GB_SVC_TYPE_TIMESYNC_WAKE_PINS_RELEASE 0x19
1013 #define GB_SVC_TYPE_TIMESYNC_PING 0x1a
1014 #define GB_SVC_TYPE_MODULE_INSERTED 0x1f
1015 #define GB_SVC_TYPE_MODULE_REMOVED 0x20
1016 #define GB_SVC_TYPE_INTF_VSYS_ENABLE 0x21
1017 #define GB_SVC_TYPE_INTF_VSYS_DISABLE 0x22
1018 #define GB_SVC_TYPE_INTF_REFCLK_ENABLE 0x23
1019 #define GB_SVC_TYPE_INTF_REFCLK_DISABLE 0x24
1020 #define GB_SVC_TYPE_INTF_UNIPRO_ENABLE 0x25
1021 #define GB_SVC_TYPE_INTF_UNIPRO_DISABLE 0x26
1022 #define GB_SVC_TYPE_INTF_ACTIVATE 0x27
1023 #define GB_SVC_TYPE_INTF_RESUME 0x28
1024 #define GB_SVC_TYPE_INTF_MAILBOX_EVENT 0x29
1025 #define GB_SVC_TYPE_INTF_OOPS 0x2a
1027 /* Greybus SVC protocol status values */
1028 #define GB_SVC_OP_SUCCESS 0x00
1029 #define GB_SVC_OP_UNKNOWN_ERROR 0x01
1030 #define GB_SVC_INTF_NOT_DETECTED 0x02
1031 #define GB_SVC_INTF_NO_UPRO_LINK 0x03
1032 #define GB_SVC_INTF_UPRO_NOT_DOWN 0x04
1033 #define GB_SVC_INTF_UPRO_NOT_HIBERNATED 0x05
1034 #define GB_SVC_INTF_NO_V_SYS 0x06
1035 #define GB_SVC_INTF_V_CHG 0x07
1036 #define GB_SVC_INTF_WAKE_BUSY 0x08
1037 #define GB_SVC_INTF_NO_REFCLK 0x09
1038 #define GB_SVC_INTF_RELEASING 0x0a
1039 #define GB_SVC_INTF_NO_ORDER 0x0b
1040 #define GB_SVC_INTF_MBOX_SET 0x0c
1041 #define GB_SVC_INTF_BAD_MBOX 0x0d
1042 #define GB_SVC_INTF_OP_TIMEOUT 0x0e
1043 #define GB_SVC_PWRMON_OP_NOT_PRESENT 0x0f
1045 struct gb_svc_version_request {
1050 struct gb_svc_version_response {
1055 /* SVC protocol hello request */
1056 struct gb_svc_hello_request {
1060 /* hello response has no payload */
1062 struct gb_svc_intf_device_id_request {
1066 /* device id response has no payload */
1068 struct gb_svc_intf_reset_request {
1071 /* interface reset response has no payload */
1073 struct gb_svc_intf_eject_request {
1076 /* interface eject response has no payload */
1078 struct gb_svc_conn_create_request {
1086 /* connection create response has no payload */
1088 struct gb_svc_conn_destroy_request {
1094 /* connection destroy response has no payload */
1096 struct gb_svc_dme_peer_get_request {
1102 struct gb_svc_dme_peer_get_response {
1107 struct gb_svc_dme_peer_set_request {
1114 struct gb_svc_dme_peer_set_response {
1118 /* Greybus init-status values, currently retrieved using DME peer gets. */
1119 #define GB_INIT_SPI_BOOT_STARTED 0x02
1120 #define GB_INIT_TRUSTED_SPI_BOOT_FINISHED 0x03
1121 #define GB_INIT_UNTRUSTED_SPI_BOOT_FINISHED 0x04
1122 #define GB_INIT_BOOTROM_UNIPRO_BOOT_STARTED 0x06
1123 #define GB_INIT_BOOTROM_FALLBACK_UNIPRO_BOOT_STARTED 0x09
1124 #define GB_INIT_S2_LOADER_BOOT_STARTED 0x0D
1126 struct gb_svc_route_create_request {
1132 /* route create response has no payload */
1134 struct gb_svc_route_destroy_request {
1138 /* route destroy response has no payload */
1140 /* used for svc_intf_vsys_{enable,disable} */
1141 struct gb_svc_intf_vsys_request {
1145 struct gb_svc_intf_vsys_response {
1147 #define GB_SVC_INTF_VSYS_OK 0x00
1148 /* 0x01 is reserved */
1149 #define GB_SVC_INTF_VSYS_FAIL 0x02
1152 /* used for svc_intf_refclk_{enable,disable} */
1153 struct gb_svc_intf_refclk_request {
1157 struct gb_svc_intf_refclk_response {
1159 #define GB_SVC_INTF_REFCLK_OK 0x00
1160 /* 0x01 is reserved */
1161 #define GB_SVC_INTF_REFCLK_FAIL 0x02
1164 /* used for svc_intf_unipro_{enable,disable} */
1165 struct gb_svc_intf_unipro_request {
1169 struct gb_svc_intf_unipro_response {
1171 #define GB_SVC_INTF_UNIPRO_OK 0x00
1172 /* 0x01 is reserved */
1173 #define GB_SVC_INTF_UNIPRO_FAIL 0x02
1174 #define GB_SVC_INTF_UNIPRO_NOT_OFF 0x03
1177 struct gb_svc_timesync_enable_request {
1180 __le32 strobe_delay;
1183 /* timesync enable response has no payload */
1185 /* timesync authoritative request has no payload */
1186 struct gb_svc_timesync_authoritative_response {
1187 __le64 frame_time[GB_TIMESYNC_MAX_STROBES];
1190 struct gb_svc_timesync_wake_pins_acquire_request {
1194 /* timesync wake pins acquire response has no payload */
1196 /* timesync wake pins release request has no payload */
1197 /* timesync wake pins release response has no payload */
1199 /* timesync svc ping request has no payload */
1200 struct gb_svc_timesync_ping_response {
1204 #define GB_SVC_UNIPRO_FAST_MODE 0x01
1205 #define GB_SVC_UNIPRO_SLOW_MODE 0x02
1206 #define GB_SVC_UNIPRO_FAST_AUTO_MODE 0x04
1207 #define GB_SVC_UNIPRO_SLOW_AUTO_MODE 0x05
1208 #define GB_SVC_UNIPRO_MODE_UNCHANGED 0x07
1209 #define GB_SVC_UNIPRO_HIBERNATE_MODE 0x11
1210 #define GB_SVC_UNIPRO_OFF_MODE 0x12
1212 #define GB_SVC_SMALL_AMPLITUDE 0x01
1213 #define GB_SVC_LARGE_AMPLITUDE 0x02
1215 #define GB_SVC_NO_DE_EMPHASIS 0x00
1216 #define GB_SVC_SMALL_DE_EMPHASIS 0x01
1217 #define GB_SVC_LARGE_DE_EMPHASIS 0x02
1219 #define GB_SVC_PWRM_RXTERMINATION 0x01
1220 #define GB_SVC_PWRM_TXTERMINATION 0x02
1221 #define GB_SVC_PWRM_LINE_RESET 0x04
1222 #define GB_SVC_PWRM_SCRAMBLING 0x20
1224 #define GB_SVC_PWRM_QUIRK_HSSER 0x00000001
1226 #define GB_SVC_UNIPRO_HS_SERIES_A 0x01
1227 #define GB_SVC_UNIPRO_HS_SERIES_B 0x02
1229 #define GB_SVC_SETPWRM_PWR_OK 0x00
1230 #define GB_SVC_SETPWRM_PWR_LOCAL 0x01
1231 #define GB_SVC_SETPWRM_PWR_REMOTE 0x02
1232 #define GB_SVC_SETPWRM_PWR_BUSY 0x03
1233 #define GB_SVC_SETPWRM_PWR_ERROR_CAP 0x04
1234 #define GB_SVC_SETPWRM_PWR_FATAL_ERROR 0x05
1236 struct gb_svc_l2_timer_cfg {
1237 __le16 tsb_fc0_protection_timeout;
1238 __le16 tsb_tc0_replay_timeout;
1239 __le16 tsb_afc0_req_timeout;
1240 __le16 tsb_fc1_protection_timeout;
1241 __le16 tsb_tc1_replay_timeout;
1242 __le16 tsb_afc1_req_timeout;
1243 __le16 reserved_for_tc2[3];
1244 __le16 reserved_for_tc3[3];
1247 struct gb_svc_intf_set_pwrm_request {
1254 __u8 tx_hs_equalizer;
1260 struct gb_svc_l2_timer_cfg local_l2timerdata, remote_l2timerdata;
1263 struct gb_svc_intf_set_pwrm_response {
1267 struct gb_svc_key_event_request {
1269 #define GB_KEYCODE_ARA 0x00
1272 #define GB_SVC_KEY_RELEASED 0x00
1273 #define GB_SVC_KEY_PRESSED 0x01
1276 #define GB_SVC_PWRMON_MAX_RAIL_COUNT 254
1278 struct gb_svc_pwrmon_rail_count_get_response {
1282 #define GB_SVC_PWRMON_RAIL_NAME_BUFSIZE 32
1284 struct gb_svc_pwrmon_rail_names_get_response {
1286 __u8 name[0][GB_SVC_PWRMON_RAIL_NAME_BUFSIZE];
1289 #define GB_SVC_PWRMON_TYPE_CURR 0x01
1290 #define GB_SVC_PWRMON_TYPE_VOL 0x02
1291 #define GB_SVC_PWRMON_TYPE_PWR 0x03
1293 #define GB_SVC_PWRMON_GET_SAMPLE_OK 0x00
1294 #define GB_SVC_PWRMON_GET_SAMPLE_INVAL 0x01
1295 #define GB_SVC_PWRMON_GET_SAMPLE_NOSUPP 0x02
1296 #define GB_SVC_PWRMON_GET_SAMPLE_HWERR 0x03
1298 struct gb_svc_pwrmon_sample_get_request {
1300 __u8 measurement_type;
1303 struct gb_svc_pwrmon_sample_get_response {
1308 struct gb_svc_pwrmon_intf_sample_get_request {
1310 __u8 measurement_type;
1313 struct gb_svc_pwrmon_intf_sample_get_response {
1318 #define GB_SVC_MODULE_INSERTED_FLAG_NO_PRIMARY 0x0001
1320 struct gb_svc_module_inserted_request {
1321 __u8 primary_intf_id;
1325 /* module_inserted response has no payload */
1327 struct gb_svc_module_removed_request {
1328 __u8 primary_intf_id;
1330 /* module_removed response has no payload */
1332 struct gb_svc_intf_activate_request {
1336 #define GB_SVC_INTF_TYPE_UNKNOWN 0x00
1337 #define GB_SVC_INTF_TYPE_DUMMY 0x01
1338 #define GB_SVC_INTF_TYPE_UNIPRO 0x02
1339 #define GB_SVC_INTF_TYPE_GREYBUS 0x03
1341 struct gb_svc_intf_activate_response {
1346 struct gb_svc_intf_resume_request {
1350 struct gb_svc_intf_resume_response {
1354 #define GB_SVC_INTF_MAILBOX_NONE 0x00
1355 #define GB_SVC_INTF_MAILBOX_AP 0x01
1356 #define GB_SVC_INTF_MAILBOX_GREYBUS 0x02
1358 struct gb_svc_intf_mailbox_event_request {
1363 /* intf_mailbox_event response has no payload */
1365 struct gb_svc_intf_oops_request {
1369 /* intf_oops response has no payload */
1374 /* Greybus raw request types */
1375 #define GB_RAW_TYPE_SEND 0x02
1377 struct gb_raw_send_request {
1385 /* Greybus UART operation types */
1386 #define GB_UART_TYPE_SEND_DATA 0x02
1387 #define GB_UART_TYPE_RECEIVE_DATA 0x03 /* Unsolicited data */
1388 #define GB_UART_TYPE_SET_LINE_CODING 0x04
1389 #define GB_UART_TYPE_SET_CONTROL_LINE_STATE 0x05
1390 #define GB_UART_TYPE_SEND_BREAK 0x06
1391 #define GB_UART_TYPE_SERIAL_STATE 0x07 /* Unsolicited data */
1392 #define GB_UART_TYPE_RECEIVE_CREDITS 0x08
1393 #define GB_UART_TYPE_FLUSH_FIFOS 0x09
1395 /* Represents data from AP -> Module */
1396 struct gb_uart_send_data_request {
1401 /* recv-data-request flags */
1402 #define GB_UART_RECV_FLAG_FRAMING 0x01 /* Framing error */
1403 #define GB_UART_RECV_FLAG_PARITY 0x02 /* Parity error */
1404 #define GB_UART_RECV_FLAG_OVERRUN 0x04 /* Overrun error */
1405 #define GB_UART_RECV_FLAG_BREAK 0x08 /* Break */
1407 /* Represents data from Module -> AP */
1408 struct gb_uart_recv_data_request {
1414 struct gb_uart_receive_credits_request {
1418 struct gb_uart_set_line_coding_request {
1421 #define GB_SERIAL_1_STOP_BITS 0
1422 #define GB_SERIAL_1_5_STOP_BITS 1
1423 #define GB_SERIAL_2_STOP_BITS 2
1426 #define GB_SERIAL_NO_PARITY 0
1427 #define GB_SERIAL_ODD_PARITY 1
1428 #define GB_SERIAL_EVEN_PARITY 2
1429 #define GB_SERIAL_MARK_PARITY 3
1430 #define GB_SERIAL_SPACE_PARITY 4
1435 #define GB_SERIAL_AUTO_RTSCTS_EN 0x1
1438 /* output control lines */
1439 #define GB_UART_CTRL_DTR 0x01
1440 #define GB_UART_CTRL_RTS 0x02
1442 struct gb_uart_set_control_line_state_request {
1446 struct gb_uart_set_break_request {
1450 /* input control lines and line errors */
1451 #define GB_UART_CTRL_DCD 0x01
1452 #define GB_UART_CTRL_DSR 0x02
1453 #define GB_UART_CTRL_RI 0x04
1455 struct gb_uart_serial_state_request {
1459 struct gb_uart_serial_flush_request {
1461 #define GB_SERIAL_FLAG_FLUSH_TRANSMITTER 0x01
1462 #define GB_SERIAL_FLAG_FLUSH_RECEIVER 0x02
1467 /* Greybus loopback request types */
1468 #define GB_LOOPBACK_TYPE_PING 0x02
1469 #define GB_LOOPBACK_TYPE_TRANSFER 0x03
1470 #define GB_LOOPBACK_TYPE_SINK 0x04
1473 * Loopback request/response header format should be identical
1474 * to simplify bandwidth and data movement analysis.
1476 struct gb_loopback_transfer_request {
1483 struct gb_loopback_transfer_response {
1491 /* Greybus SDIO operation types */
1492 #define GB_SDIO_TYPE_GET_CAPABILITIES 0x02
1493 #define GB_SDIO_TYPE_SET_IOS 0x03
1494 #define GB_SDIO_TYPE_COMMAND 0x04
1495 #define GB_SDIO_TYPE_TRANSFER 0x05
1496 #define GB_SDIO_TYPE_EVENT 0x06
1498 /* get caps response: request has no payload */
1499 struct gb_sdio_get_caps_response {
1501 #define GB_SDIO_CAP_NONREMOVABLE 0x00000001
1502 #define GB_SDIO_CAP_4_BIT_DATA 0x00000002
1503 #define GB_SDIO_CAP_8_BIT_DATA 0x00000004
1504 #define GB_SDIO_CAP_MMC_HS 0x00000008
1505 #define GB_SDIO_CAP_SD_HS 0x00000010
1506 #define GB_SDIO_CAP_ERASE 0x00000020
1507 #define GB_SDIO_CAP_1_2V_DDR 0x00000040
1508 #define GB_SDIO_CAP_1_8V_DDR 0x00000080
1509 #define GB_SDIO_CAP_POWER_OFF_CARD 0x00000100
1510 #define GB_SDIO_CAP_UHS_SDR12 0x00000200
1511 #define GB_SDIO_CAP_UHS_SDR25 0x00000400
1512 #define GB_SDIO_CAP_UHS_SDR50 0x00000800
1513 #define GB_SDIO_CAP_UHS_SDR104 0x00001000
1514 #define GB_SDIO_CAP_UHS_DDR50 0x00002000
1515 #define GB_SDIO_CAP_DRIVER_TYPE_A 0x00004000
1516 #define GB_SDIO_CAP_DRIVER_TYPE_C 0x00008000
1517 #define GB_SDIO_CAP_DRIVER_TYPE_D 0x00010000
1518 #define GB_SDIO_CAP_HS200_1_2V 0x00020000
1519 #define GB_SDIO_CAP_HS200_1_8V 0x00040000
1520 #define GB_SDIO_CAP_HS400_1_2V 0x00080000
1521 #define GB_SDIO_CAP_HS400_1_8V 0x00100000
1523 /* see possible values below at vdd */
1527 __le16 max_blk_count;
1528 __le16 max_blk_size;
1531 /* set ios request: response has no payload */
1532 struct gb_sdio_set_ios_request {
1535 #define GB_SDIO_VDD_165_195 0x00000001
1536 #define GB_SDIO_VDD_20_21 0x00000002
1537 #define GB_SDIO_VDD_21_22 0x00000004
1538 #define GB_SDIO_VDD_22_23 0x00000008
1539 #define GB_SDIO_VDD_23_24 0x00000010
1540 #define GB_SDIO_VDD_24_25 0x00000020
1541 #define GB_SDIO_VDD_25_26 0x00000040
1542 #define GB_SDIO_VDD_26_27 0x00000080
1543 #define GB_SDIO_VDD_27_28 0x00000100
1544 #define GB_SDIO_VDD_28_29 0x00000200
1545 #define GB_SDIO_VDD_29_30 0x00000400
1546 #define GB_SDIO_VDD_30_31 0x00000800
1547 #define GB_SDIO_VDD_31_32 0x00001000
1548 #define GB_SDIO_VDD_32_33 0x00002000
1549 #define GB_SDIO_VDD_33_34 0x00004000
1550 #define GB_SDIO_VDD_34_35 0x00008000
1551 #define GB_SDIO_VDD_35_36 0x00010000
1554 #define GB_SDIO_BUSMODE_OPENDRAIN 0x00
1555 #define GB_SDIO_BUSMODE_PUSHPULL 0x01
1558 #define GB_SDIO_POWER_OFF 0x00
1559 #define GB_SDIO_POWER_UP 0x01
1560 #define GB_SDIO_POWER_ON 0x02
1561 #define GB_SDIO_POWER_UNDEFINED 0x03
1564 #define GB_SDIO_BUS_WIDTH_1 0x00
1565 #define GB_SDIO_BUS_WIDTH_4 0x02
1566 #define GB_SDIO_BUS_WIDTH_8 0x03
1569 #define GB_SDIO_TIMING_LEGACY 0x00
1570 #define GB_SDIO_TIMING_MMC_HS 0x01
1571 #define GB_SDIO_TIMING_SD_HS 0x02
1572 #define GB_SDIO_TIMING_UHS_SDR12 0x03
1573 #define GB_SDIO_TIMING_UHS_SDR25 0x04
1574 #define GB_SDIO_TIMING_UHS_SDR50 0x05
1575 #define GB_SDIO_TIMING_UHS_SDR104 0x06
1576 #define GB_SDIO_TIMING_UHS_DDR50 0x07
1577 #define GB_SDIO_TIMING_MMC_DDR52 0x08
1578 #define GB_SDIO_TIMING_MMC_HS200 0x09
1579 #define GB_SDIO_TIMING_MMC_HS400 0x0A
1581 __u8 signal_voltage;
1582 #define GB_SDIO_SIGNAL_VOLTAGE_330 0x00
1583 #define GB_SDIO_SIGNAL_VOLTAGE_180 0x01
1584 #define GB_SDIO_SIGNAL_VOLTAGE_120 0x02
1587 #define GB_SDIO_SET_DRIVER_TYPE_B 0x00
1588 #define GB_SDIO_SET_DRIVER_TYPE_A 0x01
1589 #define GB_SDIO_SET_DRIVER_TYPE_C 0x02
1590 #define GB_SDIO_SET_DRIVER_TYPE_D 0x03
1593 /* command request */
1594 struct gb_sdio_command_request {
1597 #define GB_SDIO_RSP_NONE 0x00
1598 #define GB_SDIO_RSP_PRESENT 0x01
1599 #define GB_SDIO_RSP_136 0x02
1600 #define GB_SDIO_RSP_CRC 0x04
1601 #define GB_SDIO_RSP_BUSY 0x08
1602 #define GB_SDIO_RSP_OPCODE 0x10
1605 #define GB_SDIO_CMD_AC 0x00
1606 #define GB_SDIO_CMD_ADTC 0x01
1607 #define GB_SDIO_CMD_BC 0x02
1608 #define GB_SDIO_CMD_BCR 0x03
1615 struct gb_sdio_command_response {
1619 /* transfer request */
1620 struct gb_sdio_transfer_request {
1622 #define GB_SDIO_DATA_WRITE 0x01
1623 #define GB_SDIO_DATA_READ 0x02
1624 #define GB_SDIO_DATA_STREAM 0x04
1631 struct gb_sdio_transfer_response {
1637 /* event request: generated by module and is defined as unidirectional */
1638 struct gb_sdio_event_request {
1640 #define GB_SDIO_CARD_INSERTED 0x01
1641 #define GB_SDIO_CARD_REMOVED 0x02
1642 #define GB_SDIO_WP 0x04
1647 /* Greybus Camera request types */
1648 #define GB_CAMERA_TYPE_CAPABILITIES 0x02
1649 #define GB_CAMERA_TYPE_CONFIGURE_STREAMS 0x03
1650 #define GB_CAMERA_TYPE_CAPTURE 0x04
1651 #define GB_CAMERA_TYPE_FLUSH 0x05
1652 #define GB_CAMERA_TYPE_METADATA 0x06
1654 #define GB_CAMERA_MAX_STREAMS 4
1655 #define GB_CAMERA_MAX_SETTINGS_SIZE 8192
1657 /* Greybus Camera Configure Streams request payload */
1658 struct gb_camera_stream_config_request {
1665 struct gb_camera_configure_streams_request {
1668 #define GB_CAMERA_CONFIGURE_STREAMS_TEST_ONLY 0x01
1670 struct gb_camera_stream_config_request config[0];
1673 /* Greybus Camera Configure Streams response payload */
1674 struct gb_camera_stream_config_response {
1678 __u8 virtual_channel;
1680 __le16 max_pkt_size;
1685 struct gb_camera_configure_streams_response {
1687 #define GB_CAMERA_CONFIGURE_STREAMS_ADJUSTED 0x01
1691 struct gb_camera_stream_config_response config[0];
1694 /* Greybus Camera Capture request payload - response has no payload */
1695 struct gb_camera_capture_request {
1703 /* Greybus Camera Flush response payload - request has no payload */
1704 struct gb_camera_flush_response {
1708 /* Greybus Camera Metadata request payload - operation has no response */
1709 struct gb_camera_metadata_request {
1711 __le16 frame_number;
1719 /* Greybus Lights request types */
1720 #define GB_LIGHTS_TYPE_GET_LIGHTS 0x02
1721 #define GB_LIGHTS_TYPE_GET_LIGHT_CONFIG 0x03
1722 #define GB_LIGHTS_TYPE_GET_CHANNEL_CONFIG 0x04
1723 #define GB_LIGHTS_TYPE_GET_CHANNEL_FLASH_CONFIG 0x05
1724 #define GB_LIGHTS_TYPE_SET_BRIGHTNESS 0x06
1725 #define GB_LIGHTS_TYPE_SET_BLINK 0x07
1726 #define GB_LIGHTS_TYPE_SET_COLOR 0x08
1727 #define GB_LIGHTS_TYPE_SET_FADE 0x09
1728 #define GB_LIGHTS_TYPE_EVENT 0x0A
1729 #define GB_LIGHTS_TYPE_SET_FLASH_INTENSITY 0x0B
1730 #define GB_LIGHTS_TYPE_SET_FLASH_STROBE 0x0C
1731 #define GB_LIGHTS_TYPE_SET_FLASH_TIMEOUT 0x0D
1732 #define GB_LIGHTS_TYPE_GET_FLASH_FAULT 0x0E
1734 /* Greybus Light modes */
1737 * if you add any specific mode below, update also the
1738 * GB_CHANNEL_MODE_DEFINED_RANGE value accordingly
1740 #define GB_CHANNEL_MODE_NONE 0x00000000
1741 #define GB_CHANNEL_MODE_BATTERY 0x00000001
1742 #define GB_CHANNEL_MODE_POWER 0x00000002
1743 #define GB_CHANNEL_MODE_WIRELESS 0x00000004
1744 #define GB_CHANNEL_MODE_BLUETOOTH 0x00000008
1745 #define GB_CHANNEL_MODE_KEYBOARD 0x00000010
1746 #define GB_CHANNEL_MODE_BUTTONS 0x00000020
1747 #define GB_CHANNEL_MODE_NOTIFICATION 0x00000040
1748 #define GB_CHANNEL_MODE_ATTENTION 0x00000080
1749 #define GB_CHANNEL_MODE_FLASH 0x00000100
1750 #define GB_CHANNEL_MODE_TORCH 0x00000200
1751 #define GB_CHANNEL_MODE_INDICATOR 0x00000400
1753 /* Lights Mode valid bit values */
1754 #define GB_CHANNEL_MODE_DEFINED_RANGE 0x000004FF
1755 #define GB_CHANNEL_MODE_VENDOR_RANGE 0x00F00000
1757 /* Greybus Light Channels Flags */
1758 #define GB_LIGHT_CHANNEL_MULTICOLOR 0x00000001
1759 #define GB_LIGHT_CHANNEL_FADER 0x00000002
1760 #define GB_LIGHT_CHANNEL_BLINK 0x00000004
1762 /* get count of lights in module */
1763 struct gb_lights_get_lights_response {
1767 /* light config request payload */
1768 struct gb_lights_get_light_config_request {
1772 /* light config response payload */
1773 struct gb_lights_get_light_config_response {
1778 /* channel config request payload */
1779 struct gb_lights_get_channel_config_request {
1784 /* channel flash config request payload */
1785 struct gb_lights_get_channel_flash_config_request {
1790 /* channel config response payload */
1791 struct gb_lights_get_channel_config_response {
1792 __u8 max_brightness;
1795 __u8 color_name[32];
1800 /* channel flash config response payload */
1801 struct gb_lights_get_channel_flash_config_response {
1802 __le32 intensity_min_uA;
1803 __le32 intensity_max_uA;
1804 __le32 intensity_step_uA;
1805 __le32 timeout_min_us;
1806 __le32 timeout_max_us;
1807 __le32 timeout_step_us;
1810 /* blink request payload: response have no payload */
1811 struct gb_lights_blink_request {
1818 /* set brightness request payload: response have no payload */
1819 struct gb_lights_set_brightness_request {
1825 /* set color request payload: response have no payload */
1826 struct gb_lights_set_color_request {
1832 /* set fade request payload: response have no payload */
1833 struct gb_lights_set_fade_request {
1840 /* event request: generated by module */
1841 struct gb_lights_event_request {
1844 #define GB_LIGHTS_LIGHT_CONFIG 0x01
1847 /* set flash intensity request payload: response have no payload */
1848 struct gb_lights_set_flash_intensity_request {
1851 __le32 intensity_uA;
1854 /* set flash strobe state request payload: response have no payload */
1855 struct gb_lights_set_flash_strobe_request {
1861 /* set flash timeout request payload: response have no payload */
1862 struct gb_lights_set_flash_timeout_request {
1868 /* get flash fault request payload */
1869 struct gb_lights_get_flash_fault_request {
1874 /* get flash fault response payload */
1875 struct gb_lights_get_flash_fault_response {
1877 #define GB_LIGHTS_FLASH_FAULT_OVER_VOLTAGE 0x00000000
1878 #define GB_LIGHTS_FLASH_FAULT_TIMEOUT 0x00000001
1879 #define GB_LIGHTS_FLASH_FAULT_OVER_TEMPERATURE 0x00000002
1880 #define GB_LIGHTS_FLASH_FAULT_SHORT_CIRCUIT 0x00000004
1881 #define GB_LIGHTS_FLASH_FAULT_OVER_CURRENT 0x00000008
1882 #define GB_LIGHTS_FLASH_FAULT_INDICATOR 0x00000010
1883 #define GB_LIGHTS_FLASH_FAULT_UNDER_VOLTAGE 0x00000020
1884 #define GB_LIGHTS_FLASH_FAULT_INPUT_VOLTAGE 0x00000040
1885 #define GB_LIGHTS_FLASH_FAULT_LED_OVER_TEMPERATURE 0x00000080
1890 #define GB_AUDIO_TYPE_GET_TOPOLOGY_SIZE 0x02
1891 #define GB_AUDIO_TYPE_GET_TOPOLOGY 0x03
1892 #define GB_AUDIO_TYPE_GET_CONTROL 0x04
1893 #define GB_AUDIO_TYPE_SET_CONTROL 0x05
1894 #define GB_AUDIO_TYPE_ENABLE_WIDGET 0x06
1895 #define GB_AUDIO_TYPE_DISABLE_WIDGET 0x07
1896 #define GB_AUDIO_TYPE_GET_PCM 0x08
1897 #define GB_AUDIO_TYPE_SET_PCM 0x09
1898 #define GB_AUDIO_TYPE_SET_TX_DATA_SIZE 0x0a
1900 #define GB_AUDIO_TYPE_ACTIVATE_TX 0x0c
1901 #define GB_AUDIO_TYPE_DEACTIVATE_TX 0x0d
1902 #define GB_AUDIO_TYPE_SET_RX_DATA_SIZE 0x0e
1904 #define GB_AUDIO_TYPE_ACTIVATE_RX 0x10
1905 #define GB_AUDIO_TYPE_DEACTIVATE_RX 0x11
1906 #define GB_AUDIO_TYPE_JACK_EVENT 0x12
1907 #define GB_AUDIO_TYPE_BUTTON_EVENT 0x13
1908 #define GB_AUDIO_TYPE_STREAMING_EVENT 0x14
1909 #define GB_AUDIO_TYPE_SEND_DATA 0x15
1911 /* Module must be able to buffer 10ms of audio data, minimum */
1912 #define GB_AUDIO_SAMPLE_BUFFER_MIN_US 10000
1914 #define GB_AUDIO_PCM_NAME_MAX 32
1915 #define AUDIO_DAI_NAME_MAX 32
1916 #define AUDIO_CONTROL_NAME_MAX 32
1917 #define AUDIO_CTL_ELEM_NAME_MAX 44
1918 #define AUDIO_ENUM_NAME_MAX 64
1919 #define AUDIO_WIDGET_NAME_MAX 32
1921 /* See SNDRV_PCM_FMTBIT_* in Linux source */
1922 #define GB_AUDIO_PCM_FMT_S8 BIT(0)
1923 #define GB_AUDIO_PCM_FMT_U8 BIT(1)
1924 #define GB_AUDIO_PCM_FMT_S16_LE BIT(2)
1925 #define GB_AUDIO_PCM_FMT_S16_BE BIT(3)
1926 #define GB_AUDIO_PCM_FMT_U16_LE BIT(4)
1927 #define GB_AUDIO_PCM_FMT_U16_BE BIT(5)
1928 #define GB_AUDIO_PCM_FMT_S24_LE BIT(6)
1929 #define GB_AUDIO_PCM_FMT_S24_BE BIT(7)
1930 #define GB_AUDIO_PCM_FMT_U24_LE BIT(8)
1931 #define GB_AUDIO_PCM_FMT_U24_BE BIT(9)
1932 #define GB_AUDIO_PCM_FMT_S32_LE BIT(10)
1933 #define GB_AUDIO_PCM_FMT_S32_BE BIT(11)
1934 #define GB_AUDIO_PCM_FMT_U32_LE BIT(12)
1935 #define GB_AUDIO_PCM_FMT_U32_BE BIT(13)
1937 /* See SNDRV_PCM_RATE_* in Linux source */
1938 #define GB_AUDIO_PCM_RATE_5512 BIT(0)
1939 #define GB_AUDIO_PCM_RATE_8000 BIT(1)
1940 #define GB_AUDIO_PCM_RATE_11025 BIT(2)
1941 #define GB_AUDIO_PCM_RATE_16000 BIT(3)
1942 #define GB_AUDIO_PCM_RATE_22050 BIT(4)
1943 #define GB_AUDIO_PCM_RATE_32000 BIT(5)
1944 #define GB_AUDIO_PCM_RATE_44100 BIT(6)
1945 #define GB_AUDIO_PCM_RATE_48000 BIT(7)
1946 #define GB_AUDIO_PCM_RATE_64000 BIT(8)
1947 #define GB_AUDIO_PCM_RATE_88200 BIT(9)
1948 #define GB_AUDIO_PCM_RATE_96000 BIT(10)
1949 #define GB_AUDIO_PCM_RATE_176400 BIT(11)
1950 #define GB_AUDIO_PCM_RATE_192000 BIT(12)
1952 #define GB_AUDIO_STREAM_TYPE_CAPTURE 0x1
1953 #define GB_AUDIO_STREAM_TYPE_PLAYBACK 0x2
1955 #define GB_AUDIO_CTL_ELEM_ACCESS_READ BIT(0)
1956 #define GB_AUDIO_CTL_ELEM_ACCESS_WRITE BIT(1)
1958 /* See SNDRV_CTL_ELEM_TYPE_* in Linux source */
1959 #define GB_AUDIO_CTL_ELEM_TYPE_BOOLEAN 0x01
1960 #define GB_AUDIO_CTL_ELEM_TYPE_INTEGER 0x02
1961 #define GB_AUDIO_CTL_ELEM_TYPE_ENUMERATED 0x03
1962 #define GB_AUDIO_CTL_ELEM_TYPE_INTEGER64 0x06
1964 /* See SNDRV_CTL_ELEM_IFACE_* in Linux source */
1965 #define GB_AUDIO_CTL_ELEM_IFACE_CARD 0x00
1966 #define GB_AUDIO_CTL_ELEM_IFACE_HWDEP 0x01
1967 #define GB_AUDIO_CTL_ELEM_IFACE_MIXER 0x02
1968 #define GB_AUDIO_CTL_ELEM_IFACE_PCM 0x03
1969 #define GB_AUDIO_CTL_ELEM_IFACE_RAWMIDI 0x04
1970 #define GB_AUDIO_CTL_ELEM_IFACE_TIMER 0x05
1971 #define GB_AUDIO_CTL_ELEM_IFACE_SEQUENCER 0x06
1973 /* SNDRV_CTL_ELEM_ACCESS_* in Linux source */
1974 #define GB_AUDIO_ACCESS_READ BIT(0)
1975 #define GB_AUDIO_ACCESS_WRITE BIT(1)
1976 #define GB_AUDIO_ACCESS_VOLATILE BIT(2)
1977 #define GB_AUDIO_ACCESS_TIMESTAMP BIT(3)
1978 #define GB_AUDIO_ACCESS_TLV_READ BIT(4)
1979 #define GB_AUDIO_ACCESS_TLV_WRITE BIT(5)
1980 #define GB_AUDIO_ACCESS_TLV_COMMAND BIT(6)
1981 #define GB_AUDIO_ACCESS_INACTIVE BIT(7)
1982 #define GB_AUDIO_ACCESS_LOCK BIT(8)
1983 #define GB_AUDIO_ACCESS_OWNER BIT(9)
1985 /* enum snd_soc_dapm_type */
1986 #define GB_AUDIO_WIDGET_TYPE_INPUT 0x0
1987 #define GB_AUDIO_WIDGET_TYPE_OUTPUT 0x1
1988 #define GB_AUDIO_WIDGET_TYPE_MUX 0x2
1989 #define GB_AUDIO_WIDGET_TYPE_VIRT_MUX 0x3
1990 #define GB_AUDIO_WIDGET_TYPE_VALUE_MUX 0x4
1991 #define GB_AUDIO_WIDGET_TYPE_MIXER 0x5
1992 #define GB_AUDIO_WIDGET_TYPE_MIXER_NAMED_CTL 0x6
1993 #define GB_AUDIO_WIDGET_TYPE_PGA 0x7
1994 #define GB_AUDIO_WIDGET_TYPE_OUT_DRV 0x8
1995 #define GB_AUDIO_WIDGET_TYPE_ADC 0x9
1996 #define GB_AUDIO_WIDGET_TYPE_DAC 0xa
1997 #define GB_AUDIO_WIDGET_TYPE_MICBIAS 0xb
1998 #define GB_AUDIO_WIDGET_TYPE_MIC 0xc
1999 #define GB_AUDIO_WIDGET_TYPE_HP 0xd
2000 #define GB_AUDIO_WIDGET_TYPE_SPK 0xe
2001 #define GB_AUDIO_WIDGET_TYPE_LINE 0xf
2002 #define GB_AUDIO_WIDGET_TYPE_SWITCH 0x10
2003 #define GB_AUDIO_WIDGET_TYPE_VMID 0x11
2004 #define GB_AUDIO_WIDGET_TYPE_PRE 0x12
2005 #define GB_AUDIO_WIDGET_TYPE_POST 0x13
2006 #define GB_AUDIO_WIDGET_TYPE_SUPPLY 0x14
2007 #define GB_AUDIO_WIDGET_TYPE_REGULATOR_SUPPLY 0x15
2008 #define GB_AUDIO_WIDGET_TYPE_CLOCK_SUPPLY 0x16
2009 #define GB_AUDIO_WIDGET_TYPE_AIF_IN 0x17
2010 #define GB_AUDIO_WIDGET_TYPE_AIF_OUT 0x18
2011 #define GB_AUDIO_WIDGET_TYPE_SIGGEN 0x19
2012 #define GB_AUDIO_WIDGET_TYPE_DAI_IN 0x1a
2013 #define GB_AUDIO_WIDGET_TYPE_DAI_OUT 0x1b
2014 #define GB_AUDIO_WIDGET_TYPE_DAI_LINK 0x1c
2016 #define GB_AUDIO_WIDGET_STATE_DISABLED 0x01
2017 #define GB_AUDIO_WIDGET_STATE_ENAABLED 0x02
2019 #define GB_AUDIO_JACK_EVENT_INSERTION 0x1
2020 #define GB_AUDIO_JACK_EVENT_REMOVAL 0x2
2022 #define GB_AUDIO_BUTTON_EVENT_PRESS 0x1
2023 #define GB_AUDIO_BUTTON_EVENT_RELEASE 0x2
2025 #define GB_AUDIO_STREAMING_EVENT_UNSPECIFIED 0x1
2026 #define GB_AUDIO_STREAMING_EVENT_HALT 0x2
2027 #define GB_AUDIO_STREAMING_EVENT_INTERNAL_ERROR 0x3
2028 #define GB_AUDIO_STREAMING_EVENT_PROTOCOL_ERROR 0x4
2029 #define GB_AUDIO_STREAMING_EVENT_FAILURE 0x5
2030 #define GB_AUDIO_STREAMING_EVENT_UNDERRUN 0x6
2031 #define GB_AUDIO_STREAMING_EVENT_OVERRUN 0x7
2032 #define GB_AUDIO_STREAMING_EVENT_CLOCKING 0x8
2033 #define GB_AUDIO_STREAMING_EVENT_DATA_LEN 0x9
2035 #define GB_AUDIO_INVALID_INDEX 0xff
2037 struct gb_audio_pcm {
2038 __u8 stream_name[GB_AUDIO_PCM_NAME_MAX];
2039 __le32 formats; /* GB_AUDIO_PCM_FMT_* */
2040 __le32 rates; /* GB_AUDIO_PCM_RATE_* */
2043 __u8 sig_bits; /* number of bits of content */
2046 struct gb_audio_dai {
2047 __u8 name[AUDIO_DAI_NAME_MAX];
2049 struct gb_audio_pcm capture;
2050 struct gb_audio_pcm playback;
2053 struct gb_audio_integer {
2059 struct gb_audio_integer64 {
2065 struct gb_audio_enumerated {
2067 __le16 names_length;
2071 struct gb_audio_ctl_elem_info { /* See snd_ctl_elem_info in Linux source */
2072 __u8 type; /* GB_AUDIO_CTL_ELEM_TYPE_* */
2075 struct gb_audio_integer integer;
2076 struct gb_audio_integer64 integer64;
2077 struct gb_audio_enumerated enumerated;
2081 struct gb_audio_ctl_elem_value { /* See snd_ctl_elem_value in Linux source */
2082 __le64 timestamp; /* XXX needed? */
2084 __le32 integer_value[2]; /* consider CTL_DOUBLE_xxx */
2085 __le64 integer64_value[2];
2086 __le32 enumerated_item[2];
2090 struct gb_audio_control {
2091 __u8 name[AUDIO_CONTROL_NAME_MAX];
2093 __u8 iface; /* GB_AUDIO_IFACE_* */
2095 __le32 access; /* GB_AUDIO_ACCESS_* */
2096 __u8 count; /* count of same elements */
2097 __u8 count_values; /* count of values, max=2 for CTL_DOUBLE_xxx */
2098 struct gb_audio_ctl_elem_info info;
2101 struct gb_audio_widget {
2102 __u8 name[AUDIO_WIDGET_NAME_MAX];
2103 __u8 sname[AUDIO_WIDGET_NAME_MAX];
2105 __u8 type; /* GB_AUDIO_WIDGET_TYPE_* */
2106 __u8 state; /* GB_AUDIO_WIDGET_STATE_* */
2108 struct gb_audio_control ctl[0]; /* 'ncontrols' entries */
2111 struct gb_audio_route {
2112 __u8 source_id; /* widget id */
2113 __u8 destination_id; /* widget id */
2114 __u8 control_id; /* 0-63 */
2115 __u8 index; /* Selection within the control */
2118 struct gb_audio_topology {
2124 __le32 size_controls;
2125 __le32 size_widgets;
2128 * struct gb_audio_dai dai[num_dais];
2129 * struct gb_audio_control controls[num_controls];
2130 * struct gb_audio_widget widgets[num_widgets];
2131 * struct gb_audio_route routes[num_routes];
2136 struct gb_audio_get_topology_size_response {
2140 struct gb_audio_get_topology_response {
2141 struct gb_audio_topology topology;
2144 struct gb_audio_get_control_request {
2149 struct gb_audio_get_control_response {
2150 struct gb_audio_ctl_elem_value value;
2153 struct gb_audio_set_control_request {
2156 struct gb_audio_ctl_elem_value value;
2159 struct gb_audio_enable_widget_request {
2163 struct gb_audio_disable_widget_request {
2167 struct gb_audio_get_pcm_request {
2171 struct gb_audio_get_pcm_response {
2178 struct gb_audio_set_pcm_request {
2186 struct gb_audio_set_tx_data_size_request {
2191 struct gb_audio_activate_tx_request {
2195 struct gb_audio_deactivate_tx_request {
2199 struct gb_audio_set_rx_data_size_request {
2204 struct gb_audio_activate_rx_request {
2208 struct gb_audio_deactivate_rx_request {
2212 struct gb_audio_jack_event_request {
2214 __u8 jack_attribute;
2218 struct gb_audio_button_event_request {
2224 struct gb_audio_streaming_event_request {
2229 struct gb_audio_send_data_request {
2238 #define GB_LOG_TYPE_SEND_LOG 0x02
2241 #define GB_LOG_MAX_LEN 1024
2243 struct gb_log_send_log_request {
2248 #endif /* __GREYBUS_PROTOCOLS_H */