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
86  * @SDW_SLAVE_UNATTACHED: Slave is not attached with the bus.
87  * @SDW_SLAVE_ATTACHED: Slave is attached with bus.
88  * @SDW_SLAVE_ALERT: Some alert condition on the Slave
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
200  * enum sdw_p15_behave - Slave Port 15 behaviour when the Master attempts a
211  * enum sdw_dpn_type - Data port types
226  * enum sdw_clk_stop_mode - Clock Stop modes
227  * @SDW_CLK_STOP_MODE0: Slave can continue operation seamlessly on clock
229  * @SDW_CLK_STOP_MODE1: Slave may have entered a deeper power-saving mode,
238  * struct sdw_dp0_prop - DP0 properties
245  * @ch_prep_timeout: Port-specific timeout value, in milliseconds
246  * @BRA_flow_controlled: Slave implementation results in an OK_NotReady
250  * implementation-defined interrupts
272  * struct sdw_dpn_prop - Data Port DPn properties
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
343  * @reset_behave: Slave keeps the status of the SlaveStopClockPrepare
344  * state machine (P=1 SCSP_SM) after exit from clock-stop mode1
345  * @high_PHY_capable: Slave is HighPHY capable
346  * @paging_support: Slave implements paging registers SCP_AddrPage1 and
348  * @bank_delay_support: Slave implements bank delay/bridge support registers
350  * @lane_control_support: Slave supports lane control
351  * @p15_behave: Slave behavior when the Master attempts a read to the Port15
353  * @master_count: Number of Masters present on this Slave
361  * @lane_maps: Lane mapping for the slave, only valid if lane_control_support is set
365  * @use_domain_irq: call actual IRQ handler on slave, as well as callback
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
446  * Some Slave devices have known issues with incorrect parity errors
448  * parity errors can be reported by Slave devices, possibly due to electrical
456 int sdw_slave_read_prop(struct sdw_slave *slave);
457 int sdw_slave_read_lane_mapping(struct sdw_slave *slave);
460  * SDW Slave Structures and APIs
466  * struct sdw_slave_id - Slave ID
489  * Helper macros to extract the MIPI-defined IDs
510 #define SDW_DISCO_LINK_ID(addr)	FIELD_GET(SDW_DISCO_LINK_ID_MASK, addr)  argument
511 #define SDW_VERSION(addr)	FIELD_GET(SDW_VERSION_MASK, addr)  argument
512 #define SDW_UNIQUE_ID(addr)	FIELD_GET(SDW_UNIQUE_ID_MASK, addr)  argument
513 #define SDW_MFG_ID(addr)	FIELD_GET(SDW_MFG_ID_MASK, addr)  argument
514 #define SDW_PART_ID(addr)	FIELD_GET(SDW_PART_ID_MASK, addr)  argument
515 #define SDW_CLASS_ID(addr)	FIELD_GET(SDW_CLASS_ID_MASK, addr)  argument
518  * struct sdw_slave_intr_status - Slave interrupt status
519  * @sdca_cascade: set if the Slave device reports an SDCA interrupt
530  * sdw_reg_bank - SoundWire register banks
540  * struct sdw_prepare_ch: Prepare/De-prepare Data Port channel
544  * @prepare: Prepare (true) /de-prepare (false) channel
545  * @bank: Register bank, which bank Slave/Master driver should program for
583  * @s_data_mode: NORMAL, STATIC or PRBS mode for all Slave ports
601  * struct sdw_slave_ops: Slave driver callback ops
603  * @read_prop: Read Slave properties
606  * @update_status: Update Slave status
607  * @bus_config: Update the bus config for Slave
609  * @clk_stop: handle imp-def sequences before and after prepare and de-prepare
613 	int (*interrupt_callback)(struct sdw_slave *slave,
615 	int (*update_status)(struct sdw_slave *slave,
617 	int (*bus_config)(struct sdw_slave *slave,
619 	int (*port_prep)(struct sdw_slave *slave,
622 	int (*clk_stop)(struct sdw_slave *slave,
628  * struct sdw_slave - SoundWire Slave
632  * @status: Status reported by the Slave
634  * @prop: Slave properties
635  * @debugfs: Slave debugfs
637  * @port_ready: Port ready completion flag for each Slave port
638  * @m_port_map: static Master port map for each Slave port
640  * @dev_num_sticky: one-time static Device Number assigned by Bus
644  * Slave device
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
650  * when the Master triggered a reset the Slave is properly enumerated and
653  * for a Slave happens for the first time after enumeration
687  * struct sdw_master_device - SoundWire 'Master Device' representation
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
843 	u64 (*override_adr)(struct sdw_bus *bus, u64 addr);
851 	int (*get_device_num)(struct sdw_bus *bus, struct sdw_slave *slave);
852 	void (*put_device_num)(struct sdw_bus *bus, struct sdw_slave *slave);
854 					struct sdw_slave *slave,
865  * sdw_port_config: Master or Slave Port configuration
876  * sdw_stream_config: Master or Slave stream configuration
900  * @SDW_STREAM_DEPREPARED: Stream de-prepared
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
975  * @assigned: Bitmap for Slave device numbers.
1042 int sdw_compare_devid(struct sdw_slave *slave, struct sdw_slave_id id);
1043 void sdw_extract_slave_id(struct sdw_bus *bus, u64 addr, struct sdw_slave_id *id);
1044 bool is_clock_scaling_supported_by_slave(struct sdw_slave *slave);
1048 int sdw_stream_add_slave(struct sdw_slave *slave,
1053 int sdw_stream_remove_slave(struct sdw_slave *slave,
1056 int sdw_slave_get_scale_index(struct sdw_slave *slave, u8 *base);
1059 int sdw_read(struct sdw_slave *slave, u32 addr);
1060 int sdw_write(struct sdw_slave *slave, u32 addr, u8 value);
1061 int sdw_write_no_pm(struct sdw_slave *slave, u32 addr, u8 value);
1062 int sdw_read_no_pm(struct sdw_slave *slave, u32 addr);
1063 int sdw_nread(struct sdw_slave *slave, u32 addr, size_t count, u8 *val);
1064 int sdw_nread_no_pm(struct sdw_slave *slave, u32 addr, size_t count, u8 *val);
1065 int sdw_nwrite(struct sdw_slave *slave, u32 addr, size_t count, const u8 *val);
1066 int sdw_nwrite_no_pm(struct sdw_slave *slave, u32 addr, size_t count, const u8 *val);
1067 int sdw_update(struct sdw_slave *slave, u32 addr, u8 mask, u8 val);
1068 int sdw_update_no_pm(struct sdw_slave *slave, u32 addr, u8 mask, u8 val);
1072 static inline int sdw_stream_add_slave(struct sdw_slave *slave,  in sdw_stream_add_slave()  argument
1079 	return -EINVAL;  in sdw_stream_add_slave()
1082 static inline int sdw_stream_remove_slave(struct sdw_slave *slave,  in sdw_stream_remove_slave()  argument
1086 	return -EINVAL;  in sdw_stream_remove_slave()
1090 static inline int sdw_read(struct sdw_slave *slave, u32 addr)  in sdw_read()  argument
1093 	return -EINVAL;  in sdw_read()
1096 static inline int sdw_write(struct sdw_slave *slave, u32 addr, u8 value)  in sdw_write()  argument
1099 	return -EINVAL;  in sdw_write()
1102 static inline int sdw_write_no_pm(struct sdw_slave *slave, u32 addr, u8 value)  in sdw_write_no_pm()  argument
1105 	return -EINVAL;  in sdw_write_no_pm()
1108 static inline int sdw_read_no_pm(struct sdw_slave *slave, u32 addr)  in sdw_read_no_pm()  argument
1111 	return -EINVAL;  in sdw_read_no_pm()
1114 static inline int sdw_nread(struct sdw_slave *slave, u32 addr, size_t count, u8 *val)  in sdw_nread()  argument
1117 	return -EINVAL;  in sdw_nread()
1120 static inline int sdw_nread_no_pm(struct sdw_slave *slave, u32 addr, size_t count, u8 *val)  in sdw_nread_no_pm()  argument
1123 	return -EINVAL;  in sdw_nread_no_pm()
1126 static inline int sdw_nwrite(struct sdw_slave *slave, u32 addr, size_t count, const u8 *val)  in sdw_nwrite()  argument
1129 	return -EINVAL;  in sdw_nwrite()
1132 static inline int sdw_nwrite_no_pm(struct sdw_slave *slave, u32 addr, size_t count, const u8 *val)  in sdw_nwrite_no_pm()  argument
1135 	return -EINVAL;  in sdw_nwrite_no_pm()
1138 static inline int sdw_update(struct sdw_slave *slave, u32 addr, u8 mask, u8 val)  in sdw_update()  argument
1141 	return -EINVAL;  in sdw_update()
1144 static inline int sdw_update_no_pm(struct sdw_slave *slave, u32 addr, u8 mask, u8 val)  in sdw_update_no_pm()  argument
1147 	return -EINVAL;  in sdw_update_no_pm()