sound/soc/codecs/sigmadsp-i2c.c
Source file repositories/reference/linux-study-clean/sound/soc/codecs/sigmadsp-i2c.c
File Facts
- System
- Linux kernel
- Corpus path
sound/soc/codecs/sigmadsp-i2c.c- Extension
.c- Size
- 2196 bytes
- Lines
- 97
- Domain
- Driver Families
- Bucket
- sound/soc
- Inferred role
- Driver Families: exported/initcall integration point
- Status
- integration implementation candidate
Why This File Exists
Repeatable hardware-adapter layer. Deep compatibility for every driver is out of scope; this atlas records patterns, probe lifecycles, bus glue, IRQ/DMA usage, and links back to core abstractions.
- Repeatable hardware-adapter layer. Deep compatibility for every driver is out of scope; this atlas records patterns, probe lifecycles, bus glue, IRQ/DMA usage, and links back to core abstractions.
- Exports symbols or registers init work; inspect boot/module ordering and who consumes the exported contract.
- Allocates kernel memory; connect allocation flags and lifetime to context constraints.
- Defines or uses C structs; map object ownership, embedded links, reference counts, and lock ownership.
Dependency Surface
linux/export.hlinux/i2c.hlinux/module.hlinux/slab.hlinux/unaligned.hsigmadsp.h
Detected Declarations
function sigmadsp_write_i2cfunction sigmadsp_read_i2cfunction devm_sigmadsp_init_i2cexport devm_sigmadsp_init_i2c
Annotated Snippet
// SPDX-License-Identifier: GPL-2.0-or-later
/*
* Load Analog Devices SigmaStudio firmware files
*
* Copyright 2009-2011 Analog Devices Inc.
*/
#include <linux/export.h>
#include <linux/i2c.h>
#include <linux/module.h>
#include <linux/slab.h>
#include <linux/unaligned.h>
#include "sigmadsp.h"
static int sigmadsp_write_i2c(void *control_data,
unsigned int addr, const uint8_t data[], size_t len)
{
uint8_t *buf;
int ret;
buf = kzalloc(2 + len, GFP_KERNEL | GFP_DMA);
if (!buf)
return -ENOMEM;
put_unaligned_be16(addr, buf);
memcpy(buf + 2, data, len);
ret = i2c_master_send(control_data, buf, len + 2);
kfree(buf);
if (ret < 0)
return ret;
return 0;
}
static int sigmadsp_read_i2c(void *control_data,
unsigned int addr, uint8_t data[], size_t len)
{
struct i2c_client *client = control_data;
struct i2c_msg msgs[2];
uint8_t buf[2];
int ret;
put_unaligned_be16(addr, buf);
msgs[0].addr = client->addr;
msgs[0].len = sizeof(buf);
msgs[0].buf = buf;
msgs[0].flags = 0;
msgs[1].addr = client->addr;
msgs[1].len = len;
msgs[1].buf = data;
msgs[1].flags = I2C_M_RD;
ret = i2c_transfer(client->adapter, msgs, ARRAY_SIZE(msgs));
if (ret < 0)
return ret;
else if (ret != ARRAY_SIZE(msgs))
return -EIO;
return 0;
}
/**
* devm_sigmadsp_init_i2c() - Initialize SigmaDSP instance
* @client: The parent I2C device
* @ops: The sigmadsp_ops to use for this instance
* @firmware_name: Name of the firmware file to load
*
* Allocates a SigmaDSP instance and loads the specified firmware file.
*
* Returns a pointer to a struct sigmadsp on success, or a PTR_ERR() on error.
*/
struct sigmadsp *devm_sigmadsp_init_i2c(struct i2c_client *client,
const struct sigmadsp_ops *ops, const char *firmware_name)
{
struct sigmadsp *sigmadsp;
sigmadsp = devm_sigmadsp_init(&client->dev, ops, firmware_name);
if (IS_ERR(sigmadsp))
return sigmadsp;
sigmadsp->control_data = client;
sigmadsp->write = sigmadsp_write_i2c;
sigmadsp->read = sigmadsp_read_i2c;
return sigmadsp;
Annotation
- Immediate include surface: `linux/export.h`, `linux/i2c.h`, `linux/module.h`, `linux/slab.h`, `linux/unaligned.h`, `sigmadsp.h`.
- Detected declarations: `function sigmadsp_write_i2c`, `function sigmadsp_read_i2c`, `function devm_sigmadsp_init_i2c`, `export devm_sigmadsp_init_i2c`.
- Atlas domain: Driver Families / sound/soc.
- Implementation status: integration implementation candidate.
Implementation Notes
- This generated page is the file-by-file coverage layer; curated subsystem chapters should link here when they synthesize a multi-file control flow.
- Core OS pages should be promoted from atlas-only to deep-reviewed when they explain data structures, invariants, locking, lifecycle, and C implementation snippets.
- Driver-family pages are intentionally pattern-oriented unless they are part of the selected PCIe/NVMe representative device path.