xref: /kernel/linux/linux-6.6/sound/soc/qcom/qdsp6/q6apm.h (revision 62306a36)
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#define APM_LAST_BUFFER_FLAG			BIT(30)
49#define NO_TIMESTAMP				0xFF00
50
51struct q6apm {
52	struct device *dev;
53	gpr_port_t *port;
54	gpr_device_t *gdev;
55	/* For Graph OPEN/START/STOP/CLOSE operations */
56	wait_queue_head_t wait;
57	struct gpr_ibasic_rsp_result_t result;
58
59	struct mutex cmd_lock;
60	struct mutex lock;
61	uint32_t state;
62
63	struct list_head widget_list;
64	struct idr graph_idr;
65	struct idr graph_info_idr;
66	struct idr sub_graphs_idr;
67	struct idr containers_idr;
68	struct idr modules_idr;
69};
70
71struct audio_buffer {
72	phys_addr_t phys;
73	uint32_t size;		/* size of buffer */
74};
75
76struct audioreach_graph_data {
77	struct audio_buffer *buf;
78	uint32_t num_periods;
79	uint32_t dsp_buf;
80	uint32_t mem_map_handle;
81};
82
83struct audioreach_graph {
84	struct audioreach_graph_info *info;
85	uint32_t id;
86	int state;
87	int start_count;
88	/* Cached Graph data */
89	void *graph;
90	struct kref refcount;
91	struct q6apm *apm;
92};
93
94typedef void (*q6apm_cb) (uint32_t opcode, uint32_t token,
95			  void *payload, void *priv);
96struct q6apm_graph {
97	void *priv;
98	q6apm_cb cb;
99	uint32_t id;
100	struct device *dev;
101	struct q6apm *apm;
102	gpr_port_t *port;
103	struct audioreach_graph_data rx_data;
104	struct audioreach_graph_data tx_data;
105	struct gpr_ibasic_rsp_result_t result;
106	wait_queue_head_t cmd_wait;
107	struct mutex lock;
108	struct audioreach_graph *ar_graph;
109	struct audioreach_graph_info *info;
110};
111
112/* Graph Operations */
113struct q6apm_graph *q6apm_graph_open(struct device *dev, q6apm_cb cb,
114				     void *priv, int graph_id);
115int q6apm_graph_close(struct q6apm_graph *graph);
116int q6apm_graph_prepare(struct q6apm_graph *graph);
117int q6apm_graph_start(struct q6apm_graph *graph);
118int q6apm_graph_stop(struct q6apm_graph *graph);
119int q6apm_graph_flush(struct q6apm_graph *graph);
120
121/* Media Format */
122int q6apm_graph_media_format_pcm(struct q6apm_graph *graph,
123				 struct audioreach_module_config *cfg);
124
125int q6apm_graph_media_format_shmem(struct q6apm_graph *graph,
126				   struct audioreach_module_config *cfg);
127
128/* read/write related */
129int q6apm_read(struct q6apm_graph *graph);
130int q6apm_write_async(struct q6apm_graph *graph, uint32_t len, uint32_t msw_ts,
131		      uint32_t lsw_ts, uint32_t wflags);
132
133/* Memory Map related */
134int q6apm_map_memory_regions(struct q6apm_graph *graph,
135			     unsigned int dir, phys_addr_t phys,
136			     size_t period_sz, unsigned int periods);
137int q6apm_unmap_memory_regions(struct q6apm_graph *graph,
138			       unsigned int dir);
139/* Helpers */
140int q6apm_send_cmd_sync(struct q6apm *apm, struct gpr_pkt *pkt,
141			uint32_t rsp_opcode);
142
143/* Callback for graph specific */
144struct audioreach_module *q6apm_find_module_by_mid(struct q6apm_graph *graph,
145						    uint32_t mid);
146int q6apm_graph_get_rx_shmem_module_iid(struct q6apm_graph *graph);
147
148bool q6apm_is_adsp_ready(void);
149
150int q6apm_enable_compress_module(struct device *dev, struct q6apm_graph *graph, bool en);
151int q6apm_remove_initial_silence(struct device *dev, struct q6apm_graph *graph, uint32_t samples);
152int q6apm_remove_trailing_silence(struct device *dev, struct q6apm_graph *graph, uint32_t samples);
153int q6apm_set_real_module_id(struct device *dev, struct q6apm_graph *graph, uint32_t codec_id);
154#endif /* __APM_GRAPH_ */
155