sound/firewire/oxfw/oxfw-hwdep.c
Source file repositories/reference/linux-study-clean/sound/firewire/oxfw/oxfw-hwdep.c
File Facts
- System
- Linux kernel
- Corpus path
sound/firewire/oxfw/oxfw-hwdep.c- Extension
.c- Size
- 3920 bytes
- Lines
- 171
- Domain
- Driver Families
- Bucket
- sound/firewire
- Inferred role
- Driver Families: implementation source
- Status
- source 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.
- Touches user memory; correctness depends on fault-safe copying and privilege boundary handling.
- Uses kernel synchronization; read lock ordering, sleepability, and interrupt context assumptions before translating.
- Defines or uses C structs; map object ownership, embedded links, reference counts, and lock ownership.
Dependency Surface
oxfw.h
Detected Declarations
function Copyrightfunction hwdep_pollfunction hwdep_get_infofunction hwdep_lockfunction hwdep_unlockfunction hwdep_releasefunction hwdep_ioctlfunction hwdep_compat_ioctlfunction snd_oxfw_create_hwdep
Annotated Snippet
// SPDX-License-Identifier: GPL-2.0-only
/*
* oxfw_hwdep.c - a part of driver for OXFW970/971 based devices
*
* Copyright (c) 2014 Takashi Sakamoto
*/
/*
* This codes give three functionality.
*
* 1.get firewire node information
* 2.get notification about starting/stopping stream
* 3.lock/unlock stream
*/
#include "oxfw.h"
static long hwdep_read(struct snd_hwdep *hwdep, char __user *buf, long count,
loff_t *offset)
{
struct snd_oxfw *oxfw = hwdep->private_data;
DEFINE_WAIT(wait);
union snd_firewire_event event;
spin_lock_irq(&oxfw->lock);
while (!oxfw->dev_lock_changed) {
prepare_to_wait(&oxfw->hwdep_wait, &wait, TASK_INTERRUPTIBLE);
spin_unlock_irq(&oxfw->lock);
schedule();
finish_wait(&oxfw->hwdep_wait, &wait);
if (signal_pending(current))
return -ERESTARTSYS;
spin_lock_irq(&oxfw->lock);
}
memset(&event, 0, sizeof(event));
event.lock_status.type = SNDRV_FIREWIRE_EVENT_LOCK_STATUS;
event.lock_status.status = (oxfw->dev_lock_count > 0);
oxfw->dev_lock_changed = false;
count = min_t(long, count, sizeof(event.lock_status));
spin_unlock_irq(&oxfw->lock);
if (copy_to_user(buf, &event, count))
return -EFAULT;
return count;
}
static __poll_t hwdep_poll(struct snd_hwdep *hwdep, struct file *file,
poll_table *wait)
{
struct snd_oxfw *oxfw = hwdep->private_data;
poll_wait(file, &oxfw->hwdep_wait, wait);
guard(spinlock_irq)(&oxfw->lock);
if (oxfw->dev_lock_changed)
return EPOLLIN | EPOLLRDNORM;
else
return 0;
}
static int hwdep_get_info(struct snd_oxfw *oxfw, void __user *arg)
{
struct fw_device *dev = fw_parent_device(oxfw->unit);
struct snd_firewire_get_info info;
memset(&info, 0, sizeof(info));
info.type = SNDRV_FIREWIRE_TYPE_OXFW;
info.card = dev->card->index;
*(__be32 *)&info.guid[0] = cpu_to_be32(dev->config_rom[3]);
*(__be32 *)&info.guid[4] = cpu_to_be32(dev->config_rom[4]);
strscpy(info.device_name, dev_name(&dev->device),
sizeof(info.device_name));
if (copy_to_user(arg, &info, sizeof(info)))
return -EFAULT;
return 0;
}
static int hwdep_lock(struct snd_oxfw *oxfw)
{
guard(spinlock_irq)(&oxfw->lock);
if (oxfw->dev_lock_count == 0) {
oxfw->dev_lock_count = -1;
Annotation
- Immediate include surface: `oxfw.h`.
- Detected declarations: `function Copyright`, `function hwdep_poll`, `function hwdep_get_info`, `function hwdep_lock`, `function hwdep_unlock`, `function hwdep_release`, `function hwdep_ioctl`, `function hwdep_compat_ioctl`, `function snd_oxfw_create_hwdep`.
- Atlas domain: Driver Families / sound/firewire.
- Implementation status: source implementation candidate.
- This snippet crosses the user/kernel memory boundary; validate fault handling and access checks before translating the pattern.
- Synchronization appears in or near this file; preserve lock ordering, sleepability, and interrupt-context constraints.
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.