linux/soundwire/sdw.h

1 /* SPDX-License-Identifier: (GPL-2.0 OR BSD-3-Clause) */
2 /* Copyright(c) 2015-17 Intel Corporation. */
85  * enum sdw_slave_status - Slave status
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
122  * combination of ACK/NAK bits
202  * enum sdw_p15_behave - Slave Port 15 behaviour when the Master attempts a
213  * enum sdw_dpn_type - Data port types
228  * enum sdw_clk_stop_mode - Clock Stop modes
231  * @SDW_CLK_STOP_MODE1: Slave may have entered a deeper power-saving mode,
240  * struct sdw_dp0_prop - DP0 properties
242  * @max_word: Maximum number of bits in a Payload Channel Sample, 1 to 64
244  * @min_word: Minimum number of bits in a Payload Channel Sample, 1 to 64
247  * @ch_prep_timeout: Port-specific timeout value, in milliseconds
252  * implementation-defined interrupts
274  * struct sdw_dpn_prop - Data Port DPn properties
275  * @num: port number
276  * @max_word: Maximum number of bits in a Payload Channel Sample, 1 to 64
278  * @min_word: Minimum number of bits in a Payload Channel Sample, 1 to 64
285  * @ch_prep_timeout: Port-specific timeout value, in milliseconds
287  * implementation-defined interrupts
306 	u32 num;  member
332  * struct sdw_slave_prop - SoundWire Slave properties
337  * @wake_capable: Wake-up events are supported
339  * @clk_stop_mode1: Clock-Stop Mode 1 is supported
341  * @clk_stop_timeout: Worst-case latency of the Clock Stop Prepare State
343  * @ch_prep_timeout: Worst-case latency of the Channel Prepare State Machine
346  * state machine (P=1 SCSP_SM) after exit from clock-stop mode1
401  * struct sdw_master_prop - Master properties
406  * @clk_stop_modes: Bitmap, bit N set when clock-stop-modeN supported
417  * @hw_disabled: if true, the Master is not functional, typically due to pin-mux
468  * struct sdw_slave_id - Slave ID
491  * Helper macros to extract the MIPI-defined IDs
503  * The MIPI DisCo for SoundWire defines in addition the link_id as bits 51:48
520  * struct sdw_slave_intr_status - Slave interrupt status
532  * sdw_reg_bank - SoundWire register banks
542  * struct sdw_prepare_ch: Prepare/De-prepare Data Port channel
544  * @num: Port number
546  * @prepare: Prepare (true) /de-prepare (false) channel
553 	unsigned int num;  member
611  * @clk_stop: handle imp-def sequences before and after prepare and de-prepare
630  * struct sdw_slave - SoundWire Slave
642  * @dev_num_sticky: one-time static Device Number assigned by Bus
649  * @unattach_request: mask field to keep track why the Slave re-attached and
650  * was re-initialized. This is useful to deal with potential race conditions
689  * struct sdw_master_device - SoundWire 'Master Device' representation
730  * @num: Port number
739 	unsigned int num;  member
749  * @num: Port number
757  * @lane_ctrl: Data lane Port uses for Data transfer. Currently only single
780  * @num: Port number
816  * struct sdw_defer - SDW deferred message
828  * Add a practical limit to BPT transfer sizes. BPT is typically used
829  * to transfer firmware, and larger firmware transfers will increase
837  * struct sdw_master_ops - Master driver ops
840  * @xfer_msg: Transfer message callback
841  * @xfer_msg_defer: Defer version of transfer message callback. The message is handled with the
846  * @read_ping_status: Read status from PING frames, reported with two bits per Device.
847  * Bits 31:24 are reserved.
848  * @get_device_num: Callback for vendor-specific device_number allocation
849  * @put_device_num: Callback for vendor-specific device_number release
885  * @num: Port number
889 	unsigned int num;  member
898  * @bps: Number of bits per audio sample
918  * @SDW_STREAM_DEPREPARED: Stream de-prepared
936  * @bps: bits per channel sample
966  * struct sdw_bus - SoundWire bus
967  * @dev: Shortcut to &bus->md->dev to avoid changing the entire code.
986  * @vendor_specific_prop: pointer to non-standard properties
988  * hardware-based synchronization is required. This value is only
989  * meaningful if multi_link is set. If set to 1, hardware-based
992  * @controller_id: system-unique controller ID. If set to -1, the bus @id will be used.
994  * @id: bus system-wide unique id
1006  * @lane_used_bandwidth: how much bandwidth in bits per second is used by each lane
1106 	return -EINVAL;  in sdw_stream_add_slave()
1113 	return -EINVAL;  in sdw_stream_remove_slave()
1120 	return -EINVAL;  in sdw_read()
1126 	return -EINVAL;  in sdw_write()
1132 	return -EINVAL;  in sdw_write_no_pm()
1138 	return -EINVAL;  in sdw_read_no_pm()
1144 	return -EINVAL;  in sdw_nread()
1150 	return -EINVAL;  in sdw_nread_no_pm()
1156 	return -EINVAL;  in sdw_nwrite()
1162 	return -EINVAL;  in sdw_nwrite_no_pm()
1168 	return -EINVAL;  in sdw_update()
1174 	return -EINVAL;  in sdw_update_no_pm()