2 * soc-ac97.c -- ALSA SoC Audio Layer AC97 support
4 * Copyright 2005 Wolfson Microelectronics PLC.
5 * Copyright 2005 Openedhand Ltd.
6 * Copyright (C) 2010 Slimlogic Ltd.
7 * Copyright (C) 2010 Texas Instruments Inc.
9 * Author: Liam Girdwood <lrg@slimlogic.co.uk>
10 * with code, comments and ideas from :-
11 * Richard Purdie <richard@openedhand.com>
13 * This program is free software; you can redistribute it and/or modify it
14 * under the terms of the GNU General Public License as published by the
15 * Free Software Foundation; either version 2 of the License, or (at your
16 * option) any later version.
19 #include <linux/ctype.h>
20 #include <linux/delay.h>
21 #include <linux/export.h>
22 #include <linux/gpio.h>
23 #include <linux/gpio/driver.h>
24 #include <linux/init.h>
25 #include <linux/of_gpio.h>
27 #include <linux/pinctrl/consumer.h>
28 #include <linux/slab.h>
29 #include <sound/ac97_codec.h>
30 #include <sound/soc.h>
32 struct snd_ac97_reset_cfg {
34 struct pinctrl_state *pstate_reset;
35 struct pinctrl_state *pstate_warm_reset;
36 struct pinctrl_state *pstate_run;
42 struct snd_ac97_gpio_priv {
44 struct gpio_chip gpio_chip;
46 unsigned int gpios_set;
47 struct snd_soc_component *component;
50 static struct snd_ac97_bus soc_ac97_bus = {
51 .ops = NULL, /* Gets initialized in snd_soc_set_ac97_ops() */
54 static void soc_ac97_device_release(struct device *dev)
56 kfree(to_ac97_t(dev));
60 static inline struct snd_soc_component *gpio_to_component(struct gpio_chip *chip)
62 struct snd_ac97_gpio_priv *gpio_priv = gpiochip_get_data(chip);
64 return gpio_priv->component;
67 static int snd_soc_ac97_gpio_request(struct gpio_chip *chip, unsigned offset)
69 if (offset >= AC97_NUM_GPIOS)
75 static int snd_soc_ac97_gpio_direction_in(struct gpio_chip *chip,
78 struct snd_soc_component *component = gpio_to_component(chip);
80 dev_dbg(component->dev, "set gpio %d to output\n", offset);
81 return snd_soc_component_update_bits(component, AC97_GPIO_CFG,
82 1 << offset, 1 << offset);
85 static int snd_soc_ac97_gpio_get(struct gpio_chip *chip, unsigned offset)
87 struct snd_soc_component *component = gpio_to_component(chip);
90 if (snd_soc_component_read(component, AC97_GPIO_STATUS, &ret) < 0)
93 dev_dbg(component->dev, "get gpio %d : %d\n", offset,
94 ret < 0 ? ret : ret & (1 << offset));
96 return ret < 0 ? ret : !!(ret & (1 << offset));
99 static void snd_soc_ac97_gpio_set(struct gpio_chip *chip, unsigned offset,
102 struct snd_ac97_gpio_priv *gpio_priv = gpiochip_get_data(chip);
103 struct snd_soc_component *component = gpio_to_component(chip);
105 gpio_priv->gpios_set &= ~(1 << offset);
106 gpio_priv->gpios_set |= (!!value) << offset;
107 snd_soc_component_write(component, AC97_GPIO_STATUS,
108 gpio_priv->gpios_set);
109 dev_dbg(component->dev, "set gpio %d to %d\n", offset, !!value);
112 static int snd_soc_ac97_gpio_direction_out(struct gpio_chip *chip,
113 unsigned offset, int value)
115 struct snd_soc_component *component = gpio_to_component(chip);
117 dev_dbg(component->dev, "set gpio %d to output\n", offset);
118 snd_soc_ac97_gpio_set(chip, offset, value);
119 return snd_soc_component_update_bits(component, AC97_GPIO_CFG,
123 static const struct gpio_chip snd_soc_ac97_gpio_chip = {
124 .label = "snd_soc_ac97",
125 .owner = THIS_MODULE,
126 .request = snd_soc_ac97_gpio_request,
127 .direction_input = snd_soc_ac97_gpio_direction_in,
128 .get = snd_soc_ac97_gpio_get,
129 .direction_output = snd_soc_ac97_gpio_direction_out,
130 .set = snd_soc_ac97_gpio_set,
134 static int snd_soc_ac97_init_gpio(struct snd_ac97 *ac97,
135 struct snd_soc_component *component)
137 struct snd_ac97_gpio_priv *gpio_priv;
140 gpio_priv = devm_kzalloc(component->dev, sizeof(*gpio_priv), GFP_KERNEL);
143 ac97->gpio_priv = gpio_priv;
144 gpio_priv->component = component;
145 gpio_priv->gpio_chip = snd_soc_ac97_gpio_chip;
146 gpio_priv->gpio_chip.ngpio = AC97_NUM_GPIOS;
147 gpio_priv->gpio_chip.parent = component->dev;
148 gpio_priv->gpio_chip.base = -1;
150 ret = gpiochip_add_data(&gpio_priv->gpio_chip, gpio_priv);
152 dev_err(component->dev, "Failed to add GPIOs: %d\n", ret);
156 static void snd_soc_ac97_free_gpio(struct snd_ac97 *ac97)
158 gpiochip_remove(&ac97->gpio_priv->gpio_chip);
161 static int snd_soc_ac97_init_gpio(struct snd_ac97 *ac97,
162 struct snd_soc_component *component)
167 static void snd_soc_ac97_free_gpio(struct snd_ac97 *ac97)
173 * snd_soc_alloc_ac97_component() - Allocate new a AC'97 device
174 * @component: The COMPONENT for which to create the AC'97 device
176 * Allocated a new snd_ac97 device and intializes it, but does not yet register
177 * it. The caller is responsible to either call device_add(&ac97->dev) to
178 * register the device, or to call put_device(&ac97->dev) to free the device.
180 * Returns: A snd_ac97 device or a PTR_ERR in case of an error.
182 struct snd_ac97 *snd_soc_alloc_ac97_component(struct snd_soc_component *component)
184 struct snd_ac97 *ac97;
186 ac97 = kzalloc(sizeof(struct snd_ac97), GFP_KERNEL);
188 return ERR_PTR(-ENOMEM);
190 ac97->bus = &soc_ac97_bus;
193 ac97->dev.bus = &ac97_bus_type;
194 ac97->dev.parent = component->card->dev;
195 ac97->dev.release = soc_ac97_device_release;
197 dev_set_name(&ac97->dev, "%d-%d:%s",
198 component->card->snd_card->number, 0,
201 device_initialize(&ac97->dev);
205 EXPORT_SYMBOL(snd_soc_alloc_ac97_component);
208 * snd_soc_new_ac97_component - initailise AC97 device
209 * @component: audio component
210 * @id: The expected device ID
211 * @id_mask: Mask that is applied to the device ID before comparing with @id
213 * Initialises AC97 component resources for use by ad-hoc devices only.
215 * If @id is not 0 this function will reset the device, then read the ID from
216 * the device and check if it matches the expected ID. If it doesn't match an
217 * error will be returned and device will not be registered.
219 * Returns: A PTR_ERR() on failure or a valid snd_ac97 struct on success.
221 struct snd_ac97 *snd_soc_new_ac97_component(struct snd_soc_component *component,
222 unsigned int id, unsigned int id_mask)
224 struct snd_ac97 *ac97;
227 ac97 = snd_soc_alloc_ac97_component(component);
232 ret = snd_ac97_reset(ac97, false, id, id_mask);
234 dev_err(component->dev, "Failed to reset AC97 device: %d\n",
240 ret = device_add(&ac97->dev);
244 ret = snd_soc_ac97_init_gpio(ac97, component);
251 put_device(&ac97->dev);
254 EXPORT_SYMBOL_GPL(snd_soc_new_ac97_component);
257 * snd_soc_free_ac97_component - free AC97 component device
258 * @ac97: snd_ac97 device to be freed
260 * Frees AC97 component device resources.
262 void snd_soc_free_ac97_component(struct snd_ac97 *ac97)
264 snd_soc_ac97_free_gpio(ac97);
265 device_del(&ac97->dev);
267 put_device(&ac97->dev);
269 EXPORT_SYMBOL_GPL(snd_soc_free_ac97_component);
271 static struct snd_ac97_reset_cfg snd_ac97_rst_cfg;
273 static void snd_soc_ac97_warm_reset(struct snd_ac97 *ac97)
275 struct pinctrl *pctl = snd_ac97_rst_cfg.pctl;
277 pinctrl_select_state(pctl, snd_ac97_rst_cfg.pstate_warm_reset);
279 gpio_direction_output(snd_ac97_rst_cfg.gpio_sync, 1);
283 gpio_direction_output(snd_ac97_rst_cfg.gpio_sync, 0);
285 pinctrl_select_state(pctl, snd_ac97_rst_cfg.pstate_run);
289 static void snd_soc_ac97_reset(struct snd_ac97 *ac97)
291 struct pinctrl *pctl = snd_ac97_rst_cfg.pctl;
293 pinctrl_select_state(pctl, snd_ac97_rst_cfg.pstate_reset);
295 gpio_direction_output(snd_ac97_rst_cfg.gpio_sync, 0);
296 gpio_direction_output(snd_ac97_rst_cfg.gpio_sdata, 0);
297 gpio_direction_output(snd_ac97_rst_cfg.gpio_reset, 0);
301 gpio_direction_output(snd_ac97_rst_cfg.gpio_reset, 1);
303 pinctrl_select_state(pctl, snd_ac97_rst_cfg.pstate_run);
307 static int snd_soc_ac97_parse_pinctl(struct device *dev,
308 struct snd_ac97_reset_cfg *cfg)
311 struct pinctrl_state *state;
315 p = devm_pinctrl_get(dev);
317 dev_err(dev, "Failed to get pinctrl\n");
322 state = pinctrl_lookup_state(p, "ac97-reset");
324 dev_err(dev, "Can't find pinctrl state ac97-reset\n");
325 return PTR_ERR(state);
327 cfg->pstate_reset = state;
329 state = pinctrl_lookup_state(p, "ac97-warm-reset");
331 dev_err(dev, "Can't find pinctrl state ac97-warm-reset\n");
332 return PTR_ERR(state);
334 cfg->pstate_warm_reset = state;
336 state = pinctrl_lookup_state(p, "ac97-running");
338 dev_err(dev, "Can't find pinctrl state ac97-running\n");
339 return PTR_ERR(state);
341 cfg->pstate_run = state;
343 gpio = of_get_named_gpio(dev->of_node, "ac97-gpios", 0);
345 dev_err(dev, "Can't find ac97-sync gpio\n");
348 ret = devm_gpio_request(dev, gpio, "AC97 link sync");
350 dev_err(dev, "Failed requesting ac97-sync gpio\n");
353 cfg->gpio_sync = gpio;
355 gpio = of_get_named_gpio(dev->of_node, "ac97-gpios", 1);
357 dev_err(dev, "Can't find ac97-sdata gpio %d\n", gpio);
360 ret = devm_gpio_request(dev, gpio, "AC97 link sdata");
362 dev_err(dev, "Failed requesting ac97-sdata gpio\n");
365 cfg->gpio_sdata = gpio;
367 gpio = of_get_named_gpio(dev->of_node, "ac97-gpios", 2);
369 dev_err(dev, "Can't find ac97-reset gpio\n");
372 ret = devm_gpio_request(dev, gpio, "AC97 link reset");
374 dev_err(dev, "Failed requesting ac97-reset gpio\n");
377 cfg->gpio_reset = gpio;
382 struct snd_ac97_bus_ops *soc_ac97_ops;
383 EXPORT_SYMBOL_GPL(soc_ac97_ops);
385 int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops)
387 if (ops == soc_ac97_ops)
390 if (soc_ac97_ops && ops)
394 soc_ac97_bus.ops = ops;
398 EXPORT_SYMBOL_GPL(snd_soc_set_ac97_ops);
401 * snd_soc_set_ac97_ops_of_reset - Set ac97 ops with generic ac97 reset functions
403 * This function sets the reset and warm_reset properties of ops and parses
404 * the device node of pdev to get pinctrl states and gpio numbers to use.
406 int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops *ops,
407 struct platform_device *pdev)
409 struct device *dev = &pdev->dev;
410 struct snd_ac97_reset_cfg cfg;
413 ret = snd_soc_ac97_parse_pinctl(dev, &cfg);
417 ret = snd_soc_set_ac97_ops(ops);
421 ops->warm_reset = snd_soc_ac97_warm_reset;
422 ops->reset = snd_soc_ac97_reset;
424 snd_ac97_rst_cfg = cfg;
427 EXPORT_SYMBOL_GPL(snd_soc_set_ac97_ops_of_reset);