1 /* SPDX-License-Identifier: (GPL-2.0 OR BSD-3-Clause) */
2 /* Copyright(c) 2015-17 Intel Corporation. */
55 #define SDW_VALID_PORT_RANGE(n)		((n) < SDW_MAX_PORTS && (n) >= 1)
77 #define SDW_PORT_FLOW_MODE_RX_CNTRL	BIT(1)
78 #define SDW_PORT_FLOW_MODE_ASYNC	GENMASK(1, 0)
82 #define SDW_BLOCK_PACKG_PER_CH		BIT(1)
85  * enum sdw_slave_status - Slave status
93 	SDW_SLAVE_ATTACHED = 1,
103  * @SDW_CLK_PRE_DEPREPARE: pre clock stop de-prepare
104  * @SDW_CLK_POST_DEPREPARE: post clock stop de-prepare
114  * enum sdw_command_response - Command response as defined by SDW spec
128 	SDW_CMD_IGNORED = 1,
137 	SDW_BLK_GRP_CNT_2 = 1,
145 	SDW_BLK_PKG_PER_CHANNEL = 1
158 	SDW_STREAM_PDM = 1,
169 	SDW_DATA_DIR_TX = 1,
182  * logic 1. The encoding will result in signal transitions at every bitslot
187 	SDW_PORT_DATA_MODE_PRBS = 1,
196 	SDW_CLK_STOP_KEEP_STATUS = 1,
200  * enum sdw_p15_behave - Slave Port 15 behaviour when the Master attempts a
207 	SDW_P15_CMD_OK = 1,
211  * enum sdw_dpn_type - Data port types
221 	SDW_DPN_SIMPLE = 1,
226  * enum sdw_clk_stop_mode - Clock Stop modes
229  * @SDW_CLK_STOP_MODE1: Slave may have entered a deeper power-saving mode,
234 	SDW_CLK_STOP_MODE1 = 1,
238  * struct sdw_dp0_prop - DP0 properties
240  * @max_word: Maximum number of bits in a Payload Channel Sample, 1 to 64
242  * @min_word: Minimum number of bits in a Payload Channel Sample, 1 to 64
245  * @ch_prep_timeout: Port-specific timeout value, in milliseconds
250  * implementation-defined interrupts
272  * struct sdw_dpn_prop - Data Port DPn properties
274  * @max_word: Maximum number of bits in a Payload Channel Sample, 1 to 64
276  * @min_word: Minimum number of bits in a Payload Channel Sample, 1 to 64
283  * @ch_prep_timeout: Port-specific timeout value, in milliseconds
285  * implementation-defined interrupts
330  * struct sdw_slave_prop - SoundWire Slave properties
335  * @wake_capable: Wake-up events are supported
337  * @clk_stop_mode1: Clock-Stop Mode 1 is supported
339  * @clk_stop_timeout: Worst-case latency of the Clock Stop Prepare State
341  * @ch_prep_timeout: Worst-case latency of the Channel Prepare State Machine
344  * state machine (P=1 SCSP_SM) after exit from clock-stop mode1
399  * struct sdw_master_prop - Master properties
404  * @clk_stop_modes: Bitmap, bit N set when clock-stop-modeN supported
415  * @hw_disabled: if true, the Master is not functional, typically due to pin-mux
453 #define SDW_MASTER_QUIRKS_CLEAR_INITIAL_PARITY	BIT(1)
466  * struct sdw_slave_id - Slave ID
489  * Helper macros to extract the MIPI-defined IDs
518  * struct sdw_slave_intr_status - Slave interrupt status
530  * sdw_reg_bank - SoundWire register banks
532  * @SDW_BANK1: Soundwire register bank 1
540  * struct sdw_prepare_ch: Prepare/De-prepare Data Port channel
544  * @prepare: Prepare (true) /de-prepare (false) channel
609  * @clk_stop: handle imp-def sequences before and after prepare and de-prepare
628  * struct sdw_slave - SoundWire Slave
640  * @dev_num_sticky: one-time static Device Number assigned by Bus
643  * on startup between device enumeration and read/write access to the
647  * @unattach_request: mask field to keep track why the Slave re-attached and
648  * was re-initialized. This is useful to deal with potential race conditions
687  * struct sdw_master_device - SoundWire 'Master Device' representation
729  * @bps: Word length of the Port
738 	unsigned int bps;  member
814  * struct sdw_defer - SDW deferred message
826  * struct sdw_master_ops - Master driver ops
837  * @get_device_num: Callback for vendor-specific device_number allocation
838  * @put_device_num: Callback for vendor-specific device_number release
880  * @bps: Number of bits per audio sample
887 	unsigned int bps;  member
900  * @SDW_STREAM_DEPREPARED: Stream de-prepared
905 	SDW_STREAM_CONFIGURED = 1,
918  * @bps: bits per channel sample
923 	unsigned int bps;  member
948  * struct sdw_bus - SoundWire bus
949  * @dev: Shortcut to &bus->md->dev to avoid changing the entire code.
965  * @vendor_specific_prop: pointer to non-standard properties
967  * hardware-based synchronization is required. This value is only
968  * meaningful if multi_link is set. If set to 1, hardware-based
971  * @controller_id: system-unique controller ID. If set to -1, the bus @id will be used.
973  * @id: bus system-wide unique id
1078 	WARN_ONCE(1, "SoundWire API is disabled");  in sdw_stream_add_slave()
1079 	return -EINVAL;  in sdw_stream_add_slave()
1085 	WARN_ONCE(1, "SoundWire API is disabled");  in sdw_stream_remove_slave()
1086 	return -EINVAL;  in sdw_stream_remove_slave()
1092 	WARN_ONCE(1, "SoundWire API is disabled");  in sdw_read()
1093 	return -EINVAL;  in sdw_read()
1098 	WARN_ONCE(1, "SoundWire API is disabled");  in sdw_write()
1099 	return -EINVAL;  in sdw_write()
1104 	WARN_ONCE(1, "SoundWire API is disabled");  in sdw_write_no_pm()
1105 	return -EINVAL;  in sdw_write_no_pm()
1110 	WARN_ONCE(1, "SoundWire API is disabled");  in sdw_read_no_pm()
1111 	return -EINVAL;  in sdw_read_no_pm()
1116 	WARN_ONCE(1, "SoundWire API is disabled");  in sdw_nread()
1117 	return -EINVAL;  in sdw_nread()
1122 	WARN_ONCE(1, "SoundWire API is disabled");  in sdw_nread_no_pm()
1123 	return -EINVAL;  in sdw_nread_no_pm()
1128 	WARN_ONCE(1, "SoundWire API is disabled");  in sdw_nwrite()
1129 	return -EINVAL;  in sdw_nwrite()
1134 	WARN_ONCE(1, "SoundWire API is disabled");  in sdw_nwrite_no_pm()
1135 	return -EINVAL;  in sdw_nwrite_no_pm()
1140 	WARN_ONCE(1, "SoundWire API is disabled");  in sdw_update()
1141 	return -EINVAL;  in sdw_update()
1146 	WARN_ONCE(1, "SoundWire API is disabled");  in sdw_update_no_pm()
1147 	return -EINVAL;  in sdw_update_no_pm()