sound/aoa/core/snd-aoa-gpio-feature.c

   1 /*
   2  * Apple Onboard Audio feature call GPIO control
   3  *
   4  * Copyright 2006 Johannes Berg <johannes@sipsolutions.net>
   5  *
   6  * GPL v2, can be found in COPYING.
   7  *
   8  * This file contains the GPIO control routines for
   9  * direct (through feature calls) access to the GPIO
  10  * registers.
  11  */
  12
  13 #include <asm/pmac_feature.h>
  14 #include <linux/interrupt.h>
  15 #include "../aoa.h"
  16
  17 /* TODO: these are 20 global variables
  18  * that aren't used on most machines...
  19  * Move them into a dynamically allocated
  20  * structure and use that.
  21  */
  22
  23 /* these are the GPIO numbers (register addresses as offsets into
  24  * the GPIO space) */
  25 static int headphone_mute_gpio;
  26 static int amp_mute_gpio;
  27 static int lineout_mute_gpio;
  28 static int hw_reset_gpio;
  29 static int lineout_detect_gpio;
  30 static int headphone_detect_gpio;
  31 static int linein_detect_gpio;
  32
  33 /* see the SWITCH_GPIO macro */
  34 static int headphone_mute_gpio_activestate;
  35 static int amp_mute_gpio_activestate;
  36 static int lineout_mute_gpio_activestate;
  37 static int hw_reset_gpio_activestate;
  38 static int lineout_detect_gpio_activestate;
  39 static int headphone_detect_gpio_activestate;
  40 static int linein_detect_gpio_activestate;
  41
  42 /* node pointers that we save when getting the GPIO number
  43  * to get the interrupt later */
  44 static struct device_node *lineout_detect_node;
  45 static struct device_node *linein_detect_node;
  46 static struct device_node *headphone_detect_node;
  47
  48 static int lineout_detect_irq;
  49 static int linein_detect_irq;
  50 static int headphone_detect_irq;
  51
  52 static struct device_node *get_gpio(char *name,
  53                                     char *altname,
  54                                     int *gpioptr,
  55                                     int *gpioactiveptr)
  56 {
  57         struct device_node *np, *gpio;
  58         u32 *reg;
  59         const char *audio_gpio;
  60
  61         *gpioptr = -1;
  62
  63         /* check if we can get it the easy way ... */
  64         np = of_find_node_by_name(NULL, name);
  65         if (!np) {
  66                 /* some machines have only gpioX/extint-gpioX nodes,
  67                  * and an audio-gpio property saying what it is ...
  68                  * So what we have to do is enumerate all children
  69                  * of the gpio node and check them all. */
  70                 gpio = of_find_node_by_name(NULL, "gpio");
  71                 if (!gpio)
  72                         return NULL;
  73                 while ((np = of_get_next_child(gpio, np))) {
  74                         audio_gpio = get_property(np, "audio-gpio", NULL);
  75                         if (!audio_gpio)
  76                                 continue;
  77                         if (strcmp(audio_gpio, name) == 0)
  78                                 break;
  79                         if (altname && (strcmp(audio_gpio, altname) == 0))
  80                                 break;
  81                 }
  82                 /* still not found, assume not there */
  83                 if (!np)
  84                         return NULL;
  85         }
  86
  87         reg = (u32 *)get_property(np, "reg", NULL);
  88         if (!reg)
  89                 return NULL;
  90
  91         *gpioptr = *reg;
  92
  93         /* this is a hack, usually the GPIOs 'reg' property
  94          * should have the offset based from the GPIO space
  95          * which is at 0x50, but apparently not always... */
  96         if (*gpioptr < 0x50)
  97                 *gpioptr += 0x50;
  98
  99         reg = (u32 *)get_property(np, "audio-gpio-active-state", NULL);
 100         if (!reg)
 101                 /* Apple seems to default to 1, but
 102                  * that doesn't seem right at least on most
 103                  * machines. So until proven that the opposite
 104                  * is necessary, we default to 0
 105                  * (which, incidentally, snd-powermac also does...) */
 106                 *gpioactiveptr = 0;
 107         else
 108                 *gpioactiveptr = *reg;
 109
 110         return np;
 111 }
 112
 113 static void get_irq(struct device_node * np, int *irqptr)
 114 {
 115         if (np)
 116                 *irqptr = irq_of_parse_and_map(np, 0);
 117         else
 118                 *irqptr = NO_IRQ;
 119 }
 120
 121 /* 0x4 is outenable, 0x1 is out, thus 4 or 5 */
 122 #define SWITCH_GPIO(name, v, on)                                \
 123         (((v)&~1) | ((on)?                                      \
 124                         (name##_gpio_activestate==0?4:5):       \
 125                         (name##_gpio_activestate==0?5:4)))
 126
 127 #define FTR_GPIO(name, bit)                                     \
 128 static void ftr_gpio_set_##name(struct gpio_runtime *rt, int on)\
 129 {                                                               \
 130         int v;                                                  \
 131                                                                 \
 132         if (unlikely(!rt)) return;                              \
 133                                                                 \
 134         if (name##_mute_gpio < 0)                               \
 135                 return;                                         \
 136                                                                 \
 137         v = pmac_call_feature(PMAC_FTR_READ_GPIO, NULL,         \
 138                               name##_mute_gpio,                 \
 139                               0);                               \
 140                                                                 \
 141         /* muted = !on... */                                    \
 142         v = SWITCH_GPIO(name##_mute, v, !on);                   \
 143                                                                 \
 144         pmac_call_feature(PMAC_FTR_WRITE_GPIO, NULL,            \
 145                           name##_mute_gpio, v);                 \
 146                                                                 \
 147         rt->implementation_private &= ~(1<<bit);                \
 148         rt->implementation_private |= (!!on << bit);            \
 149 }                                                               \
 150 static int ftr_gpio_get_##name(struct gpio_runtime *rt)         \
 151 {                                                               \
 152         if (unlikely(!rt)) return 0;                            \
 153         return (rt->implementation_private>>bit)&1;             \
 154 }
 155
 156 FTR_GPIO(headphone, 0);
 157 FTR_GPIO(amp, 1);
 158 FTR_GPIO(lineout, 2);
 159
 160 static void ftr_gpio_set_hw_reset(struct gpio_runtime *rt, int on)
 161 {
 162         int v;
 163
 164         if (unlikely(!rt)) return;
 165         if (hw_reset_gpio < 0)
 166                 return;
 167
 168         v = pmac_call_feature(PMAC_FTR_READ_GPIO, NULL,
 169                               hw_reset_gpio, 0);
 170         v = SWITCH_GPIO(hw_reset, v, on);
 171         pmac_call_feature(PMAC_FTR_WRITE_GPIO, NULL,
 172                           hw_reset_gpio, v);
 173 }
 174
 175 static void ftr_gpio_all_amps_off(struct gpio_runtime *rt)
 176 {
 177         int saved;
 178
 179         if (unlikely(!rt)) return;
 180         saved = rt->implementation_private;
 181         ftr_gpio_set_headphone(rt, 0);
 182         ftr_gpio_set_amp(rt, 0);
 183         ftr_gpio_set_lineout(rt, 0);
 184         rt->implementation_private = saved;
 185 }
 186
 187 static void ftr_gpio_all_amps_restore(struct gpio_runtime *rt)
 188 {
 189         int s;
 190
 191         if (unlikely(!rt)) return;
 192         s = rt->implementation_private;
 193         ftr_gpio_set_headphone(rt, (s>>0)&1);
 194         ftr_gpio_set_amp(rt, (s>>1)&1);
 195         ftr_gpio_set_lineout(rt, (s>>2)&1);
 196 }
 197
 198 static void ftr_handle_notify(void *data)
 199 {
 200         struct gpio_notification *notif = data;
 201
 202         mutex_lock(&notif->mutex);
 203         if (notif->notify)
 204                 notif->notify(notif->data);
 205         mutex_unlock(&notif->mutex);
 206 }
 207
 208 static void gpio_enable_dual_edge(int gpio)
 209 {
 210         int v;
 211
 212         if (gpio == -1)
 213                 return;
 214         v = pmac_call_feature(PMAC_FTR_READ_GPIO, NULL, gpio, 0);
 215         v |= 0x80; /* enable dual edge */
 216         pmac_call_feature(PMAC_FTR_WRITE_GPIO, NULL, gpio, v);
 217 }
 218
 219 static void ftr_gpio_init(struct gpio_runtime *rt)
 220 {
 221         get_gpio("headphone-mute", NULL,
 222                  &headphone_mute_gpio,
 223                  &headphone_mute_gpio_activestate);
 224         get_gpio("amp-mute", NULL,
 225                  &amp_mute_gpio,
 226                  &amp_mute_gpio_activestate);
 227         get_gpio("lineout-mute", NULL,
 228                  &lineout_mute_gpio,
 229                  &lineout_mute_gpio_activestate);
 230         get_gpio("hw-reset", "audio-hw-reset",
 231                  &hw_reset_gpio,
 232                  &hw_reset_gpio_activestate);
 233
 234         headphone_detect_node = get_gpio("headphone-detect", NULL,
 235                                          &headphone_detect_gpio,
 236                                          &headphone_detect_gpio_activestate);
 237         /* go Apple, and thanks for giving these different names
 238          * across the board... */
 239         lineout_detect_node = get_gpio("lineout-detect", "line-output-detect",
 240                                        &lineout_detect_gpio,
 241                                        &lineout_detect_gpio_activestate);
 242         linein_detect_node = get_gpio("linein-detect", "line-input-detect",
 243                                       &linein_detect_gpio,
 244                                       &linein_detect_gpio_activestate);
 245
 246         gpio_enable_dual_edge(headphone_detect_gpio);
 247         gpio_enable_dual_edge(lineout_detect_gpio);
 248         gpio_enable_dual_edge(linein_detect_gpio);
 249
 250         get_irq(headphone_detect_node, &headphone_detect_irq);
 251         get_irq(lineout_detect_node, &lineout_detect_irq);
 252         get_irq(linein_detect_node, &linein_detect_irq);
 253
 254         ftr_gpio_all_amps_off(rt);
 255         rt->implementation_private = 0;
 256         INIT_WORK(&rt->headphone_notify.work, ftr_handle_notify,
 257                   &rt->headphone_notify);
 258         INIT_WORK(&rt->line_in_notify.work, ftr_handle_notify,
 259                   &rt->line_in_notify);
 260         INIT_WORK(&rt->line_out_notify.work, ftr_handle_notify,
 261                   &rt->line_out_notify);
 262         mutex_init(&rt->headphone_notify.mutex);
 263         mutex_init(&rt->line_in_notify.mutex);
 264         mutex_init(&rt->line_out_notify.mutex);
 265 }
 266
 267 static void ftr_gpio_exit(struct gpio_runtime *rt)
 268 {
 269         ftr_gpio_all_amps_off(rt);
 270         rt->implementation_private = 0;
 271         if (rt->headphone_notify.notify)
 272                 free_irq(headphone_detect_irq, &rt->headphone_notify);
 273         if (rt->line_in_notify.gpio_private)
 274                 free_irq(linein_detect_irq, &rt->line_in_notify);
 275         if (rt->line_out_notify.gpio_private)
 276                 free_irq(lineout_detect_irq, &rt->line_out_notify);
 277         cancel_delayed_work(&rt->headphone_notify.work);
 278         cancel_delayed_work(&rt->line_in_notify.work);
 279         cancel_delayed_work(&rt->line_out_notify.work);
 280         flush_scheduled_work();
 281         mutex_destroy(&rt->headphone_notify.mutex);
 282         mutex_destroy(&rt->line_in_notify.mutex);
 283         mutex_destroy(&rt->line_out_notify.mutex);
 284 }
 285
 286 static irqreturn_t ftr_handle_notify_irq(int xx,
 287                                          void *data,
 288                                          struct pt_regs *regs)
 289 {
 290         struct gpio_notification *notif = data;
 291
 292         schedule_work(&notif->work);
 293
 294         return IRQ_HANDLED;
 295 }
 296
 297 static int ftr_set_notify(struct gpio_runtime *rt,
 298                           enum notify_type type,
 299                           notify_func_t notify,
 300                           void *data)
 301 {
 302         struct gpio_notification *notif;
 303         notify_func_t old;
 304         int irq;
 305         char *name;
 306         int err = -EBUSY;
 307
 308         switch (type) {
 309         case AOA_NOTIFY_HEADPHONE:
 310                 notif = &rt->headphone_notify;
 311                 name = "headphone-detect";
 312                 irq = headphone_detect_irq;
 313                 break;
 314         case AOA_NOTIFY_LINE_IN:
 315                 notif = &rt->line_in_notify;
 316                 name = "linein-detect";
 317                 irq = linein_detect_irq;
 318                 break;
 319         case AOA_NOTIFY_LINE_OUT:
 320                 notif = &rt->line_out_notify;
 321                 name = "lineout-detect";
 322                 irq = lineout_detect_irq;
 323                 break;
 324         default:
 325                 return -EINVAL;
 326         }
 327
 328         if (irq == NO_IRQ)
 329                 return -ENODEV;
 330
 331         mutex_lock(&notif->mutex);
 332
 333         old = notif->notify;
 334
 335         if (!old && !notify) {
 336                 err = 0;
 337                 goto out_unlock;
 338         }
 339
 340         if (old && notify) {
 341                 if (old == notify && notif->data == data)
 342                         err = 0;
 343                 goto out_unlock;
 344         }
 345
 346         if (old && !notify)
 347                 free_irq(irq, notif);
 348
 349         if (!old && notify) {
 350                 err = request_irq(irq, ftr_handle_notify_irq, 0, name, notif);
 351                 if (err)
 352                         goto out_unlock;
 353         }
 354
 355         notif->notify = notify;
 356         notif->data = data;
 357
 358         err = 0;
 359  out_unlock:
 360         mutex_unlock(&notif->mutex);
 361         return err;
 362 }
 363
 364 static int ftr_get_detect(struct gpio_runtime *rt,
 365                           enum notify_type type)
 366 {
 367         int gpio, ret, active;
 368
 369         switch (type) {
 370         case AOA_NOTIFY_HEADPHONE:
 371                 gpio = headphone_detect_gpio;
 372                 active = headphone_detect_gpio_activestate;
 373                 break;
 374         case AOA_NOTIFY_LINE_IN:
 375                 gpio = linein_detect_gpio;
 376                 active = linein_detect_gpio_activestate;
 377                 break;
 378         case AOA_NOTIFY_LINE_OUT:
 379                 gpio = lineout_detect_gpio;
 380                 active = lineout_detect_gpio_activestate;
 381                 break;
 382         default:
 383                 return -EINVAL;
 384         }
 385
 386         if (gpio == -1)
 387                 return -ENODEV;
 388
 389         ret = pmac_call_feature(PMAC_FTR_READ_GPIO, NULL, gpio, 0);
 390         if (ret < 0)
 391                 return ret;
 392         return ((ret >> 1) & 1) == active;
 393 }
 394
 395 static struct gpio_methods methods = {
 396         .init                   = ftr_gpio_init,
 397         .exit                   = ftr_gpio_exit,
 398         .all_amps_off           = ftr_gpio_all_amps_off,
 399         .all_amps_restore       = ftr_gpio_all_amps_restore,
 400         .set_headphone          = ftr_gpio_set_headphone,
 401         .set_speakers           = ftr_gpio_set_amp,
 402         .set_lineout            = ftr_gpio_set_lineout,
 403         .set_hw_reset           = ftr_gpio_set_hw_reset,
 404         .get_headphone          = ftr_gpio_get_headphone,
 405         .get_speakers           = ftr_gpio_get_amp,
 406         .get_lineout            = ftr_gpio_get_lineout,
 407         .set_notify             = ftr_set_notify,
 408         .get_detect             = ftr_get_detect,
 409 };
 410
 411 struct gpio_methods *ftr_gpio_methods = &methods;
 412 EXPORT_SYMBOL_GPL(ftr_gpio_methods);