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_codec *codec;
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_codec *gpio_to_codec(struct gpio_chip *chip)
62 struct snd_ac97_gpio_priv *gpio_priv = gpiochip_get_data(chip);
64 return gpio_priv->codec;
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_codec *codec = gpio_to_codec(chip);
80 dev_dbg(codec->dev, "set gpio %d to output\n", offset);
81 return snd_soc_update_bits(codec, 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_codec *codec = gpio_to_codec(chip);
90 ret = snd_soc_read(codec, AC97_GPIO_STATUS);
91 dev_dbg(codec->dev, "get gpio %d : %d\n", offset,
92 ret < 0 ? ret : ret & (1 << offset));
94 return ret < 0 ? ret : !!(ret & (1 << offset));
97 static void snd_soc_ac97_gpio_set(struct gpio_chip *chip, unsigned offset,
100 struct snd_ac97_gpio_priv *gpio_priv = gpiochip_get_data(chip);
101 struct snd_soc_codec *codec = gpio_to_codec(chip);
103 gpio_priv->gpios_set &= ~(1 << offset);
104 gpio_priv->gpios_set |= (!!value) << offset;
105 snd_soc_write(codec, AC97_GPIO_STATUS, gpio_priv->gpios_set);
106 dev_dbg(codec->dev, "set gpio %d to %d\n", offset, !!value);
109 static int snd_soc_ac97_gpio_direction_out(struct gpio_chip *chip,
110 unsigned offset, int value)
112 struct snd_soc_codec *codec = gpio_to_codec(chip);
114 dev_dbg(codec->dev, "set gpio %d to output\n", offset);
115 snd_soc_ac97_gpio_set(chip, offset, value);
116 return snd_soc_update_bits(codec, AC97_GPIO_CFG, 1 << offset, 0);
119 static const struct gpio_chip snd_soc_ac97_gpio_chip = {
120 .label = "snd_soc_ac97",
121 .owner = THIS_MODULE,
122 .request = snd_soc_ac97_gpio_request,
123 .direction_input = snd_soc_ac97_gpio_direction_in,
124 .get = snd_soc_ac97_gpio_get,
125 .direction_output = snd_soc_ac97_gpio_direction_out,
126 .set = snd_soc_ac97_gpio_set,
130 static int snd_soc_ac97_init_gpio(struct snd_ac97 *ac97,
131 struct snd_soc_codec *codec)
133 struct snd_ac97_gpio_priv *gpio_priv;
136 gpio_priv = devm_kzalloc(codec->dev, sizeof(*gpio_priv), GFP_KERNEL);
139 ac97->gpio_priv = gpio_priv;
140 gpio_priv->codec = codec;
141 gpio_priv->gpio_chip = snd_soc_ac97_gpio_chip;
142 gpio_priv->gpio_chip.ngpio = AC97_NUM_GPIOS;
143 gpio_priv->gpio_chip.parent = codec->dev;
144 gpio_priv->gpio_chip.base = -1;
146 ret = gpiochip_add_data(&gpio_priv->gpio_chip, gpio_priv);
148 dev_err(codec->dev, "Failed to add GPIOs: %d\n", ret);
152 static void snd_soc_ac97_free_gpio(struct snd_ac97 *ac97)
154 gpiochip_remove(&ac97->gpio_priv->gpio_chip);
157 static int snd_soc_ac97_init_gpio(struct snd_ac97 *ac97,
158 struct snd_soc_codec *codec)
163 static void snd_soc_ac97_free_gpio(struct snd_ac97 *ac97)
169 * snd_soc_alloc_ac97_codec() - Allocate new a AC'97 device
170 * @codec: The CODEC for which to create the AC'97 device
172 * Allocated a new snd_ac97 device and intializes it, but does not yet register
173 * it. The caller is responsible to either call device_add(&ac97->dev) to
174 * register the device, or to call put_device(&ac97->dev) to free the device.
176 * Returns: A snd_ac97 device or a PTR_ERR in case of an error.
178 struct snd_ac97 *snd_soc_alloc_ac97_codec(struct snd_soc_codec *codec)
180 struct snd_ac97 *ac97;
182 ac97 = kzalloc(sizeof(struct snd_ac97), GFP_KERNEL);
184 return ERR_PTR(-ENOMEM);
186 ac97->bus = &soc_ac97_bus;
189 ac97->dev.bus = &ac97_bus_type;
190 ac97->dev.parent = codec->component.card->dev;
191 ac97->dev.release = soc_ac97_device_release;
193 dev_set_name(&ac97->dev, "%d-%d:%s",
194 codec->component.card->snd_card->number, 0,
195 codec->component.name);
197 device_initialize(&ac97->dev);
201 EXPORT_SYMBOL(snd_soc_alloc_ac97_codec);
204 * snd_soc_new_ac97_codec - initailise AC97 device
205 * @codec: audio codec
206 * @id: The expected device ID
207 * @id_mask: Mask that is applied to the device ID before comparing with @id
209 * Initialises AC97 codec resources for use by ad-hoc devices only.
211 * If @id is not 0 this function will reset the device, then read the ID from
212 * the device and check if it matches the expected ID. If it doesn't match an
213 * error will be returned and device will not be registered.
215 * Returns: A PTR_ERR() on failure or a valid snd_ac97 struct on success.
217 struct snd_ac97 *snd_soc_new_ac97_codec(struct snd_soc_codec *codec,
218 unsigned int id, unsigned int id_mask)
220 struct snd_ac97 *ac97;
223 ac97 = snd_soc_alloc_ac97_codec(codec);
228 ret = snd_ac97_reset(ac97, false, id, id_mask);
230 dev_err(codec->dev, "Failed to reset AC97 device: %d\n",
236 ret = device_add(&ac97->dev);
240 ret = snd_soc_ac97_init_gpio(ac97, codec);
247 put_device(&ac97->dev);
250 EXPORT_SYMBOL_GPL(snd_soc_new_ac97_codec);
253 * snd_soc_free_ac97_codec - free AC97 codec device
254 * @ac97: snd_ac97 device to be freed
256 * Frees AC97 codec device resources.
258 void snd_soc_free_ac97_codec(struct snd_ac97 *ac97)
260 snd_soc_ac97_free_gpio(ac97);
261 device_del(&ac97->dev);
263 put_device(&ac97->dev);
265 EXPORT_SYMBOL_GPL(snd_soc_free_ac97_codec);
267 static struct snd_ac97_reset_cfg snd_ac97_rst_cfg;
269 static void snd_soc_ac97_warm_reset(struct snd_ac97 *ac97)
271 struct pinctrl *pctl = snd_ac97_rst_cfg.pctl;
273 pinctrl_select_state(pctl, snd_ac97_rst_cfg.pstate_warm_reset);
275 gpio_direction_output(snd_ac97_rst_cfg.gpio_sync, 1);
279 gpio_direction_output(snd_ac97_rst_cfg.gpio_sync, 0);
281 pinctrl_select_state(pctl, snd_ac97_rst_cfg.pstate_run);
285 static void snd_soc_ac97_reset(struct snd_ac97 *ac97)
287 struct pinctrl *pctl = snd_ac97_rst_cfg.pctl;
289 pinctrl_select_state(pctl, snd_ac97_rst_cfg.pstate_reset);
291 gpio_direction_output(snd_ac97_rst_cfg.gpio_sync, 0);
292 gpio_direction_output(snd_ac97_rst_cfg.gpio_sdata, 0);
293 gpio_direction_output(snd_ac97_rst_cfg.gpio_reset, 0);
297 gpio_direction_output(snd_ac97_rst_cfg.gpio_reset, 1);
299 pinctrl_select_state(pctl, snd_ac97_rst_cfg.pstate_run);
303 static int snd_soc_ac97_parse_pinctl(struct device *dev,
304 struct snd_ac97_reset_cfg *cfg)
307 struct pinctrl_state *state;
311 p = devm_pinctrl_get(dev);
313 dev_err(dev, "Failed to get pinctrl\n");
318 state = pinctrl_lookup_state(p, "ac97-reset");
320 dev_err(dev, "Can't find pinctrl state ac97-reset\n");
321 return PTR_ERR(state);
323 cfg->pstate_reset = state;
325 state = pinctrl_lookup_state(p, "ac97-warm-reset");
327 dev_err(dev, "Can't find pinctrl state ac97-warm-reset\n");
328 return PTR_ERR(state);
330 cfg->pstate_warm_reset = state;
332 state = pinctrl_lookup_state(p, "ac97-running");
334 dev_err(dev, "Can't find pinctrl state ac97-running\n");
335 return PTR_ERR(state);
337 cfg->pstate_run = state;
339 gpio = of_get_named_gpio(dev->of_node, "ac97-gpios", 0);
341 dev_err(dev, "Can't find ac97-sync gpio\n");
344 ret = devm_gpio_request(dev, gpio, "AC97 link sync");
346 dev_err(dev, "Failed requesting ac97-sync gpio\n");
349 cfg->gpio_sync = gpio;
351 gpio = of_get_named_gpio(dev->of_node, "ac97-gpios", 1);
353 dev_err(dev, "Can't find ac97-sdata gpio %d\n", gpio);
356 ret = devm_gpio_request(dev, gpio, "AC97 link sdata");
358 dev_err(dev, "Failed requesting ac97-sdata gpio\n");
361 cfg->gpio_sdata = gpio;
363 gpio = of_get_named_gpio(dev->of_node, "ac97-gpios", 2);
365 dev_err(dev, "Can't find ac97-reset gpio\n");
368 ret = devm_gpio_request(dev, gpio, "AC97 link reset");
370 dev_err(dev, "Failed requesting ac97-reset gpio\n");
373 cfg->gpio_reset = gpio;
378 struct snd_ac97_bus_ops *soc_ac97_ops;
379 EXPORT_SYMBOL_GPL(soc_ac97_ops);
381 int snd_soc_set_ac97_ops(struct snd_ac97_bus_ops *ops)
383 if (ops == soc_ac97_ops)
386 if (soc_ac97_ops && ops)
390 soc_ac97_bus.ops = ops;
394 EXPORT_SYMBOL_GPL(snd_soc_set_ac97_ops);
397 * snd_soc_set_ac97_ops_of_reset - Set ac97 ops with generic ac97 reset functions
399 * This function sets the reset and warm_reset properties of ops and parses
400 * the device node of pdev to get pinctrl states and gpio numbers to use.
402 int snd_soc_set_ac97_ops_of_reset(struct snd_ac97_bus_ops *ops,
403 struct platform_device *pdev)
405 struct device *dev = &pdev->dev;
406 struct snd_ac97_reset_cfg cfg;
409 ret = snd_soc_ac97_parse_pinctl(dev, &cfg);
413 ret = snd_soc_set_ac97_ops(ops);
417 ops->warm_reset = snd_soc_ac97_warm_reset;
418 ops->reset = snd_soc_ac97_reset;
420 snd_ac97_rst_cfg = cfg;
423 EXPORT_SYMBOL_GPL(snd_soc_set_ac97_ops_of_reset);