include/asm-generic/mmiowb.h
Source file repositories/reference/linux-study-clean/include/asm-generic/mmiowb.h
File Facts
- System
- Linux kernel
- Corpus path
include/asm-generic/mmiowb.h- Extension
.h- Size
- 1764 bytes
- Lines
- 66
- Domain
- Repository Root And Misc
- Bucket
- include
- Inferred role
- Repository Root And Misc: implementation source
- Status
- source implementation candidate
Why This File Exists
Top-level or miscellaneous repository surface. Use this as map coverage unless a later manual pass promotes the file into a deeper subsystem dossier.
- Top-level or miscellaneous repository surface. Use this as map coverage unless a later manual pass promotes the file into a deeper subsystem dossier.
- 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
linux/compiler.hasm-generic/mmiowb_types.hasm/percpu.hasm/smp.h
Detected Declarations
function mmiowb_set_pendingfunction mmiowb_spin_lockfunction mmiowb_spin_unlock
Annotated Snippet
#ifndef __ASM_GENERIC_MMIOWB_H
#define __ASM_GENERIC_MMIOWB_H
/*
* Generic implementation of mmiowb() tracking for spinlocks.
*
* If your architecture doesn't ensure that writes to an I/O peripheral
* within two spinlocked sections on two different CPUs are seen by the
* peripheral in the order corresponding to the lock handover, then you
* need to follow these FIVE easy steps:
*
* 1. Implement mmiowb() (and arch_mmiowb_state() if you're fancy)
* in asm/mmiowb.h, then #include this file
* 2. Ensure your I/O write accessors call mmiowb_set_pending()
* 3. Select ARCH_HAS_MMIOWB
* 4. Untangle the resulting mess of header files
* 5. Complain to your architects
*/
#ifdef CONFIG_MMIOWB
#include <linux/compiler.h>
#include <asm-generic/mmiowb_types.h>
#ifndef arch_mmiowb_state
#include <asm/percpu.h>
#include <asm/smp.h>
DECLARE_PER_CPU(struct mmiowb_state, __mmiowb_state);
#define __mmiowb_state() raw_cpu_ptr(&__mmiowb_state)
#else
#define __mmiowb_state() arch_mmiowb_state()
#endif /* arch_mmiowb_state */
static inline void mmiowb_set_pending(void)
{
struct mmiowb_state *ms = __mmiowb_state();
if (likely(ms->nesting_count))
ms->mmiowb_pending = ms->nesting_count;
}
static inline void mmiowb_spin_lock(void)
{
struct mmiowb_state *ms = __mmiowb_state();
ms->nesting_count++;
}
static inline void mmiowb_spin_unlock(void)
{
struct mmiowb_state *ms = __mmiowb_state();
if (unlikely(ms->mmiowb_pending)) {
ms->mmiowb_pending = 0;
mmiowb();
}
ms->nesting_count--;
}
#else
#define mmiowb_set_pending() do { } while (0)
#define mmiowb_spin_lock() do { } while (0)
#define mmiowb_spin_unlock() do { } while (0)
#endif /* CONFIG_MMIOWB */
#endif /* __ASM_GENERIC_MMIOWB_H */
Annotation
- Immediate include surface: `linux/compiler.h`, `asm-generic/mmiowb_types.h`, `asm/percpu.h`, `asm/smp.h`.
- Detected declarations: `function mmiowb_set_pending`, `function mmiowb_spin_lock`, `function mmiowb_spin_unlock`.
- Atlas domain: Repository Root And Misc / include.
- Implementation status: source implementation candidate.
- 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.