1 // SPDX-License-Identifier: GPL-2.0-only
3 * rt5677-spi.c -- RT5677 ALSA SoC audio codec driver
5 * Copyright 2013 Realtek Semiconductor Corp.
6 * Author: Oder Chiou <oder_chiou@realtek.com>
9 #include <linux/module.h>
10 #include <linux/input.h>
11 #include <linux/spi/spi.h>
12 #include <linux/device.h>
13 #include <linux/init.h>
14 #include <linux/delay.h>
15 #include <linux/interrupt.h>
16 #include <linux/irq.h>
17 #include <linux/slab.h>
18 #include <linux/sched.h>
19 #include <linux/uaccess.h>
20 #include <linux/regulator/consumer.h>
21 #include <linux/pm_qos.h>
22 #include <linux/sysfs.h>
23 #include <linux/clk.h>
24 #include <linux/firmware.h>
25 #include <linux/acpi.h>
27 #include "rt5677-spi.h"
29 #define DRV_NAME "rt5677spi"
31 #define RT5677_SPI_BURST_LEN 240
32 #define RT5677_SPI_HEADER 5
33 #define RT5677_SPI_FREQ 6000000
35 /* The AddressPhase and DataPhase of SPI commands are MSB first on the wire.
36 * DataPhase word size of 16-bit commands is 2 bytes.
37 * DataPhase word size of 32-bit commands is 4 bytes.
38 * DataPhase word size of burst commands is 8 bytes.
39 * The DSP CPU is little-endian.
41 #define RT5677_SPI_WRITE_BURST 0x5
42 #define RT5677_SPI_READ_BURST 0x4
43 #define RT5677_SPI_WRITE_32 0x3
44 #define RT5677_SPI_READ_32 0x2
45 #define RT5677_SPI_WRITE_16 0x1
46 #define RT5677_SPI_READ_16 0x0
48 static struct spi_device *g_spi;
49 static DEFINE_MUTEX(spi_mutex);
51 /* Select a suitable transfer command for the next transfer to ensure
52 * the transfer address is always naturally aligned while minimizing
53 * the total number of transfers required.
55 * 3 transfer commands are available:
56 * RT5677_SPI_READ/WRITE_16: Transfer 2 bytes
57 * RT5677_SPI_READ/WRITE_32: Transfer 4 bytes
58 * RT5677_SPI_READ/WRITE_BURST: Transfer any multiples of 8 bytes
61 * 16 Bit writes and reads are restricted to the address range
62 * 0x18020000 ~ 0x18021000
64 * For example, reading 256 bytes at 0x60030004 uses the following commands:
65 * 0x60030004 RT5677_SPI_READ_32 4 bytes
66 * 0x60030008 RT5677_SPI_READ_BURST 240 bytes
67 * 0x600300F8 RT5677_SPI_READ_BURST 8 bytes
68 * 0x60030100 RT5677_SPI_READ_32 4 bytes
71 * @read: true for read commands; false for write commands
72 * @align: alignment of the next transfer address
73 * @remain: number of bytes remaining to transfer
76 * @len: number of bytes to transfer with the selected command
77 * Returns the selected command
79 static u8 rt5677_spi_select_cmd(bool read, u32 align, u32 remain, u32 *len)
83 if (align == 4 || remain <= 4) {
84 cmd = RT5677_SPI_READ_32;
87 cmd = RT5677_SPI_READ_BURST;
88 *len = (((remain - 1) >> 3) + 1) << 3;
89 *len = min_t(u32, *len, RT5677_SPI_BURST_LEN);
91 return read ? cmd : cmd + 1;
94 /* Copy dstlen bytes from src to dst, while reversing byte order for each word.
95 * If srclen < dstlen, zeros are padded.
97 static void rt5677_spi_reverse(u8 *dst, u32 dstlen, const u8 *src, u32 srclen)
100 u32 word_size = min_t(u32, dstlen, 8);
102 for (w = 0; w < dstlen; w += word_size) {
103 for (i = 0; i < word_size && i + w < dstlen; i++) {
104 si = w + word_size - i - 1;
105 dst[w + i] = si < srclen ? src[si] : 0;
110 /* Read DSP address space using SPI. addr and len have to be 4-byte aligned. */
111 int rt5677_spi_read(u32 addr, void *rxbuf, size_t len)
115 struct spi_transfer t[2];
116 struct spi_message m;
117 /* +4 bytes is for the DummyPhase following the AddressPhase */
118 u8 header[RT5677_SPI_HEADER + 4];
119 u8 body[RT5677_SPI_BURST_LEN];
126 if ((addr & 3) || (len & 3)) {
127 dev_err(&g_spi->dev, "Bad read align 0x%x(%zu)\n", addr, len);
131 memset(t, 0, sizeof(t));
132 t[0].tx_buf = header;
133 t[0].len = sizeof(header);
134 t[0].speed_hz = RT5677_SPI_FREQ;
136 t[1].speed_hz = RT5677_SPI_FREQ;
137 spi_message_init_with_transfers(&m, t, ARRAY_SIZE(t));
139 for (offset = 0; offset < len; offset += t[1].len) {
140 spi_cmd = rt5677_spi_select_cmd(true, (addr + offset) & 7,
141 len - offset, &t[1].len);
143 /* Construct SPI message header */
145 header[1] = ((addr + offset) & 0xff000000) >> 24;
146 header[2] = ((addr + offset) & 0x00ff0000) >> 16;
147 header[3] = ((addr + offset) & 0x0000ff00) >> 8;
148 header[4] = ((addr + offset) & 0x000000ff) >> 0;
150 mutex_lock(&spi_mutex);
151 status |= spi_sync(g_spi, &m);
152 mutex_unlock(&spi_mutex);
155 /* Copy data back to caller buffer */
156 rt5677_spi_reverse(cb + offset, len - offset, body, t[1].len);
160 EXPORT_SYMBOL_GPL(rt5677_spi_read);
162 /* Write DSP address space using SPI. addr has to be 4-byte aligned.
163 * If len is not 4-byte aligned, then extra zeros are written at the end
166 int rt5677_spi_write(u32 addr, const void *txbuf, size_t len)
170 struct spi_transfer t;
171 struct spi_message m;
172 /* +1 byte is for the DummyPhase following the DataPhase */
173 u8 buf[RT5677_SPI_HEADER + RT5677_SPI_BURST_LEN + 1];
174 u8 *body = buf + RT5677_SPI_HEADER;
176 const u8 *cb = txbuf;
182 dev_err(&g_spi->dev, "Bad write align 0x%x(%zu)\n", addr, len);
186 memset(&t, 0, sizeof(t));
188 t.speed_hz = RT5677_SPI_FREQ;
189 spi_message_init_with_transfers(&m, &t, 1);
191 for (offset = 0; offset < len;) {
192 spi_cmd = rt5677_spi_select_cmd(false, (addr + offset) & 7,
193 len - offset, &t.len);
195 /* Construct SPI message header */
197 buf[1] = ((addr + offset) & 0xff000000) >> 24;
198 buf[2] = ((addr + offset) & 0x00ff0000) >> 16;
199 buf[3] = ((addr + offset) & 0x0000ff00) >> 8;
200 buf[4] = ((addr + offset) & 0x000000ff) >> 0;
202 /* Fetch data from caller buffer */
203 rt5677_spi_reverse(body, t.len, cb + offset, len - offset);
205 t.len += RT5677_SPI_HEADER + 1;
207 mutex_lock(&spi_mutex);
208 status |= spi_sync(g_spi, &m);
209 mutex_unlock(&spi_mutex);
213 EXPORT_SYMBOL_GPL(rt5677_spi_write);
215 int rt5677_spi_write_firmware(u32 addr, const struct firmware *fw)
217 return rt5677_spi_write(addr, fw->data, fw->size);
219 EXPORT_SYMBOL_GPL(rt5677_spi_write_firmware);
221 static int rt5677_spi_probe(struct spi_device *spi)
227 static const struct acpi_device_id rt5677_spi_acpi_id[] = {
231 MODULE_DEVICE_TABLE(acpi, rt5677_spi_acpi_id);
233 static struct spi_driver rt5677_spi_driver = {
236 .acpi_match_table = ACPI_PTR(rt5677_spi_acpi_id),
238 .probe = rt5677_spi_probe,
240 module_spi_driver(rt5677_spi_driver);
242 MODULE_DESCRIPTION("ASoC RT5677 SPI driver");
243 MODULE_AUTHOR("Oder Chiou <oder_chiou@realtek.com>");
244 MODULE_LICENSE("GPL v2");