/* SPDX-License-Identifier: GPL-2.0 */ /* Copyright (C) 2022-2024 Linaro Ltd. */ #ifndef _REG_H_ #define _REG_H_ #include <linux/array_size.h> #include <linux/bits.h> #include <linux/bug.h> #include <linux/log2.h> #include <linux/types.h> /** * struct reg - A register descriptor * @offset: Register offset relative to base of register memory * @stride: Distance between two instances, if parameterized * @fcount: Number of entries in the @fmask array * @fmask: Array of mask values defining position and width of fields * @name: Upper-case name of the register */ struct reg { … }; /* Helper macro for defining "simple" (non-parameterized) registers */ #define REG(__NAME, __reg_id, __offset) … /* Helper macro for defining parameterized registers, specifying stride */ #define REG_STRIDE(__NAME, __reg_id, __offset, __stride) … #define REG_FIELDS(__NAME, __name, __offset) … #define REG_STRIDE_FIELDS(__NAME, __name, __offset, __stride) … /** * struct regs - Description of registers supported by hardware * @reg_count: Number of registers in the @reg[] array * @reg: Array of register descriptors */ struct regs { … }; static inline const struct reg *reg(const struct regs *regs, u32 reg_id) { … } /* Return the field mask for a field in a register, or 0 on error */ static inline u32 reg_fmask(const struct reg *reg, u32 field_id) { … } /* Return the mask for a single-bit field in a register, or 0 on error */ static inline u32 reg_bit(const struct reg *reg, u32 field_id) { … } /* Return the maximum value representable by the given field; always 2^n - 1 */ static inline u32 reg_field_max(const struct reg *reg, u32 field_id) { … } /* Encode a value into the given field of a register */ static inline u32 reg_encode(const struct reg *reg, u32 field_id, u32 val) { … } /* Given a register value, decode (extract) the value in the given field */ static inline u32 reg_decode(const struct reg *reg, u32 field_id, u32 val) { … } /* Returns 0 for NULL reg; warning should have already been issued */ static inline u32 reg_offset(const struct reg *reg) { … } /* Returns 0 for NULL reg; warning should have already been issued */ static inline u32 reg_n_offset(const struct reg *reg, u32 n) { … } #endif /* _REG_H_ */
Codebase Browser
linux