sound/soc/codecs/sigmadsp.c

   1 /*
   2  * Load Analog Devices SigmaStudio firmware files
   3  *
   4  * Copyright 2009-2011 Analog Devices Inc.
   5  *
   6  * Licensed under the GPL-2 or later.
   7  */
   8
   9 #include <linux/crc32.h>
  10 #include <linux/delay.h>
  11 #include <linux/firmware.h>
  12 #include <linux/kernel.h>
  13 #include <linux/i2c.h>
  14 #include <linux/regmap.h>
  15 #include <linux/module.h>
  16
  17 #include "sigmadsp.h"
  18
  19 #define SIGMA_MAGIC "ADISIGM"
  20
  21 struct sigma_firmware_header {
  22         unsigned char magic[7];
  23         u8 version;
  24         __le32 crc;
  25 } __packed;
  26
  27 enum {
  28         SIGMA_ACTION_WRITEXBYTES = 0,
  29         SIGMA_ACTION_WRITESINGLE,
  30         SIGMA_ACTION_WRITESAFELOAD,
  31         SIGMA_ACTION_DELAY,
  32         SIGMA_ACTION_PLLWAIT,
  33         SIGMA_ACTION_NOOP,
  34         SIGMA_ACTION_END,
  35 };
  36
  37 struct sigma_action {
  38         u8 instr;
  39         u8 len_hi;
  40         __le16 len;
  41         __be16 addr;
  42         unsigned char payload[];
  43 } __packed;
  44
  45 struct sigma_firmware {
  46         const struct firmware *fw;
  47         size_t pos;
  48
  49         void *control_data;
  50         int (*write)(void *control_data, const struct sigma_action *sa,
  51                         size_t len);
  52 };
  53
  54 static inline u32 sigma_action_len(struct sigma_action *sa)
  55 {
  56         return (sa->len_hi << 16) | le16_to_cpu(sa->len);
  57 }
  58
  59 static size_t sigma_action_size(struct sigma_action *sa)
  60 {
  61         size_t payload = 0;
  62
  63         switch (sa->instr) {
  64         case SIGMA_ACTION_WRITEXBYTES:
  65         case SIGMA_ACTION_WRITESINGLE:
  66         case SIGMA_ACTION_WRITESAFELOAD:
  67                 payload = sigma_action_len(sa);
  68                 break;
  69         default:
  70                 break;
  71         }
  72
  73         payload = ALIGN(payload, 2);
  74
  75         return payload + sizeof(struct sigma_action);
  76 }
  77
  78 /*
  79  * Returns a negative error value in case of an error, 0 if processing of
  80  * the firmware should be stopped after this action, 1 otherwise.
  81  */
  82 static int
  83 process_sigma_action(struct sigma_firmware *ssfw, struct sigma_action *sa)
  84 {
  85         size_t len = sigma_action_len(sa);
  86         int ret;
  87
  88         pr_debug("%s: instr:%i addr:%#x len:%zu\n", __func__,
  89                 sa->instr, sa->addr, len);
  90
  91         switch (sa->instr) {
  92         case SIGMA_ACTION_WRITEXBYTES:
  93         case SIGMA_ACTION_WRITESINGLE:
  94         case SIGMA_ACTION_WRITESAFELOAD:
  95                 ret = ssfw->write(ssfw->control_data, sa, len);
  96                 if (ret < 0)
  97                         return -EINVAL;
  98                 break;
  99         case SIGMA_ACTION_DELAY:
 100                 udelay(len);
 101                 len = 0;
 102                 break;
 103         case SIGMA_ACTION_END:
 104                 return 0;
 105         default:
 106                 return -EINVAL;
 107         }
 108
 109         return 1;
 110 }
 111
 112 static int
 113 process_sigma_actions(struct sigma_firmware *ssfw)
 114 {
 115         struct sigma_action *sa;
 116         size_t size;
 117         int ret;
 118
 119         while (ssfw->pos + sizeof(*sa) <= ssfw->fw->size) {
 120                 sa = (struct sigma_action *)(ssfw->fw->data + ssfw->pos);
 121
 122                 size = sigma_action_size(sa);
 123                 ssfw->pos += size;
 124                 if (ssfw->pos > ssfw->fw->size || size == 0)
 125                         break;
 126
 127                 ret = process_sigma_action(ssfw, sa);
 128
 129                 pr_debug("%s: action returned %i\n", __func__, ret);
 130
 131                 if (ret <= 0)
 132                         return ret;
 133         }
 134
 135         if (ssfw->pos != ssfw->fw->size)
 136                 return -EINVAL;
 137
 138         return 0;
 139 }
 140
 141 static int _process_sigma_firmware(struct device *dev,
 142         struct sigma_firmware *ssfw, const char *name)
 143 {
 144         int ret;
 145         struct sigma_firmware_header *ssfw_head;
 146         const struct firmware *fw;
 147         u32 crc;
 148
 149         pr_debug("%s: loading firmware %s\n", __func__, name);
 150
 151         /* first load the blob */
 152         ret = request_firmware(&fw, name, dev);
 153         if (ret) {
 154                 pr_debug("%s: request_firmware() failed with %i\n", __func__, ret);
 155                 return ret;
 156         }
 157         ssfw->fw = fw;
 158
 159         /* then verify the header */
 160         ret = -EINVAL;
 161
 162         /*
 163          * Reject too small or unreasonable large files. The upper limit has been
 164          * chosen a bit arbitrarily, but it should be enough for all practical
 165          * purposes and having the limit makes it easier to avoid integer
 166          * overflows later in the loading process.
 167          */
 168         if (fw->size < sizeof(*ssfw_head) || fw->size >= 0x4000000) {
 169                 dev_err(dev, "Failed to load firmware: Invalid size\n");
 170                 goto done;
 171         }
 172
 173         ssfw_head = (void *)fw->data;
 174         if (memcmp(ssfw_head->magic, SIGMA_MAGIC, ARRAY_SIZE(ssfw_head->magic))) {
 175                 dev_err(dev, "Failed to load firmware: Invalid magic\n");
 176                 goto done;
 177         }
 178
 179         if (ssfw_head->version != 1) {
 180                 dev_err(dev,
 181                         "Failed to load firmware: Invalid version %d. Supported firmware versions: 1\n",
 182                         ssfw_head->version);
 183                 goto done;
 184         }
 185
 186         crc = crc32(0, fw->data + sizeof(*ssfw_head),
 187                         fw->size - sizeof(*ssfw_head));
 188         pr_debug("%s: crc=%x\n", __func__, crc);
 189         if (crc != le32_to_cpu(ssfw_head->crc)) {
 190                 dev_err(dev, "Failed to load firmware: Wrong crc checksum: expected %x got %x\n",
 191                         le32_to_cpu(ssfw_head->crc), crc);
 192                 goto done;
 193         }
 194
 195         ssfw->pos = sizeof(*ssfw_head);
 196
 197         /* finally process all of the actions */
 198         ret = process_sigma_actions(ssfw);
 199
 200  done:
 201         release_firmware(fw);
 202
 203         pr_debug("%s: loaded %s\n", __func__, name);
 204
 205         return ret;
 206 }
 207
 208 #if IS_ENABLED(CONFIG_I2C)
 209
 210 static int sigma_action_write_i2c(void *control_data,
 211         const struct sigma_action *sa, size_t len)
 212 {
 213         return i2c_master_send(control_data, (const unsigned char *)&sa->addr,
 214                 len);
 215 }
 216
 217 int process_sigma_firmware(struct i2c_client *client, const char *name)
 218 {
 219         struct sigma_firmware ssfw;
 220
 221         ssfw.control_data = client;
 222         ssfw.write = sigma_action_write_i2c;
 223
 224         return _process_sigma_firmware(&client->dev, &ssfw, name);
 225 }
 226 EXPORT_SYMBOL(process_sigma_firmware);
 227
 228 #endif
 229
 230 #if IS_ENABLED(CONFIG_REGMAP)
 231
 232 static int sigma_action_write_regmap(void *control_data,
 233         const struct sigma_action *sa, size_t len)
 234 {
 235         return regmap_raw_write(control_data, be16_to_cpu(sa->addr),
 236                 sa->payload, len - 2);
 237 }
 238
 239 int process_sigma_firmware_regmap(struct device *dev, struct regmap *regmap,
 240         const char *name)
 241 {
 242         struct sigma_firmware ssfw;
 243
 244         ssfw.control_data = regmap;
 245         ssfw.write = sigma_action_write_regmap;
 246
 247         return _process_sigma_firmware(dev, &ssfw, name);
 248 }
 249 EXPORT_SYMBOL(process_sigma_firmware_regmap);
 250
 251 #endif
 252
 253 MODULE_LICENSE("GPL");