linux/soundwire/sdw.h

1 /* SPDX-License-Identifier: (GPL-2.0 OR BSD-3-Clause) */
2 /* Copyright(c) 2015-17 Intel Corporation. */
17 /* SDW spec defines and enums, as defined by MIPI 1.1. Spec */
75  * enum sdw_slave_status - Slave status
93  * @SDW_CLK_PRE_DEPREPARE: pre clock stop de-prepare
94  * @SDW_CLK_POST_DEPREPARE: post clock stop de-prepare
104  * enum sdw_command_response - Command response as defined by SDW spec
114  * SDW_CMD_TIMEOUT/FAIL_OTHER is defined for SW use, not in spec
144  * spec doesn't define this, but is used in implementation
183  * SDW properties, defined in MIPI DisCo spec v1.0
190  * enum sdw_p15_behave - Slave Port 15 behaviour when the Master attempts a
201  * enum sdw_dpn_type - Data port types
203  * @SDW_DPN_SIMPLE: Simplified Data Port as defined in spec.
206  * @SDW_DPN_REDUCED: Reduced Data Port as defined in spec.
216  * enum sdw_clk_stop_mode - Clock Stop modes
219  * @SDW_CLK_STOP_MODE1: Slave may have entered a deeper power-saving mode,
228  * struct sdw_dp0_prop - DP0 properties
235  * @BRA_flow_controlled: Slave implementation results in an OK_NotReady
239  * implementation-defined interrupts
242  * discrete values, implementation can define based on the wordlengths they
256  * struct sdw_dpn_audio_mode - Audio mode properties for DPn
288  * struct sdw_dpn_prop - Data Port DPn properties
301  * @ch_prep_timeout: Port-specific timeout value, in milliseconds
303  * implementation-defined interrupts
344  * struct sdw_slave_prop - SoundWire Slave properties
345  * @mipi_revision: Spec version of the implementation
346  * @wake_capable: Wake-up events are supported
348  * @clk_stop_mode1: Clock-Stop Mode 1 is supported
350  * @clk_stop_timeout: Worst-case latency of the Clock Stop Prepare State
352  * @ch_prep_timeout: Worst-case latency of the Channel Prepare State Machine
355  * state machine (P=1 SCSP_SM) after exit from clock-stop mode1
406  * struct sdw_master_prop - Master properties
407  * @revision: MIPI spec version of the implementation
408  * @clk_stop_modes: Bitmap, bit N set when clock-stop-modeN supported
421  * @hw_disabled: if true, the Master is not functional, typically due to pin-mux
472  * struct sdw_slave_id - Slave ID
475  * @class_id: MIPI Class ID (defined starting with SoundWire 1.2 spec)
495  * Helper macros to extract the MIPI-defined IDs
524  * struct sdw_slave_intr_status - Slave interrupt status
536  * sdw_reg_bank - SoundWire register banks
561  * struct sdw_prepare_ch: Prepare/De-prepare Data Port channel
565  * @prepare: Prepare (true) /de-prepare (false) channel
567  * implementation defined registers. This is always updated to next_bank
630  * @clk_stop: handle imp-def sequences before and after prepare and de-prepare
650  * struct sdw_slave - SoundWire Slave
662  * @dev_num_sticky: one-time static Device Number assigned by Bus
669  * @unattach_request: mask field to keep track why the Slave re-attached and
670  * was re-initialized. This is useful to deal with potential race conditions
707  * struct sdw_master_device - SoundWire 'Master Device' representation
838  * struct sdw_defer - SDW deffered message
850  * struct sdw_master_ops - Master driver ops
861  * @get_device_num: Callback for vendor-specific device_number allocation
862  * @put_device_num: Callback for vendor-specific device_number release
886  * struct sdw_bus - SoundWire bus
887  * @dev: Shortcut to &bus->md->dev to avoid changing the entire code.
889  * @controller_id: system-unique controller ID. If set to -1, the bus @id will be used.
891  * @id: bus system-wide unique id
897  * @compute_params: points to Bus resource management implementation
914  * hardware-based synchronization is required. This value is only
915  * meaningful if multi_link is set. If set to 1, hardware-based
991  * @SDW_STREAM_DEPREPARED: Stream de-prepared
1094 	return -EINVAL;  in sdw_stream_add_slave()
1101 	return -EINVAL;  in sdw_stream_remove_slave()
1108 	return -EINVAL;  in sdw_read()
1114 	return -EINVAL;  in sdw_write()
1120 	return -EINVAL;  in sdw_write_no_pm()
1126 	return -EINVAL;  in sdw_read_no_pm()
1132 	return -EINVAL;  in sdw_nread()
1138 	return -EINVAL;  in sdw_nread_no_pm()
1144 	return -EINVAL;  in sdw_nwrite()
1150 	return -EINVAL;  in sdw_nwrite_no_pm()
1156 	return -EINVAL;  in sdw_update()
1162 	return -EINVAL;  in sdw_update_no_pm()