sound/hda/hdac_regmap.c

   1 /*
   2  * Regmap support for HD-audio verbs
   3  *
   4  * A virtual register is translated to one or more hda verbs for write,
   5  * vice versa for read.
   6  *
   7  * A few limitations:
   8  * - Provided for not all verbs but only subset standard non-volatile verbs.
   9  * - For reading, only AC_VERB_GET_* variants can be used.
  10  * - For writing, mapped to the *corresponding* AC_VERB_SET_* variants,
  11  *   so can't handle asymmetric verbs for read and write
  12  */
  13
  14 #include <linux/slab.h>
  15 #include <linux/device.h>
  16 #include <linux/regmap.h>
  17 #include <linux/export.h>
  18 #include <linux/pm.h>
  19 #include <linux/pm_runtime.h>
  20 #include <sound/core.h>
  21 #include <sound/hdaudio.h>
  22 #include <sound/hda_regmap.h>
  23
  24 #ifdef CONFIG_PM
  25 #define codec_is_running(codec)                         \
  26         (atomic_read(&(codec)->in_pm) ||                \
  27          !pm_runtime_suspended(&(codec)->dev))
  28 #else
  29 #define codec_is_running(codec)         true
  30 #endif
  31
  32 #define get_verb(reg)   (((reg) >> 8) & 0xfff)
  33
  34 static bool hda_volatile_reg(struct device *dev, unsigned int reg)
  35 {
  36         struct hdac_device *codec = dev_to_hdac_dev(dev);
  37         unsigned int verb = get_verb(reg);
  38
  39         switch (verb) {
  40         case AC_VERB_GET_PROC_COEF:
  41                 return !codec->cache_coef;
  42         case AC_VERB_GET_COEF_INDEX:
  43         case AC_VERB_GET_PROC_STATE:
  44         case AC_VERB_GET_POWER_STATE:
  45         case AC_VERB_GET_PIN_SENSE:
  46         case AC_VERB_GET_HDMI_DIP_SIZE:
  47         case AC_VERB_GET_HDMI_ELDD:
  48         case AC_VERB_GET_HDMI_DIP_INDEX:
  49         case AC_VERB_GET_HDMI_DIP_DATA:
  50         case AC_VERB_GET_HDMI_DIP_XMIT:
  51         case AC_VERB_GET_HDMI_CP_CTRL:
  52         case AC_VERB_GET_HDMI_CHAN_SLOT:
  53         case AC_VERB_GET_DEVICE_SEL:
  54         case AC_VERB_GET_DEVICE_LIST:   /* read-only volatile */
  55                 return true;
  56         }
  57
  58         return false;
  59 }
  60
  61 static bool hda_writeable_reg(struct device *dev, unsigned int reg)
  62 {
  63         struct hdac_device *codec = dev_to_hdac_dev(dev);
  64         unsigned int verb = get_verb(reg);
  65         int i;
  66
  67         for (i = 0; i < codec->vendor_verbs.used; i++) {
  68                 unsigned int *v = snd_array_elem(&codec->vendor_verbs, i);
  69                 if (verb == *v)
  70                         return true;
  71         }
  72
  73         if (codec->caps_overwriting)
  74                 return true;
  75
  76         switch (verb & 0xf00) {
  77         case AC_VERB_GET_STREAM_FORMAT:
  78         case AC_VERB_GET_AMP_GAIN_MUTE:
  79                 return true;
  80         case AC_VERB_GET_PROC_COEF:
  81                 return codec->cache_coef;
  82         case 0xf00:
  83                 break;
  84         default:
  85                 return false;
  86         }
  87
  88         switch (verb) {
  89         case AC_VERB_GET_CONNECT_SEL:
  90         case AC_VERB_GET_SDI_SELECT:
  91         case AC_VERB_GET_CONV:
  92         case AC_VERB_GET_PIN_WIDGET_CONTROL:
  93         case AC_VERB_GET_UNSOLICITED_RESPONSE: /* only as SET_UNSOLICITED_ENABLE */
  94         case AC_VERB_GET_BEEP_CONTROL:
  95         case AC_VERB_GET_EAPD_BTLENABLE:
  96         case AC_VERB_GET_DIGI_CONVERT_1:
  97         case AC_VERB_GET_DIGI_CONVERT_2: /* only for beep control */
  98         case AC_VERB_GET_VOLUME_KNOB_CONTROL:
  99         case AC_VERB_GET_CONFIG_DEFAULT:
 100         case AC_VERB_GET_GPIO_MASK:
 101         case AC_VERB_GET_GPIO_DIRECTION:
 102         case AC_VERB_GET_GPIO_DATA: /* not for volatile read */
 103         case AC_VERB_GET_GPIO_WAKE_MASK:
 104         case AC_VERB_GET_GPIO_UNSOLICITED_RSP_MASK:
 105         case AC_VERB_GET_GPIO_STICKY_MASK:
 106         case AC_VERB_GET_CVT_CHAN_COUNT:
 107                 return true;
 108         }
 109
 110         return false;
 111 }
 112
 113 static bool hda_readable_reg(struct device *dev, unsigned int reg)
 114 {
 115         struct hdac_device *codec = dev_to_hdac_dev(dev);
 116         unsigned int verb = get_verb(reg);
 117
 118         if (codec->caps_overwriting)
 119                 return true;
 120
 121         switch (verb) {
 122         case AC_VERB_PARAMETERS:
 123         case AC_VERB_GET_CONNECT_LIST:
 124         case AC_VERB_GET_SUBSYSTEM_ID:
 125                 return true;
 126         }
 127
 128         return hda_writeable_reg(dev, reg);
 129 }
 130
 131 /*
 132  * Stereo amp pseudo register:
 133  * for making easier to handle the stereo volume control, we provide a
 134  * fake register to deal both left and right channels by a single
 135  * (pseudo) register access.  A verb consisting of SET_AMP_GAIN with
 136  * *both* SET_LEFT and SET_RIGHT bits takes a 16bit value, the lower 8bit
 137  * for the left and the upper 8bit for the right channel.
 138  */
 139 static bool is_stereo_amp_verb(unsigned int reg)
 140 {
 141         if (((reg >> 8) & 0x700) != AC_VERB_SET_AMP_GAIN_MUTE)
 142                 return false;
 143         return (reg & (AC_AMP_SET_LEFT | AC_AMP_SET_RIGHT)) ==
 144                 (AC_AMP_SET_LEFT | AC_AMP_SET_RIGHT);
 145 }
 146
 147 /* read a pseudo stereo amp register (16bit left+right) */
 148 static int hda_reg_read_stereo_amp(struct hdac_device *codec,
 149                                    unsigned int reg, unsigned int *val)
 150 {
 151         unsigned int left, right;
 152         int err;
 153
 154         reg &= ~(AC_AMP_SET_LEFT | AC_AMP_SET_RIGHT);
 155         err = snd_hdac_exec_verb(codec, reg | AC_AMP_GET_LEFT, 0, &left);
 156         if (err < 0)
 157                 return err;
 158         err = snd_hdac_exec_verb(codec, reg | AC_AMP_GET_RIGHT, 0, &right);
 159         if (err < 0)
 160                 return err;
 161         *val = left | (right << 8);
 162         return 0;
 163 }
 164
 165 /* write a pseudo stereo amp register (16bit left+right) */
 166 static int hda_reg_write_stereo_amp(struct hdac_device *codec,
 167                                     unsigned int reg, unsigned int val)
 168 {
 169         int err;
 170         unsigned int verb, left, right;
 171
 172         verb = AC_VERB_SET_AMP_GAIN_MUTE << 8;
 173         if (reg & AC_AMP_GET_OUTPUT)
 174                 verb |= AC_AMP_SET_OUTPUT;
 175         else
 176                 verb |= AC_AMP_SET_INPUT | ((reg & 0xf) << 8);
 177         reg = (reg & ~0xfffff) | verb;
 178
 179         left = val & 0xff;
 180         right = (val >> 8) & 0xff;
 181         if (left == right) {
 182                 reg |= AC_AMP_SET_LEFT | AC_AMP_SET_RIGHT;
 183                 return snd_hdac_exec_verb(codec, reg | left, 0, NULL);
 184         }
 185
 186         err = snd_hdac_exec_verb(codec, reg | AC_AMP_SET_LEFT | left, 0, NULL);
 187         if (err < 0)
 188                 return err;
 189         err = snd_hdac_exec_verb(codec, reg | AC_AMP_SET_RIGHT | right, 0, NULL);
 190         if (err < 0)
 191                 return err;
 192         return 0;
 193 }
 194
 195 /* read a pseudo coef register (16bit) */
 196 static int hda_reg_read_coef(struct hdac_device *codec, unsigned int reg,
 197                              unsigned int *val)
 198 {
 199         unsigned int verb;
 200         int err;
 201
 202         if (!codec->cache_coef)
 203                 return -EINVAL;
 204         /* LSB 8bit = coef index */
 205         verb = (reg & ~0xfff00) | (AC_VERB_SET_COEF_INDEX << 8);
 206         err = snd_hdac_exec_verb(codec, verb, 0, NULL);
 207         if (err < 0)
 208                 return err;
 209         verb = (reg & ~0xfffff) | (AC_VERB_GET_COEF_INDEX << 8);
 210         return snd_hdac_exec_verb(codec, verb, 0, val);
 211 }
 212
 213 /* write a pseudo coef register (16bit) */
 214 static int hda_reg_write_coef(struct hdac_device *codec, unsigned int reg,
 215                               unsigned int val)
 216 {
 217         unsigned int verb;
 218         int err;
 219
 220         if (!codec->cache_coef)
 221                 return -EINVAL;
 222         /* LSB 8bit = coef index */
 223         verb = (reg & ~0xfff00) | (AC_VERB_SET_COEF_INDEX << 8);
 224         err = snd_hdac_exec_verb(codec, verb, 0, NULL);
 225         if (err < 0)
 226                 return err;
 227         verb = (reg & ~0xfffff) | (AC_VERB_GET_COEF_INDEX << 8) |
 228                 (val & 0xffff);
 229         return snd_hdac_exec_verb(codec, verb, 0, NULL);
 230 }
 231
 232 static int hda_reg_read(void *context, unsigned int reg, unsigned int *val)
 233 {
 234         struct hdac_device *codec = context;
 235         int verb = get_verb(reg);
 236         int err;
 237
 238         if (!codec_is_running(codec))
 239                 return -EAGAIN;
 240         reg |= (codec->addr << 28);
 241         if (is_stereo_amp_verb(reg))
 242                 return hda_reg_read_stereo_amp(codec, reg, val);
 243         if (verb == AC_VERB_GET_PROC_COEF)
 244                 return hda_reg_read_coef(codec, reg, val);
 245         err = snd_hdac_exec_verb(codec, reg, 0, val);
 246         if (err < 0)
 247                 return err;
 248         /* special handling for asymmetric reads */
 249         if (verb == AC_VERB_GET_POWER_STATE) {
 250                 if (*val & AC_PWRST_ERROR)
 251                         *val = -1;
 252                 else /* take only the actual state */
 253                         *val = (*val >> 4) & 0x0f;
 254         }
 255         return 0;
 256 }
 257
 258 static int hda_reg_write(void *context, unsigned int reg, unsigned int val)
 259 {
 260         struct hdac_device *codec = context;
 261         unsigned int verb;
 262         int i, bytes, err;
 263
 264         if (!codec_is_running(codec))
 265                 return codec->lazy_cache ? 0 : -EAGAIN;
 266
 267         reg &= ~0x00080000U; /* drop GET bit */
 268         reg |= (codec->addr << 28);
 269
 270         if (is_stereo_amp_verb(reg))
 271                 return hda_reg_write_stereo_amp(codec, reg, val);
 272
 273         verb = get_verb(reg);
 274         if (verb == AC_VERB_SET_PROC_COEF)
 275                 return hda_reg_write_coef(codec, reg, val);
 276
 277         switch (verb & 0xf00) {
 278         case AC_VERB_SET_AMP_GAIN_MUTE:
 279                 verb = AC_VERB_SET_AMP_GAIN_MUTE;
 280                 if (reg & AC_AMP_GET_LEFT)
 281                         verb |= AC_AMP_SET_LEFT >> 8;
 282                 else
 283                         verb |= AC_AMP_SET_RIGHT >> 8;
 284                 if (reg & AC_AMP_GET_OUTPUT) {
 285                         verb |= AC_AMP_SET_OUTPUT >> 8;
 286                 } else {
 287                         verb |= AC_AMP_SET_INPUT >> 8;
 288                         verb |= reg & 0xf;
 289                 }
 290                 break;
 291         }
 292
 293         switch (verb) {
 294         case AC_VERB_SET_DIGI_CONVERT_1:
 295                 bytes = 2;
 296                 break;
 297         case AC_VERB_SET_CONFIG_DEFAULT_BYTES_0:
 298                 bytes = 4;
 299                 break;
 300         default:
 301                 bytes = 1;
 302                 break;
 303         }
 304
 305         for (i = 0; i < bytes; i++) {
 306                 reg &= ~0xfffff;
 307                 reg |= (verb + i) << 8 | ((val >> (8 * i)) & 0xff);
 308                 err = snd_hdac_exec_verb(codec, reg, 0, NULL);
 309                 if (err < 0)
 310                         return err;
 311         }
 312
 313         return 0;
 314 }
 315
 316 static const struct regmap_config hda_regmap_cfg = {
 317         .name = "hdaudio",
 318         .reg_bits = 32,
 319         .val_bits = 32,
 320         .max_register = 0xfffffff,
 321         .writeable_reg = hda_writeable_reg,
 322         .readable_reg = hda_readable_reg,
 323         .volatile_reg = hda_volatile_reg,
 324         .cache_type = REGCACHE_RBTREE,
 325         .reg_read = hda_reg_read,
 326         .reg_write = hda_reg_write,
 327 };
 328
 329 int snd_hdac_regmap_init(struct hdac_device *codec)
 330 {
 331         struct regmap *regmap;
 332
 333         regmap = regmap_init(&codec->dev, NULL, codec, &hda_regmap_cfg);
 334         if (IS_ERR(regmap))
 335                 return PTR_ERR(regmap);
 336         codec->regmap = regmap;
 337         snd_array_init(&codec->vendor_verbs, sizeof(unsigned int), 8);
 338         return 0;
 339 }
 340 EXPORT_SYMBOL_GPL(snd_hdac_regmap_init);
 341
 342 void snd_hdac_regmap_exit(struct hdac_device *codec)
 343 {
 344         if (codec->regmap) {
 345                 regmap_exit(codec->regmap);
 346                 codec->regmap = NULL;
 347                 snd_array_free(&codec->vendor_verbs);
 348         }
 349 }
 350 EXPORT_SYMBOL_GPL(snd_hdac_regmap_exit);
 351
 352 /**
 353  * snd_hdac_regmap_add_vendor_verb - add a vendor-specific verb to regmap
 354  * @codec: the codec object
 355  * @verb: verb to allow accessing via regmap
 356  *
 357  * Returns zero for success or a negative error code.
 358  */
 359 int snd_hdac_regmap_add_vendor_verb(struct hdac_device *codec,
 360                                     unsigned int verb)
 361 {
 362         unsigned int *p = snd_array_new(&codec->vendor_verbs);
 363
 364         if (!p)
 365                 return -ENOMEM;
 366         *p = verb;
 367         return 0;
 368 }
 369 EXPORT_SYMBOL_GPL(snd_hdac_regmap_add_vendor_verb);
 370
 371 /*
 372  * helper functions
 373  */
 374
 375 /* write a pseudo-register value (w/o power sequence) */
 376 static int reg_raw_write(struct hdac_device *codec, unsigned int reg,
 377                          unsigned int val)
 378 {
 379         if (!codec->regmap)
 380                 return hda_reg_write(codec, reg, val);
 381         else
 382                 return regmap_write(codec->regmap, reg, val);
 383 }
 384
 385 /**
 386  * snd_hdac_regmap_write_raw - write a pseudo register with power mgmt
 387  * @codec: the codec object
 388  * @reg: pseudo register
 389  * @val: value to write
 390  *
 391  * Returns zero if successful or a negative error code.
 392  */
 393 int snd_hdac_regmap_write_raw(struct hdac_device *codec, unsigned int reg,
 394                               unsigned int val)
 395 {
 396         int err;
 397
 398         err = reg_raw_write(codec, reg, val);
 399         if (err == -EAGAIN) {
 400                 snd_hdac_power_up(codec);
 401                 err = reg_raw_write(codec, reg, val);
 402                 snd_hdac_power_down(codec);
 403         }
 404         return err;
 405 }
 406 EXPORT_SYMBOL_GPL(snd_hdac_regmap_write_raw);
 407
 408 static int reg_raw_read(struct hdac_device *codec, unsigned int reg,
 409                         unsigned int *val)
 410 {
 411         if (!codec->regmap)
 412                 return hda_reg_read(codec, reg, val);
 413         else
 414                 return regmap_read(codec->regmap, reg, val);
 415 }
 416
 417 /**
 418  * snd_hdac_regmap_read_raw - read a pseudo register with power mgmt
 419  * @codec: the codec object
 420  * @reg: pseudo register
 421  * @val: pointer to store the read value
 422  *
 423  * Returns zero if successful or a negative error code.
 424  */
 425 int snd_hdac_regmap_read_raw(struct hdac_device *codec, unsigned int reg,
 426                              unsigned int *val)
 427 {
 428         int err;
 429
 430         err = reg_raw_read(codec, reg, val);
 431         if (err == -EAGAIN) {
 432                 snd_hdac_power_up(codec);
 433                 err = reg_raw_read(codec, reg, val);
 434                 snd_hdac_power_down(codec);
 435         }
 436         return err;
 437 }
 438 EXPORT_SYMBOL_GPL(snd_hdac_regmap_read_raw);
 439
 440 /**
 441  * snd_hdac_regmap_update_raw - update a pseudo register with power mgmt
 442  * @codec: the codec object
 443  * @reg: pseudo register
 444  * @mask: bit mask to udpate
 445  * @val: value to update
 446  *
 447  * Returns zero if successful or a negative error code.
 448  */
 449 int snd_hdac_regmap_update_raw(struct hdac_device *codec, unsigned int reg,
 450                                unsigned int mask, unsigned int val)
 451 {
 452         unsigned int orig;
 453         int err;
 454
 455         val &= mask;
 456         err = snd_hdac_regmap_read_raw(codec, reg, &orig);
 457         if (err < 0)
 458                 return err;
 459         val |= orig & ~mask;
 460         if (val == orig)
 461                 return 0;
 462         err = snd_hdac_regmap_write_raw(codec, reg, val);
 463         if (err < 0)
 464                 return err;
 465         return 1;
 466 }
 467 EXPORT_SYMBOL_GPL(snd_hdac_regmap_update_raw);