sound/soc/codecs/rt5677-spi.c

   1 /*
   2  * rt5677-spi.c  --  RT5677 ALSA SoC audio codec driver
   3  *
   4  * Copyright 2013 Realtek Semiconductor Corp.
   5  * Author: Oder Chiou <oder_chiou@realtek.com>
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License version 2 as
   9  * published by the Free Software Foundation.
  10  */
  11
  12 #include <linux/module.h>
  13 #include <linux/input.h>
  14 #include <linux/spi/spi.h>
  15 #include <linux/device.h>
  16 #include <linux/init.h>
  17 #include <linux/delay.h>
  18 #include <linux/interrupt.h>
  19 #include <linux/irq.h>
  20 #include <linux/slab.h>
  21 #include <linux/sched.h>
  22 #include <linux/uaccess.h>
  23 #include <linux/regulator/consumer.h>
  24 #include <linux/pm_qos.h>
  25 #include <linux/sysfs.h>
  26 #include <linux/clk.h>
  27 #include <linux/firmware.h>
  28 #include <linux/acpi.h>
  29
  30 #include "rt5677-spi.h"
  31
  32 #define DRV_NAME "rt5677spi"
  33
  34 #define RT5677_SPI_BURST_LEN    240
  35 #define RT5677_SPI_HEADER       5
  36 #define RT5677_SPI_FREQ         6000000
  37
  38 /* The AddressPhase and DataPhase of SPI commands are MSB first on the wire.
  39  * DataPhase word size of 16-bit commands is 2 bytes.
  40  * DataPhase word size of 32-bit commands is 4 bytes.
  41  * DataPhase word size of burst commands is 8 bytes.
  42  * The DSP CPU is little-endian.
  43  */
  44 #define RT5677_SPI_WRITE_BURST  0x5
  45 #define RT5677_SPI_READ_BURST   0x4
  46 #define RT5677_SPI_WRITE_32     0x3
  47 #define RT5677_SPI_READ_32      0x2
  48 #define RT5677_SPI_WRITE_16     0x1
  49 #define RT5677_SPI_READ_16      0x0
  50
  51 static struct spi_device *g_spi;
  52 static DEFINE_MUTEX(spi_mutex);
  53
  54 /* Select a suitable transfer command for the next transfer to ensure
  55  * the transfer address is always naturally aligned while minimizing
  56  * the total number of transfers required.
  57  *
  58  * 3 transfer commands are available:
  59  * RT5677_SPI_READ/WRITE_16:    Transfer 2 bytes
  60  * RT5677_SPI_READ/WRITE_32:    Transfer 4 bytes
  61  * RT5677_SPI_READ/WRITE_BURST: Transfer any multiples of 8 bytes
  62  *
  63  * Note:
  64  * 16 Bit writes and reads are restricted to the address range
  65  * 0x18020000 ~ 0x18021000
  66  *
  67  * For example, reading 256 bytes at 0x60030004 uses the following commands:
  68  * 0x60030004 RT5677_SPI_READ_32        4 bytes
  69  * 0x60030008 RT5677_SPI_READ_BURST     240 bytes
  70  * 0x600300F8 RT5677_SPI_READ_BURST     8 bytes
  71  * 0x60030100 RT5677_SPI_READ_32        4 bytes
  72  *
  73  * Input:
  74  * @read: true for read commands; false for write commands
  75  * @align: alignment of the next transfer address
  76  * @remain: number of bytes remaining to transfer
  77  *
  78  * Output:
  79  * @len: number of bytes to transfer with the selected command
  80  * Returns the selected command
  81  */
  82 static u8 rt5677_spi_select_cmd(bool read, u32 align, u32 remain, u32 *len)
  83 {
  84         u8 cmd;
  85
  86         if (align == 4 || remain <= 4) {
  87                 cmd = RT5677_SPI_READ_32;
  88                 *len = 4;
  89         } else {
  90                 cmd = RT5677_SPI_READ_BURST;
  91                 *len = (((remain - 1) >> 3) + 1) << 3;
  92                 *len = min_t(u32, *len, RT5677_SPI_BURST_LEN);
  93         }
  94         return read ? cmd : cmd + 1;
  95 }
  96
  97 /* Copy dstlen bytes from src to dst, while reversing byte order for each word.
  98  * If srclen < dstlen, zeros are padded.
  99  */
 100 static void rt5677_spi_reverse(u8 *dst, u32 dstlen, const u8 *src, u32 srclen)
 101 {
 102         u32 w, i, si;
 103         u32 word_size = min_t(u32, dstlen, 8);
 104
 105         for (w = 0; w < dstlen; w += word_size) {
 106                 for (i = 0; i < word_size && i + w < dstlen; i++) {
 107                         si = w + word_size - i - 1;
 108                         dst[w + i] = si < srclen ? src[si] : 0;
 109                 }
 110         }
 111 }
 112
 113 /* Read DSP address space using SPI. addr and len have to be 4-byte aligned. */
 114 int rt5677_spi_read(u32 addr, void *rxbuf, size_t len)
 115 {
 116         u32 offset;
 117         int status = 0;
 118         struct spi_transfer t[2];
 119         struct spi_message m;
 120         /* +4 bytes is for the DummyPhase following the AddressPhase */
 121         u8 header[RT5677_SPI_HEADER + 4];
 122         u8 body[RT5677_SPI_BURST_LEN];
 123         u8 spi_cmd;
 124         u8 *cb = rxbuf;
 125
 126         if (!g_spi)
 127                 return -ENODEV;
 128
 129         if ((addr & 3) || (len & 3)) {
 130                 dev_err(&g_spi->dev, "Bad read align 0x%x(%zu)\n", addr, len);
 131                 return -EACCES;
 132         }
 133
 134         memset(t, 0, sizeof(t));
 135         t[0].tx_buf = header;
 136         t[0].len = sizeof(header);
 137         t[0].speed_hz = RT5677_SPI_FREQ;
 138         t[1].rx_buf = body;
 139         t[1].speed_hz = RT5677_SPI_FREQ;
 140         spi_message_init_with_transfers(&m, t, ARRAY_SIZE(t));
 141
 142         for (offset = 0; offset < len; offset += t[1].len) {
 143                 spi_cmd = rt5677_spi_select_cmd(true, (addr + offset) & 7,
 144                                 len - offset, &t[1].len);
 145
 146                 /* Construct SPI message header */
 147                 header[0] = spi_cmd;
 148                 header[1] = ((addr + offset) & 0xff000000) >> 24;
 149                 header[2] = ((addr + offset) & 0x00ff0000) >> 16;
 150                 header[3] = ((addr + offset) & 0x0000ff00) >> 8;
 151                 header[4] = ((addr + offset) & 0x000000ff) >> 0;
 152
 153                 mutex_lock(&spi_mutex);
 154                 status |= spi_sync(g_spi, &m);
 155                 mutex_unlock(&spi_mutex);
 156
 157
 158                 /* Copy data back to caller buffer */
 159                 rt5677_spi_reverse(cb + offset, len - offset, body, t[1].len);
 160         }
 161         return status;
 162 }
 163 EXPORT_SYMBOL_GPL(rt5677_spi_read);
 164
 165 /* Write DSP address space using SPI. addr has to be 4-byte aligned.
 166  * If len is not 4-byte aligned, then extra zeros are written at the end
 167  * as padding.
 168  */
 169 int rt5677_spi_write(u32 addr, const void *txbuf, size_t len)
 170 {
 171         u32 offset;
 172         int status = 0;
 173         struct spi_transfer t;
 174         struct spi_message m;
 175         /* +1 byte is for the DummyPhase following the DataPhase */
 176         u8 buf[RT5677_SPI_HEADER + RT5677_SPI_BURST_LEN + 1];
 177         u8 *body = buf + RT5677_SPI_HEADER;
 178         u8 spi_cmd;
 179         const u8 *cb = txbuf;
 180
 181         if (!g_spi)
 182                 return -ENODEV;
 183
 184         if (addr & 3) {
 185                 dev_err(&g_spi->dev, "Bad write align 0x%x(%zu)\n", addr, len);
 186                 return -EACCES;
 187         }
 188
 189         memset(&t, 0, sizeof(t));
 190         t.tx_buf = buf;
 191         t.speed_hz = RT5677_SPI_FREQ;
 192         spi_message_init_with_transfers(&m, &t, 1);
 193
 194         for (offset = 0; offset < len;) {
 195                 spi_cmd = rt5677_spi_select_cmd(false, (addr + offset) & 7,
 196                                 len - offset, &t.len);
 197
 198                 /* Construct SPI message header */
 199                 buf[0] = spi_cmd;
 200                 buf[1] = ((addr + offset) & 0xff000000) >> 24;
 201                 buf[2] = ((addr + offset) & 0x00ff0000) >> 16;
 202                 buf[3] = ((addr + offset) & 0x0000ff00) >> 8;
 203                 buf[4] = ((addr + offset) & 0x000000ff) >> 0;
 204
 205                 /* Fetch data from caller buffer */
 206                 rt5677_spi_reverse(body, t.len, cb + offset, len - offset);
 207                 offset += t.len;
 208                 t.len += RT5677_SPI_HEADER + 1;
 209
 210                 mutex_lock(&spi_mutex);
 211                 status |= spi_sync(g_spi, &m);
 212                 mutex_unlock(&spi_mutex);
 213         }
 214         return status;
 215 }
 216 EXPORT_SYMBOL_GPL(rt5677_spi_write);
 217
 218 int rt5677_spi_write_firmware(u32 addr, const struct firmware *fw)
 219 {
 220         return rt5677_spi_write(addr, fw->data, fw->size);
 221 }
 222 EXPORT_SYMBOL_GPL(rt5677_spi_write_firmware);
 223
 224 static int rt5677_spi_probe(struct spi_device *spi)
 225 {
 226         g_spi = spi;
 227         return 0;
 228 }
 229
 230 static const struct acpi_device_id rt5677_spi_acpi_id[] = {
 231         { "RT5677AA", 0 },
 232         { }
 233 };
 234 MODULE_DEVICE_TABLE(acpi, rt5677_spi_acpi_id);
 235
 236 static struct spi_driver rt5677_spi_driver = {
 237         .driver = {
 238                 .name = DRV_NAME,
 239                 .acpi_match_table = ACPI_PTR(rt5677_spi_acpi_id),
 240         },
 241         .probe = rt5677_spi_probe,
 242 };
 243 module_spi_driver(rt5677_spi_driver);
 244
 245 MODULE_DESCRIPTION("ASoC RT5677 SPI driver");
 246 MODULE_AUTHOR("Oder Chiou <oder_chiou@realtek.com>");
 247 MODULE_LICENSE("GPL v2");