// SPDX-License-Identifier: GPL-2.0-only /* * rt5677-spi.c -- RT5677 ALSA SoC audio codec driver * * Copyright 2013 Realtek Semiconductor Corp. * Author: Oder Chiou <[email protected]> */ #include <linux/module.h> #include <linux/input.h> #include <linux/spi/spi.h> #include <linux/device.h> #include <linux/init.h> #include <linux/delay.h> #include <linux/interrupt.h> #include <linux/irq.h> #include <linux/slab.h> #include <linux/sched.h> #include <linux/uaccess.h> #include <linux/regulator/consumer.h> #include <linux/pm_qos.h> #include <linux/sysfs.h> #include <linux/clk.h> #include <linux/firmware.h> #include <linux/acpi.h> #include <sound/soc.h> #include "rt5677.h" #include "rt5677-spi.h" #define DRV_NAME … #define RT5677_SPI_BURST_LEN … #define RT5677_SPI_HEADER … #define RT5677_SPI_FREQ … /* The AddressPhase and DataPhase of SPI commands are MSB first on the wire. * DataPhase word size of 16-bit commands is 2 bytes. * DataPhase word size of 32-bit commands is 4 bytes. * DataPhase word size of burst commands is 8 bytes. * The DSP CPU is little-endian. */ #define RT5677_SPI_WRITE_BURST … #define RT5677_SPI_READ_BURST … #define RT5677_SPI_WRITE_32 … #define RT5677_SPI_READ_32 … #define RT5677_SPI_WRITE_16 … #define RT5677_SPI_READ_16 … #define RT5677_BUF_BYTES_TOTAL … #define RT5677_MIC_BUF_ADDR … #define RT5677_MODEL_ADDR … #define RT5677_MIC_BUF_BYTES … #define RT5677_MIC_BUF_FIRST_READ_SIZE … static struct spi_device *g_spi; static DEFINE_MUTEX(spi_mutex); struct rt5677_dsp { … }; static const struct snd_pcm_hardware rt5677_spi_pcm_hardware = …; static struct snd_soc_dai_driver rt5677_spi_dai = …; /* PCM for streaming audio from the DSP buffer */ static int rt5677_spi_pcm_open( struct snd_soc_component *component, struct snd_pcm_substream *substream) { … } static int rt5677_spi_pcm_close( struct snd_soc_component *component, struct snd_pcm_substream *substream) { … } static int rt5677_spi_hw_params( struct snd_soc_component *component, struct snd_pcm_substream *substream, struct snd_pcm_hw_params *hw_params) { … } static int rt5677_spi_hw_free( struct snd_soc_component *component, struct snd_pcm_substream *substream) { … } static int rt5677_spi_prepare( struct snd_soc_component *component, struct snd_pcm_substream *substream) { … } static snd_pcm_uframes_t rt5677_spi_pcm_pointer( struct snd_soc_component *component, struct snd_pcm_substream *substream) { … } static int rt5677_spi_mic_write_offset(u32 *mic_write_offset) { … } /* * Copy one contiguous block of audio samples from the DSP mic buffer to the * dma_area of the pcm runtime. The receiving buffer may wrap around. * @begin: start offset of the block to copy, in bytes. * @end: offset of the first byte after the block to copy, must be greater * than or equal to begin. * * Return: Zero if successful, or a negative error code on failure. */ static int rt5677_spi_copy_block(struct rt5677_dsp *rt5677_dsp, u32 begin, u32 end) { … } /* * Copy a given amount of audio samples from the DSP mic buffer starting at * mic_read_offset, to the dma_area of the pcm runtime. The source buffer may * wrap around. mic_read_offset is updated after successful copy. * @amount: amount of samples to copy, in bytes. * * Return: Zero if successful, or a negative error code on failure. */ static int rt5677_spi_copy(struct rt5677_dsp *rt5677_dsp, u32 amount) { … } /* * A delayed work that streams audio samples from the DSP mic buffer to the * dma_area of the pcm runtime via SPI. */ static void rt5677_spi_copy_work(struct work_struct *work) { … } static int rt5677_spi_pcm_new(struct snd_soc_component *component, struct snd_soc_pcm_runtime *rtd) { … } static int rt5677_spi_pcm_probe(struct snd_soc_component *component) { … } static const struct snd_soc_component_driver rt5677_spi_dai_component = …; /* Select a suitable transfer command for the next transfer to ensure * the transfer address is always naturally aligned while minimizing * the total number of transfers required. * * 3 transfer commands are available: * RT5677_SPI_READ/WRITE_16: Transfer 2 bytes * RT5677_SPI_READ/WRITE_32: Transfer 4 bytes * RT5677_SPI_READ/WRITE_BURST: Transfer any multiples of 8 bytes * * Note: * 16 Bit writes and reads are restricted to the address range * 0x18020000 ~ 0x18021000 * * For example, reading 256 bytes at 0x60030004 uses the following commands: * 0x60030004 RT5677_SPI_READ_32 4 bytes * 0x60030008 RT5677_SPI_READ_BURST 240 bytes * 0x600300F8 RT5677_SPI_READ_BURST 8 bytes * 0x60030100 RT5677_SPI_READ_32 4 bytes * * Input: * @read: true for read commands; false for write commands * @align: alignment of the next transfer address * @remain: number of bytes remaining to transfer * * Output: * @len: number of bytes to transfer with the selected command * Returns the selected command */ static u8 rt5677_spi_select_cmd(bool read, u32 align, u32 remain, u32 *len) { … } /* Copy dstlen bytes from src to dst, while reversing byte order for each word. * If srclen < dstlen, zeros are padded. */ static void rt5677_spi_reverse(u8 *dst, u32 dstlen, const u8 *src, u32 srclen) { … } /* Read DSP address space using SPI. addr and len have to be 4-byte aligned. */ int rt5677_spi_read(u32 addr, void *rxbuf, size_t len) { … } EXPORT_SYMBOL_GPL(…); /* Write DSP address space using SPI. addr has to be 4-byte aligned. * If len is not 4-byte aligned, then extra zeros are written at the end * as padding. */ int rt5677_spi_write(u32 addr, const void *txbuf, size_t len) { … } EXPORT_SYMBOL_GPL(…); int rt5677_spi_write_firmware(u32 addr, const struct firmware *fw) { … } EXPORT_SYMBOL_GPL(…); void rt5677_spi_hotword_detected(void) { … } EXPORT_SYMBOL_GPL(…); static int rt5677_spi_probe(struct spi_device *spi) { … } #ifdef CONFIG_ACPI static const struct acpi_device_id rt5677_spi_acpi_id[] = …; MODULE_DEVICE_TABLE(acpi, rt5677_spi_acpi_id); #endif static struct spi_driver rt5677_spi_driver = …; module_spi_driver(…) …; MODULE_DESCRIPTION(…) …; MODULE_AUTHOR(…) …; MODULE_LICENSE(…) …;
Codebase Browser
linux