include/linux/gpio/legacy.h
Source file repositories/reference/linux-study-clean/include/linux/gpio/legacy.h
File Facts
- System
- Linux kernel
- Corpus path
include/linux/gpio/legacy.h- Extension
.h- Size
- 3996 bytes
- Lines
- 174
- Domain
- Core OS
- Bucket
- Core Kernel Interface
- Inferred role
- Core OS: implementation source
- Status
- source implementation candidate
Why This File Exists
Core operating-system implementation surface: boot, tasks, memory, VFS, syscall-facing interfaces, synchronization, credentials, and isolation.
- Core operating-system implementation surface: boot, tasks, memory, VFS, syscall-facing interfaces, synchronization, credentials, and isolation.
- Defines or uses C structs; map object ownership, embedded links, reference counts, and lock ownership.
Dependency Surface
linux/types.hlinux/gpio/consumer.hlinux/kernel.hasm/bug.hasm/errno.h
Detected Declarations
struct devicefunction gpio_requestfunction gpio_direction_inputfunction gpio_direction_outputfunction gpio_get_value_cansleepfunction gpio_set_value_cansleepfunction gpio_get_valuefunction gpio_set_valuefunction gpio_to_irqfunction gpio_is_validfunction gpio_requestfunction gpio_request_onefunction gpio_freefunction gpio_direction_inputfunction gpio_direction_outputfunction gpio_get_valuefunction gpio_set_valuefunction gpio_get_value_cansleepfunction gpio_set_value_cansleepfunction gpio_to_irqfunction devm_gpio_request_one
Annotated Snippet
#ifndef __LINUX_GPIO_LEGACY_H
#define __LINUX_GPIO_LEGACY_H
#include <linux/types.h>
#ifdef CONFIG_GPIOLIB_LEGACY
struct device;
/* make these flag values available regardless of GPIO kconfig options */
#define GPIOF_IN ((1 << 0))
#define GPIOF_OUT_INIT_LOW ((0 << 0) | (0 << 1))
#define GPIOF_OUT_INIT_HIGH ((0 << 0) | (1 << 1))
#ifdef CONFIG_GPIOLIB
#include <linux/gpio/consumer.h>
/*
* "valid" GPIO numbers are nonnegative and may be passed to
* setup routines like gpio_request(). Only some valid numbers
* can successfully be requested and used.
*
* Invalid GPIO numbers are useful for indicating no-such-GPIO in
* platform data and other tables.
*/
static inline bool gpio_is_valid(int number)
{
/* only non-negative numbers are valid */
return number >= 0;
}
/*
* Platforms may implement their GPIO interface with library code,
* at a small performance cost for non-inlined operations and some
* extra memory (for code and for per-GPIO table entries).
*/
/* Always use the library code for GPIO management calls,
* or when sleeping may be involved.
*/
int gpio_request(unsigned gpio, const char *label);
void gpio_free(unsigned gpio);
static inline int gpio_direction_input(unsigned gpio)
{
return gpiod_direction_input(gpio_to_desc(gpio));
}
static inline int gpio_direction_output(unsigned gpio, int value)
{
return gpiod_direction_output_raw(gpio_to_desc(gpio), value);
}
static inline int gpio_get_value_cansleep(unsigned gpio)
{
return gpiod_get_raw_value_cansleep(gpio_to_desc(gpio));
}
static inline void gpio_set_value_cansleep(unsigned gpio, int value)
{
gpiod_set_raw_value_cansleep(gpio_to_desc(gpio), value);
}
static inline int gpio_get_value(unsigned gpio)
{
return gpiod_get_raw_value(gpio_to_desc(gpio));
}
static inline void gpio_set_value(unsigned gpio, int value)
{
gpiod_set_raw_value(gpio_to_desc(gpio), value);
}
static inline int gpio_to_irq(unsigned gpio)
{
return gpiod_to_irq(gpio_to_desc(gpio));
}
int gpio_request_one(unsigned gpio, unsigned long flags, const char *label);
int devm_gpio_request_one(struct device *dev, unsigned gpio,
unsigned long flags, const char *label);
#else /* ! CONFIG_GPIOLIB */
#include <linux/kernel.h>
#include <asm/bug.h>
#include <asm/errno.h>
static inline bool gpio_is_valid(int number)
{
Annotation
- Immediate include surface: `linux/types.h`, `linux/gpio/consumer.h`, `linux/kernel.h`, `asm/bug.h`, `asm/errno.h`.
- Detected declarations: `struct device`, `function gpio_request`, `function gpio_direction_input`, `function gpio_direction_output`, `function gpio_get_value_cansleep`, `function gpio_set_value_cansleep`, `function gpio_get_value`, `function gpio_set_value`, `function gpio_to_irq`, `function gpio_is_valid`.
- Atlas domain: Core OS / Core Kernel Interface.
- Implementation status: source 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.