drivers/firmware/cirrus/test/cs_dsp_mock_mem_maps.c
Source file repositories/reference/linux-study-clean/drivers/firmware/cirrus/test/cs_dsp_mock_mem_maps.c
File Facts
- System
- Linux kernel
- Corpus path
drivers/firmware/cirrus/test/cs_dsp_mock_mem_maps.c- Extension
.c- Size
- 21686 bytes
- Lines
- 726
- Domain
- Driver Families
- Bucket
- drivers/firmware
- 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
kunit/test.hlinux/firmware/cirrus/cs_dsp.hlinux/firmware/cirrus/cs_dsp_test_utils.hlinux/firmware/cirrus/wmfw.hlinux/math.h
Detected Declarations
function cs_dsp_mock_count_regionsfunction cs_dsp_mock_size_of_regionfunction cs_dsp_mock_base_addr_for_memfunction cs_dsp_mock_reg_addr_inc_per_unpacked_wordfunction cs_dsp_mock_reg_block_length_bytesfunction cs_dsp_mock_reg_block_length_registersfunction cs_dsp_mock_reg_block_length_dsp_wordsfunction cs_dsp_mock_has_zmfunction cs_dsp_mock_packed_to_unpacked_mem_typefunction cs_dsp_mock_num_dsp_words_to_num_packed_regsfunction cs_dsp_mock_xm_header_get_alg_base_in_wordsfunction cs_dsp_mock_xm_header_get_fw_versionfunction cs_dsp_mock_xm_header_drop_from_regmap_cachefunction cs_dsp_mock_xm_header_add_adsp2_algsfunction cs_dsp_mock_xm_header_add_halo_algsfunction cs_dsp_mock_xm_header_write_to_regmapfunction cs_dsp_create_mock_xm_header
Annotated Snippet
switch (mem_type) {
case WMFW_ADSP2_PM:
return 3 * regmap_get_val_bytes(priv->dsp->regmap);
case WMFW_ADSP2_XM:
case WMFW_ADSP2_YM:
case WMFW_ADSP2_ZM:
return sizeof(u32);
default:
break;
}
break;
case WMFW_HALO:
switch (mem_type) {
case WMFW_ADSP2_XM:
case WMFW_ADSP2_YM:
return sizeof(u32);
case WMFW_HALO_PM_PACKED:
return 5 * sizeof(u32);
case WMFW_HALO_XM_PACKED:
case WMFW_HALO_YM_PACKED:
return 3 * sizeof(u32);
default:
break;
}
break;
default:
KUNIT_FAIL(priv->test, "Unexpected DSP type\n");
return 0;
}
KUNIT_FAIL(priv->test, "Unexpected mem type\n");
return 0;
}
EXPORT_SYMBOL_NS_GPL(cs_dsp_mock_reg_block_length_bytes, "FW_CS_DSP_KUNIT_TEST_UTILS");
/**
* cs_dsp_mock_reg_block_length_registers() - Number of registers in an access block.
*
* @priv: Pointer to struct cs_dsp_test.
* @mem_type: Memory region type.
*
* Return: Total number of register forming the smallest bus access size.
* For unpacked memory this is the number of registers containing one
* DSP word. For packed memory this is the number of registers in one
* packed access block.
*/
unsigned int cs_dsp_mock_reg_block_length_registers(struct cs_dsp_test *priv, int mem_type)
{
return cs_dsp_mock_reg_block_length_bytes(priv, mem_type) /
regmap_get_val_bytes(priv->dsp->regmap);
}
EXPORT_SYMBOL_NS_GPL(cs_dsp_mock_reg_block_length_registers, "FW_CS_DSP_KUNIT_TEST_UTILS");
/**
* cs_dsp_mock_reg_block_length_dsp_words() - Number of dsp_words in an access block.
*
* @priv: Pointer to struct cs_dsp_test.
* @mem_type: Memory region type.
*
* Return: Total number of DSP words in a group of registers forming the
* smallest bus access size.
*/
unsigned int cs_dsp_mock_reg_block_length_dsp_words(struct cs_dsp_test *priv, int mem_type)
{
switch (priv->dsp->type) {
case WMFW_ADSP2:
switch (mem_type) {
case WMFW_ADSP2_PM:
return regmap_get_val_bytes(priv->dsp->regmap) / 2;
case WMFW_ADSP2_XM:
case WMFW_ADSP2_YM:
case WMFW_ADSP2_ZM:
return 1;
default:
break;
}
break;
case WMFW_HALO:
switch (mem_type) {
case WMFW_ADSP2_XM:
case WMFW_ADSP2_YM:
return 1;
case WMFW_HALO_PM_PACKED:
case WMFW_HALO_XM_PACKED:
case WMFW_HALO_YM_PACKED:
return 4;
default:
break;
}
Annotation
- Immediate include surface: `kunit/test.h`, `linux/firmware/cirrus/cs_dsp.h`, `linux/firmware/cirrus/cs_dsp_test_utils.h`, `linux/firmware/cirrus/wmfw.h`, `linux/math.h`.
- Detected declarations: `function cs_dsp_mock_count_regions`, `function cs_dsp_mock_size_of_region`, `function cs_dsp_mock_base_addr_for_mem`, `function cs_dsp_mock_reg_addr_inc_per_unpacked_word`, `function cs_dsp_mock_reg_block_length_bytes`, `function cs_dsp_mock_reg_block_length_registers`, `function cs_dsp_mock_reg_block_length_dsp_words`, `function cs_dsp_mock_has_zm`, `function cs_dsp_mock_packed_to_unpacked_mem_type`, `function cs_dsp_mock_num_dsp_words_to_num_packed_regs`.
- Atlas domain: Driver Families / drivers/firmware.
- 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.