xref: /openbmc/linux/sound/soc/qcom/qdsp6/q6apm.h (revision 3bf90eca)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __Q6APM_H__
3 #define __Q6APM_H__
4 #include <linux/types.h>
5 #include <linux/slab.h>
6 #include <linux/wait.h>
7 #include <linux/kernel.h>
8 #include <linux/module.h>
9 #include <linux/sched.h>
10 #include <linux/of.h>
11 #include <linux/delay.h>
12 #include <sound/soc.h>
13 #include <linux/of_platform.h>
14 #include <linux/jiffies.h>
15 #include <linux/soc/qcom/apr.h>
16 #include <dt-bindings/sound/qcom,q6dsp-lpass-ports.h>
17 #include "audioreach.h"
18 
19 #define APM_PORT_MAX		127
20 #define APM_PORT_MAX_AUDIO_CHAN_CNT 8
21 #define PCM_CHANNEL_NULL 0
22 #define PCM_CHANNEL_FL    1	/* Front left channel. */
23 #define PCM_CHANNEL_FR    2	/* Front right channel. */
24 #define PCM_CHANNEL_FC    3	/* Front center channel. */
25 #define PCM_CHANNEL_LS   4	/* Left surround channel. */
26 #define PCM_CHANNEL_RS   5	/* Right surround channel. */
27 #define PCM_CHANNEL_LFE  6	/* Low frequency effect channel. */
28 #define PCM_CHANNEL_CS   7	/* Center surround channel; Rear center ch */
29 #define PCM_CHANNEL_LB   8	/* Left back channel; Rear left channel. */
30 #define PCM_CHANNEL_RB   9	/* Right back channel; Rear right channel. */
31 #define PCM_CHANNELS   10	/* Top surround channel. */
32 
33 #define APM_TIMESTAMP_FLAG	0x80000000
34 #define FORMAT_LINEAR_PCM	0x0000
35 /* APM client callback events */
36 #define APM_CMD_EOS				0x0003
37 #define APM_CLIENT_EVENT_CMD_EOS_DONE		0x1003
38 #define APM_CMD_CLOSE				0x0004
39 #define APM_CLIENT_EVENT_CMD_CLOSE_DONE		0x1004
40 #define APM_CLIENT_EVENT_CMD_RUN_DONE		0x1008
41 #define APM_CLIENT_EVENT_DATA_WRITE_DONE	0x1009
42 #define APM_CLIENT_EVENT_DATA_READ_DONE		0x100a
43 #define APM_WRITE_TOKEN_MASK                   GENMASK(15, 0)
44 #define APM_WRITE_TOKEN_LEN_MASK               GENMASK(31, 16)
45 #define APM_WRITE_TOKEN_LEN_SHIFT              16
46 
47 #define APM_MAX_SESSIONS			8
48 
49 struct q6apm {
50 	struct device *dev;
51 	gpr_port_t *port;
52 	gpr_device_t *gdev;
53 	/* For Graph OPEN/START/STOP/CLOSE operations */
54 	wait_queue_head_t wait;
55 	struct gpr_ibasic_rsp_result_t result;
56 
57 	struct mutex cmd_lock;
58 	struct mutex lock;
59 	uint32_t state;
60 
61 	struct list_head widget_list;
62 	struct idr graph_idr;
63 	struct idr graph_info_idr;
64 	struct idr sub_graphs_idr;
65 	struct idr containers_idr;
66 	struct idr modules_idr;
67 };
68 
69 struct audio_buffer {
70 	phys_addr_t phys;
71 	uint32_t size;		/* size of buffer */
72 };
73 
74 struct audioreach_graph_data {
75 	struct audio_buffer *buf;
76 	uint32_t num_periods;
77 	uint32_t dsp_buf;
78 	uint32_t mem_map_handle;
79 };
80 
81 struct audioreach_graph {
82 	struct audioreach_graph_info *info;
83 	uint32_t id;
84 	int state;
85 	int start_count;
86 	/* Cached Graph data */
87 	void *graph;
88 	struct kref refcount;
89 	struct q6apm *apm;
90 };
91 
92 typedef void (*q6apm_cb) (uint32_t opcode, uint32_t token,
93 			  void *payload, void *priv);
94 struct q6apm_graph {
95 	void *priv;
96 	q6apm_cb cb;
97 	uint32_t id;
98 	struct device *dev;
99 	struct q6apm *apm;
100 	gpr_port_t *port;
101 	struct audioreach_graph_data rx_data;
102 	struct audioreach_graph_data tx_data;
103 	struct gpr_ibasic_rsp_result_t result;
104 	wait_queue_head_t cmd_wait;
105 	struct mutex lock;
106 	struct audioreach_graph *ar_graph;
107 	struct audioreach_graph_info *info;
108 };
109 
110 /* Graph Operations */
111 struct q6apm_graph *q6apm_graph_open(struct device *dev, q6apm_cb cb,
112 				     void *priv, int graph_id);
113 int q6apm_graph_close(struct q6apm_graph *graph);
114 int q6apm_graph_prepare(struct q6apm_graph *graph);
115 int q6apm_graph_start(struct q6apm_graph *graph);
116 int q6apm_graph_stop(struct q6apm_graph *graph);
117 int q6apm_graph_flush(struct q6apm_graph *graph);
118 
119 /* Media Format */
120 int q6apm_graph_media_format_pcm(struct q6apm_graph *graph,
121 				 struct audioreach_module_config *cfg);
122 
123 int q6apm_graph_media_format_shmem(struct q6apm_graph *graph,
124 				   struct audioreach_module_config *cfg);
125 
126 /* read/write related */
127 int q6apm_send_eos_nowait(struct q6apm_graph *graph);
128 int q6apm_read(struct q6apm_graph *graph);
129 int q6apm_write_async(struct q6apm_graph *graph, uint32_t len, uint32_t msw_ts,
130 		      uint32_t lsw_ts, uint32_t wflags);
131 
132 /* Memory Map related */
133 int q6apm_map_memory_regions(struct q6apm_graph *graph,
134 			     unsigned int dir, phys_addr_t phys,
135 			     size_t period_sz, unsigned int periods);
136 int q6apm_unmap_memory_regions(struct q6apm_graph *graph,
137 			       unsigned int dir);
138 /* Helpers */
139 int q6apm_send_cmd_sync(struct q6apm *apm, struct gpr_pkt *pkt,
140 			uint32_t rsp_opcode);
141 
142 /* Callback for graph specific */
143 struct audioreach_module *q6apm_find_module_by_mid(struct q6apm_graph *graph,
144 						    uint32_t mid);
145 void q6apm_set_fe_dai_ops(struct snd_soc_dai_driver *dai_drv);
146 int q6apm_graph_get_rx_shmem_module_iid(struct q6apm_graph *graph);
147 
148 #endif /* __APM_GRAPH_ */
149