xref: /linux/sound/hda/ext/hdac_ext_bus.c (revision ebf68996de0ab250c5d520eb2291ab65643e9a1e)
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  *  hdac-ext-bus.c - HD-audio extended core bus functions.
4  *
5  *  Copyright (C) 2014-2015 Intel Corp
6  *  Author: Jeeja KP <jeeja.kp@intel.com>
7  *  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
8  *
9  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10  */
11 
12 #include <linux/module.h>
13 #include <linux/slab.h>
14 #include <linux/io.h>
15 #include <sound/hdaudio_ext.h>
16 
17 MODULE_DESCRIPTION("HDA extended core");
18 MODULE_LICENSE("GPL v2");
19 
20 static void hdac_ext_writel(u32 value, u32 __iomem *addr)
21 {
22 	writel(value, addr);
23 }
24 
25 static u32 hdac_ext_readl(u32 __iomem *addr)
26 {
27 	return readl(addr);
28 }
29 
30 static void hdac_ext_writew(u16 value, u16 __iomem *addr)
31 {
32 	writew(value, addr);
33 }
34 
35 static u16 hdac_ext_readw(u16 __iomem *addr)
36 {
37 	return readw(addr);
38 }
39 
40 static void hdac_ext_writeb(u8 value, u8 __iomem *addr)
41 {
42 	writeb(value, addr);
43 }
44 
45 static u8 hdac_ext_readb(u8 __iomem *addr)
46 {
47 	return readb(addr);
48 }
49 
50 static int hdac_ext_dma_alloc_pages(struct hdac_bus *bus, int type,
51 			   size_t size, struct snd_dma_buffer *buf)
52 {
53 	return snd_dma_alloc_pages(type, bus->dev, size, buf);
54 }
55 
56 static void hdac_ext_dma_free_pages(struct hdac_bus *bus, struct snd_dma_buffer *buf)
57 {
58 	snd_dma_free_pages(buf);
59 }
60 
61 static const struct hdac_io_ops hdac_ext_default_io = {
62 	.reg_writel = hdac_ext_writel,
63 	.reg_readl = hdac_ext_readl,
64 	.reg_writew = hdac_ext_writew,
65 	.reg_readw = hdac_ext_readw,
66 	.reg_writeb = hdac_ext_writeb,
67 	.reg_readb = hdac_ext_readb,
68 	.dma_alloc_pages = hdac_ext_dma_alloc_pages,
69 	.dma_free_pages = hdac_ext_dma_free_pages,
70 };
71 
72 /**
73  * snd_hdac_ext_bus_init - initialize a HD-audio extended bus
74  * @ebus: the pointer to extended bus object
75  * @dev: device pointer
76  * @ops: bus verb operators
77  * @io_ops: lowlevel I/O operators, can be NULL. If NULL core will use
78  * default ops
79  *
80  * Returns 0 if successful, or a negative error code.
81  */
82 int snd_hdac_ext_bus_init(struct hdac_bus *bus, struct device *dev,
83 			const struct hdac_bus_ops *ops,
84 			const struct hdac_io_ops *io_ops,
85 			const struct hdac_ext_bus_ops *ext_ops)
86 {
87 	int ret;
88 	static int idx;
89 
90 	/* check if io ops are provided, if not load the defaults */
91 	if (io_ops == NULL)
92 		io_ops = &hdac_ext_default_io;
93 
94 	ret = snd_hdac_bus_init(bus, dev, ops, io_ops);
95 	if (ret < 0)
96 		return ret;
97 
98 	bus->ext_ops = ext_ops;
99 	bus->idx = idx++;
100 	bus->cmd_dma_state = true;
101 
102 	return 0;
103 }
104 EXPORT_SYMBOL_GPL(snd_hdac_ext_bus_init);
105 
106 /**
107  * snd_hdac_ext_bus_exit - clean up a HD-audio extended bus
108  * @ebus: the pointer to extended bus object
109  */
110 void snd_hdac_ext_bus_exit(struct hdac_bus *bus)
111 {
112 	snd_hdac_bus_exit(bus);
113 	WARN_ON(!list_empty(&bus->hlink_list));
114 }
115 EXPORT_SYMBOL_GPL(snd_hdac_ext_bus_exit);
116 
117 static void default_release(struct device *dev)
118 {
119 	snd_hdac_ext_bus_device_exit(container_of(dev, struct hdac_device, dev));
120 }
121 
122 /**
123  * snd_hdac_ext_bus_device_init - initialize the HDA extended codec base device
124  * @ebus: hdac extended bus to attach to
125  * @addr: codec address
126  *
127  * Returns zero for success or a negative error code.
128  */
129 int snd_hdac_ext_bus_device_init(struct hdac_bus *bus, int addr,
130 					struct hdac_device *hdev)
131 {
132 	char name[15];
133 	int ret;
134 
135 	hdev->bus = bus;
136 
137 	snprintf(name, sizeof(name), "ehdaudio%dD%d", bus->idx, addr);
138 
139 	ret  = snd_hdac_device_init(hdev, bus, name, addr);
140 	if (ret < 0) {
141 		dev_err(bus->dev, "device init failed for hdac device\n");
142 		return ret;
143 	}
144 	hdev->type = HDA_DEV_ASOC;
145 	hdev->dev.release = default_release;
146 
147 	ret = snd_hdac_device_register(hdev);
148 	if (ret) {
149 		dev_err(bus->dev, "failed to register hdac device\n");
150 		snd_hdac_ext_bus_device_exit(hdev);
151 		return ret;
152 	}
153 
154 	return 0;
155 }
156 EXPORT_SYMBOL_GPL(snd_hdac_ext_bus_device_init);
157 
158 /**
159  * snd_hdac_ext_bus_device_exit - clean up a HD-audio extended codec base device
160  * @hdev: hdac device to clean up
161  */
162 void snd_hdac_ext_bus_device_exit(struct hdac_device *hdev)
163 {
164 	snd_hdac_device_exit(hdev);
165 }
166 EXPORT_SYMBOL_GPL(snd_hdac_ext_bus_device_exit);
167 
168 /**
169  * snd_hdac_ext_bus_device_remove - remove HD-audio extended codec base devices
170  *
171  * @ebus: HD-audio extended bus
172  */
173 void snd_hdac_ext_bus_device_remove(struct hdac_bus *bus)
174 {
175 	struct hdac_device *codec, *__codec;
176 	/*
177 	 * we need to remove all the codec devices objects created in the
178 	 * snd_hdac_ext_bus_device_init
179 	 */
180 	list_for_each_entry_safe(codec, __codec, &bus->codec_list, list) {
181 		snd_hdac_device_unregister(codec);
182 		put_device(&codec->dev);
183 	}
184 }
185 EXPORT_SYMBOL_GPL(snd_hdac_ext_bus_device_remove);
186 #define dev_to_hdac(dev) (container_of((dev), \
187 			struct hdac_device, dev))
188 
189 static inline struct hdac_driver *get_hdrv(struct device *dev)
190 {
191 	struct hdac_driver *hdrv = drv_to_hdac_driver(dev->driver);
192 	return hdrv;
193 }
194 
195 static inline struct hdac_device *get_hdev(struct device *dev)
196 {
197 	struct hdac_device *hdev = dev_to_hdac_dev(dev);
198 	return hdev;
199 }
200 
201 static int hda_ext_drv_probe(struct device *dev)
202 {
203 	return (get_hdrv(dev))->probe(get_hdev(dev));
204 }
205 
206 static int hdac_ext_drv_remove(struct device *dev)
207 {
208 	return (get_hdrv(dev))->remove(get_hdev(dev));
209 }
210 
211 static void hdac_ext_drv_shutdown(struct device *dev)
212 {
213 	return (get_hdrv(dev))->shutdown(get_hdev(dev));
214 }
215 
216 /**
217  * snd_hda_ext_driver_register - register a driver for ext hda devices
218  *
219  * @drv: ext hda driver structure
220  */
221 int snd_hda_ext_driver_register(struct hdac_driver *drv)
222 {
223 	drv->type = HDA_DEV_ASOC;
224 	drv->driver.bus = &snd_hda_bus_type;
225 	/* we use default match */
226 
227 	if (drv->probe)
228 		drv->driver.probe = hda_ext_drv_probe;
229 	if (drv->remove)
230 		drv->driver.remove = hdac_ext_drv_remove;
231 	if (drv->shutdown)
232 		drv->driver.shutdown = hdac_ext_drv_shutdown;
233 
234 	return driver_register(&drv->driver);
235 }
236 EXPORT_SYMBOL_GPL(snd_hda_ext_driver_register);
237 
238 /**
239  * snd_hda_ext_driver_unregister - unregister a driver for ext hda devices
240  *
241  * @drv: ext hda driver structure
242  */
243 void snd_hda_ext_driver_unregister(struct hdac_driver *drv)
244 {
245 	driver_unregister(&drv->driver);
246 }
247 EXPORT_SYMBOL_GPL(snd_hda_ext_driver_unregister);
248