1 /* SPDX-License-Identifier: (GPL-2.0 OR BSD-3-Clause) */
2 /* Copyright(c) 2015-17 Intel Corporation. */
5 #ifndef __SDW_CADENCE_H
6 #define __SDW_CADENCE_H
8 #define SDW_CADENCE_GSYNC_KHZ 4 /* 4 kHz */
9 #define SDW_CADENCE_GSYNC_HZ (SDW_CADENCE_GSYNC_KHZ * 1000)
12 * The Cadence IP supports up to 32 entries in the FIFO, though implementations
13 * can configure the IP to have a smaller FIFO.
15 #define CDNS_MCP_IP_MAX_CMD_LEN 32
18 * struct sdw_cdns_pdi: PDI (Physical Data Interface) instance
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)
34 enum sdw_data_direction dir;
35 enum sdw_stream_type type;
39 * struct sdw_cdns_streams: Cadence stream data structure
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
50 * @out: output streams
52 struct sdw_cdns_streams {
56 unsigned int num_ch_bd;
57 unsigned int num_ch_in;
58 unsigned int num_ch_out;
60 struct sdw_cdns_pdi *bd;
61 struct sdw_cdns_pdi *in;
62 struct sdw_cdns_pdi *out;
66 * struct sdw_cdns_stream_config: stream configuration
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
72 struct sdw_cdns_stream_config {
79 * struct sdw_cdns_dai_runtime: Cadence DAI runtime data
81 * @name: SoundWire stream name
82 * @stream: stream runtime
83 * @pdi: PDI used for this dai
85 * @stream_type: Stream type
86 * @link_id: Master link id
87 * @suspended: status set when suspended, to be used in .prepare
88 * @paused: status set in .trigger, to be used in suspend
89 * @direction: stream direction
91 struct sdw_cdns_dai_runtime {
93 struct sdw_stream_runtime *stream;
94 struct sdw_cdns_pdi *pdi;
96 enum sdw_stream_type stream_type;
104 * struct sdw_cdns - Cadence driver context
107 * @instance: instance number
108 * @ip_offset: version-dependent offset to access IP_MCP registers and fields
109 * @response_buf: SoundWire response buffer
110 * @tx_complete: Tx completion
112 * @num_ports: Total number of data ports
114 * @registers: Cadence registers
115 * @link_up: Link status
116 * @msg_count: Messages sent on bus
117 * @dai_runtime_array: runtime context for each allocated DAI.
122 unsigned int instance;
127 * The datasheet says the RX FIFO AVAIL can be 2 entries more
128 * than the FIFO capacity, so allow for this.
130 u32 response_buf[CDNS_MCP_IP_MAX_CMD_LEN + 2];
132 struct completion tx_complete;
134 struct sdw_cdns_port *ports;
137 struct sdw_cdns_streams pcm;
139 int pdi_loopback_source;
140 int pdi_loopback_target;
142 void __iomem *registers;
145 unsigned int msg_count;
146 bool interrupt_enabled;
148 struct work_struct work;
150 struct list_head list;
152 struct sdw_cdns_dai_runtime **dai_runtime_array;
155 #define bus_to_cdns(_bus) container_of(_bus, struct sdw_cdns, bus)
157 /* Exported symbols */
159 int sdw_cdns_probe(struct sdw_cdns *cdns);
161 irqreturn_t sdw_cdns_irq(int irq, void *dev_id);
162 irqreturn_t sdw_cdns_thread(int irq, void *dev_id);
164 int sdw_cdns_init(struct sdw_cdns *cdns);
165 int sdw_cdns_pdi_init(struct sdw_cdns *cdns,
166 struct sdw_cdns_stream_config config);
167 int sdw_cdns_exit_reset(struct sdw_cdns *cdns);
168 int sdw_cdns_enable_interrupt(struct sdw_cdns *cdns, bool state);
170 bool sdw_cdns_is_clock_stop(struct sdw_cdns *cdns);
171 int sdw_cdns_clock_stop(struct sdw_cdns *cdns, bool block_wake);
172 int sdw_cdns_clock_restart(struct sdw_cdns *cdns, bool bus_reset);
174 #ifdef CONFIG_DEBUG_FS
175 void sdw_cdns_debugfs_init(struct sdw_cdns *cdns, struct dentry *root);
178 struct sdw_cdns_pdi *sdw_cdns_alloc_pdi(struct sdw_cdns *cdns,
179 struct sdw_cdns_streams *stream,
180 u32 ch, u32 dir, int dai_id);
181 void sdw_cdns_config_stream(struct sdw_cdns *cdns,
182 u32 ch, u32 dir, struct sdw_cdns_pdi *pdi);
184 enum sdw_command_response
185 cdns_xfer_msg(struct sdw_bus *bus, struct sdw_msg *msg);
187 enum sdw_command_response
188 cdns_xfer_msg_defer(struct sdw_bus *bus);
190 u32 cdns_read_ping_status(struct sdw_bus *bus);
192 int cdns_bus_conf(struct sdw_bus *bus, struct sdw_bus_params *params);
194 int cdns_set_sdw_stream(struct snd_soc_dai *dai,
195 void *stream, int direction);
197 void sdw_cdns_check_self_clearing_bits(struct sdw_cdns *cdns, const char *string,
198 bool initial_delay, int reset_iterations);
200 #endif /* __SDW_CADENCE_H */