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