1 /* SPDX-License-Identifier: (GPL-2.0 OR BSD-3-Clause) */
2 /* Copyright(c) 2015-17 Intel Corporation. */
3 #include <sound/soc.h>
4 
5 #ifndef __SDW_CADENCE_H
6 #define __SDW_CADENCE_H
7 
8 #define SDW_CADENCE_GSYNC_KHZ		4 /* 4 kHz */
9 #define SDW_CADENCE_GSYNC_HZ		(SDW_CADENCE_GSYNC_KHZ * 1000)
10 
11 /*
12  * The Cadence IP supports up to 32 entries in the FIFO, though implementations
13  * can configure the IP to have a smaller FIFO.
14  */
15 #define CDNS_MCP_IP_MAX_CMD_LEN		32
16 
17 /**
18  * struct sdw_cdns_pdi: PDI (Physical Data Interface) instance
19  *
20  * @num: pdi number
21  * @intel_alh_id: link identifier
22  * @l_ch_num: low channel for PDI
23  * @h_ch_num: high channel for PDI
24  * @ch_count: total channel count for PDI
25  * @dir: data direction
26  * @type: stream type, (only PCM supported)
27  */
28 struct sdw_cdns_pdi {
29 	int num;
30 	int intel_alh_id;
31 	int l_ch_num;
32 	int h_ch_num;
33 	int ch_count;
34 	enum sdw_data_direction dir;
35 	enum sdw_stream_type type;
36 };
37 
38 /**
39  * struct sdw_cdns_streams: Cadence stream data structure
40  *
41  * @num_bd: number of bidirectional streams
42  * @num_in: number of input streams
43  * @num_out: number of output streams
44  * @num_ch_bd: number of bidirectional stream channels
45  * @num_ch_bd: number of input stream channels
46  * @num_ch_bd: number of output stream channels
47  * @num_pdi: total number of PDIs
48  * @bd: bidirectional streams
49  * @in: input streams
50  * @out: output streams
51  */
52 struct sdw_cdns_streams {
53 	unsigned int num_bd;
54 	unsigned int num_in;
55 	unsigned int num_out;
56 	unsigned int num_ch_bd;
57 	unsigned int num_ch_in;
58 	unsigned int num_ch_out;
59 	unsigned int num_pdi;
60 	struct sdw_cdns_pdi *bd;
61 	struct sdw_cdns_pdi *in;
62 	struct sdw_cdns_pdi *out;
63 };
64 
65 /**
66  * struct sdw_cdns_stream_config: stream configuration
67  *
68  * @pcm_bd: number of bidirectional PCM streams supported
69  * @pcm_in: number of input PCM streams supported
70  * @pcm_out: number of output PCM streams supported
71  */
72 struct sdw_cdns_stream_config {
73 	unsigned int pcm_bd;
74 	unsigned int pcm_in;
75 	unsigned int pcm_out;
76 };
77 
78 /**
79  * struct sdw_cdns_dai_runtime: Cadence DAI runtime data
80  *
81  * @name: SoundWire stream name
82  * @stream: stream runtime
83  * @pdi: PDI used for this dai
84  * @bus: Bus handle
85  * @stream_type: Stream type
86  * @link_id: Master link id
87  * @hw_params: hw_params to be applied in .prepare step
88  * @suspended: status set when suspended, to be used in .prepare
89  * @paused: status set in .trigger, to be used in suspend
90  * @direction: stream direction
91  */
92 struct sdw_cdns_dai_runtime {
93 	char *name;
94 	struct sdw_stream_runtime *stream;
95 	struct sdw_cdns_pdi *pdi;
96 	struct sdw_bus *bus;
97 	enum sdw_stream_type stream_type;
98 	int link_id;
99 	struct snd_pcm_hw_params *hw_params;
100 	bool suspended;
101 	bool paused;
102 	int direction;
103 };
104 
105 /**
106  * struct sdw_cdns - Cadence driver context
107  * @dev: Linux device
108  * @bus: Bus handle
109  * @instance: instance number
110  * @response_buf: SoundWire response buffer
111  * @tx_complete: Tx completion
112  * @ports: Data ports
113  * @num_ports: Total number of data ports
114  * @pcm: PCM streams
115  * @registers: Cadence registers
116  * @link_up: Link status
117  * @msg_count: Messages sent on bus
118  * @dai_runtime_array: runtime context for each allocated DAI.
119  */
120 struct sdw_cdns {
121 	struct device *dev;
122 	struct sdw_bus bus;
123 	unsigned int instance;
124 
125 	/*
126 	 * The datasheet says the RX FIFO AVAIL can be 2 entries more
127 	 * than the FIFO capacity, so allow for this.
128 	 */
129 	u32 response_buf[CDNS_MCP_IP_MAX_CMD_LEN + 2];
130 
131 	struct completion tx_complete;
132 
133 	struct sdw_cdns_port *ports;
134 	int num_ports;
135 
136 	struct sdw_cdns_streams pcm;
137 
138 	int pdi_loopback_source;
139 	int pdi_loopback_target;
140 
141 	void __iomem *registers;
142 
143 	bool link_up;
144 	unsigned int msg_count;
145 	bool interrupt_enabled;
146 
147 	struct work_struct work;
148 
149 	struct list_head list;
150 
151 	struct sdw_cdns_dai_runtime **dai_runtime_array;
152 };
153 
154 #define bus_to_cdns(_bus) container_of(_bus, struct sdw_cdns, bus)
155 
156 /* Exported symbols */
157 
158 int sdw_cdns_probe(struct sdw_cdns *cdns);
159 
160 irqreturn_t sdw_cdns_irq(int irq, void *dev_id);
161 irqreturn_t sdw_cdns_thread(int irq, void *dev_id);
162 
163 int sdw_cdns_init(struct sdw_cdns *cdns);
164 int sdw_cdns_pdi_init(struct sdw_cdns *cdns,
165 		      struct sdw_cdns_stream_config config);
166 int sdw_cdns_exit_reset(struct sdw_cdns *cdns);
167 int sdw_cdns_enable_interrupt(struct sdw_cdns *cdns, bool state);
168 
169 bool sdw_cdns_is_clock_stop(struct sdw_cdns *cdns);
170 int sdw_cdns_clock_stop(struct sdw_cdns *cdns, bool block_wake);
171 int sdw_cdns_clock_restart(struct sdw_cdns *cdns, bool bus_reset);
172 
173 #ifdef CONFIG_DEBUG_FS
174 void sdw_cdns_debugfs_init(struct sdw_cdns *cdns, struct dentry *root);
175 #endif
176 
177 struct sdw_cdns_pdi *sdw_cdns_alloc_pdi(struct sdw_cdns *cdns,
178 					struct sdw_cdns_streams *stream,
179 					u32 ch, u32 dir, int dai_id);
180 void sdw_cdns_config_stream(struct sdw_cdns *cdns,
181 			    u32 ch, u32 dir, struct sdw_cdns_pdi *pdi);
182 
183 enum sdw_command_response
184 cdns_xfer_msg(struct sdw_bus *bus, struct sdw_msg *msg);
185 
186 enum sdw_command_response
187 cdns_xfer_msg_defer(struct sdw_bus *bus);
188 
189 u32 cdns_read_ping_status(struct sdw_bus *bus);
190 
191 int cdns_bus_conf(struct sdw_bus *bus, struct sdw_bus_params *params);
192 
193 int cdns_set_sdw_stream(struct snd_soc_dai *dai,
194 			void *stream, int direction);
195 
196 void sdw_cdns_check_self_clearing_bits(struct sdw_cdns *cdns, const char *string,
197 				       bool initial_delay, int reset_iterations);
198 
199 #endif /* __SDW_CADENCE_H */
200