cregit-Linux how code gets into the kernel

Release 4.16 include/linux/ioport.h

Directory: include/linux
/* SPDX-License-Identifier: GPL-2.0 */
/*
 * ioport.h     Definitions of routines for detecting, reserving and
 *              allocating system resources.
 *
 * Authors:     Linus Torvalds
 */

#ifndef _LINUX_IOPORT_H

#define _LINUX_IOPORT_H

#ifndef __ASSEMBLY__
#include <linux/compiler.h>
#include <linux/types.h>
/*
 * Resources are tree-like, allowing
 * nesting etc..
 */

struct resource {
	
resource_size_t start;
	
resource_size_t end;
	
const char *name;
	
unsigned long flags;
	
unsigned long desc;
	


struct resource *parent, *sibling, *child;
};

/*
 * IO resources have these defined flags.
 *
 * PCI devices expose these flags to userspace in the "resource" sysfs file,
 * so don't move them.
 */

#define IORESOURCE_BITS		0x000000ff	
/* Bus-specific bits */


#define IORESOURCE_TYPE_BITS	0x00001f00	
/* Resource type */

#define IORESOURCE_IO		0x00000100	
/* PCI/ISA I/O ports */

#define IORESOURCE_MEM		0x00000200

#define IORESOURCE_REG		0x00000300	
/* Register offsets */

#define IORESOURCE_IRQ		0x00000400

#define IORESOURCE_DMA		0x00000800

#define IORESOURCE_BUS		0x00001000


#define IORESOURCE_PREFETCH	0x00002000	
/* No side effects */

#define IORESOURCE_READONLY	0x00004000

#define IORESOURCE_CACHEABLE	0x00008000

#define IORESOURCE_RANGELENGTH	0x00010000

#define IORESOURCE_SHADOWABLE	0x00020000


#define IORESOURCE_SIZEALIGN	0x00040000	
/* size indicates alignment */

#define IORESOURCE_STARTALIGN	0x00080000	
/* start field is alignment */


#define IORESOURCE_MEM_64	0x00100000

#define IORESOURCE_WINDOW	0x00200000	
/* forwarded by bridge */

#define IORESOURCE_MUXED	0x00400000	
/* Resource is software muxed */


#define IORESOURCE_EXT_TYPE_BITS 0x01000000	
/* Resource extended types */

#define IORESOURCE_SYSRAM	0x01000000	
/* System RAM (modifier) */


#define IORESOURCE_EXCLUSIVE	0x08000000	
/* Userland may not map this resource */


#define IORESOURCE_DISABLED	0x10000000

#define IORESOURCE_UNSET	0x20000000	
/* No address assigned yet */

#define IORESOURCE_AUTO		0x40000000

#define IORESOURCE_BUSY		0x80000000	
/* Driver has marked this resource busy */

/* I/O resource extended types */

#define IORESOURCE_SYSTEM_RAM		(IORESOURCE_MEM|IORESOURCE_SYSRAM)

/* PnP IRQ specific bits (IORESOURCE_BITS) */

#define IORESOURCE_IRQ_HIGHEDGE		(1<<0)

#define IORESOURCE_IRQ_LOWEDGE		(1<<1)

#define IORESOURCE_IRQ_HIGHLEVEL	(1<<2)

#define IORESOURCE_IRQ_LOWLEVEL		(1<<3)

#define IORESOURCE_IRQ_SHAREABLE	(1<<4)

#define IORESOURCE_IRQ_OPTIONAL 	(1<<5)

/* PnP DMA specific bits (IORESOURCE_BITS) */

#define IORESOURCE_DMA_TYPE_MASK	(3<<0)

#define IORESOURCE_DMA_8BIT		(0<<0)

#define IORESOURCE_DMA_8AND16BIT	(1<<0)

#define IORESOURCE_DMA_16BIT		(2<<0)


#define IORESOURCE_DMA_MASTER		(1<<2)

#define IORESOURCE_DMA_BYTE		(1<<3)

#define IORESOURCE_DMA_WORD		(1<<4)


#define IORESOURCE_DMA_SPEED_MASK	(3<<6)

#define IORESOURCE_DMA_COMPATIBLE	(0<<6)

#define IORESOURCE_DMA_TYPEA		(1<<6)

#define IORESOURCE_DMA_TYPEB		(2<<6)

#define IORESOURCE_DMA_TYPEF		(3<<6)

/* PnP memory I/O specific bits (IORESOURCE_BITS) */

#define IORESOURCE_MEM_WRITEABLE	(1<<0)	
/* dup: IORESOURCE_READONLY */

#define IORESOURCE_MEM_CACHEABLE	(1<<1)	
/* dup: IORESOURCE_CACHEABLE */

#define IORESOURCE_MEM_RANGELENGTH	(1<<2)	
/* dup: IORESOURCE_RANGELENGTH */

#define IORESOURCE_MEM_TYPE_MASK	(3<<3)

#define IORESOURCE_MEM_8BIT		(0<<3)

#define IORESOURCE_MEM_16BIT		(1<<3)

#define IORESOURCE_MEM_8AND16BIT	(2<<3)

#define IORESOURCE_MEM_32BIT		(3<<3)

#define IORESOURCE_MEM_SHADOWABLE	(1<<5)	
/* dup: IORESOURCE_SHADOWABLE */

#define IORESOURCE_MEM_EXPANSIONROM	(1<<6)

/* PnP I/O specific bits (IORESOURCE_BITS) */

#define IORESOURCE_IO_16BIT_ADDR	(1<<0)

#define IORESOURCE_IO_FIXED		(1<<1)

#define IORESOURCE_IO_SPARSE		(1<<2)

/* PCI ROM control bits (IORESOURCE_BITS) */

#define IORESOURCE_ROM_ENABLE		(1<<0)	
/* ROM is enabled, same as PCI_ROM_ADDRESS_ENABLE */

#define IORESOURCE_ROM_SHADOW		(1<<1)	
/* Use RAM image, not ROM BAR */

/* PCI control bits.  Shares IORESOURCE_BITS with above PCI ROM.  */

#define IORESOURCE_PCI_FIXED		(1<<4)	
/* Do not move resource */

#define IORESOURCE_PCI_EA_BEI		(1<<5)	
/* BAR Equivalent Indicator */

/*
 * I/O Resource Descriptors
 *
 * Descriptors are used by walk_iomem_res_desc() and region_intersects()
 * for searching a specific resource range in the iomem table.  Assign
 * a new descriptor when a resource range supports the search interfaces.
 * Otherwise, resource.desc must be set to IORES_DESC_NONE (0).
 */

enum {
	
IORES_DESC_NONE				= 0,
	
IORES_DESC_CRASH_KERNEL			= 1,
	
IORES_DESC_ACPI_TABLES			= 2,
	
IORES_DESC_ACPI_NV_STORAGE		= 3,
	
IORES_DESC_PERSISTENT_MEMORY		= 4,
	
IORES_DESC_PERSISTENT_MEMORY_LEGACY	= 5,
	
IORES_DESC_DEVICE_PRIVATE_MEMORY	= 6,
	
IORES_DESC_DEVICE_PUBLIC_MEMORY		= 7,
};

/* helpers to define resources */

#define DEFINE_RES_NAMED(_start, _size, _name, _flags)			\
	{                                                               \
                .start = (_start),                                      \
                .end = (_start) + (_size) - 1,                          \
                .name = (_name),                                        \
                .flags = (_flags),                                      \
                .desc = IORES_DESC_NONE,                                \
        }


#define DEFINE_RES_IO_NAMED(_start, _size, _name)			\
	DEFINE_RES_NAMED((_start), (_size), (_name), IORESOURCE_IO)

#define DEFINE_RES_IO(_start, _size)					\
	DEFINE_RES_IO_NAMED((_start), (_size), NULL)


#define DEFINE_RES_MEM_NAMED(_start, _size, _name)			\
	DEFINE_RES_NAMED((_start), (_size), (_name), IORESOURCE_MEM)

#define DEFINE_RES_MEM(_start, _size)					\
	DEFINE_RES_MEM_NAMED((_start), (_size), NULL)


#define DEFINE_RES_IRQ_NAMED(_irq, _name)				\
	DEFINE_RES_NAMED((_irq), 1, (_name), IORESOURCE_IRQ)

#define DEFINE_RES_IRQ(_irq)						\
	DEFINE_RES_IRQ_NAMED((_irq), NULL)


#define DEFINE_RES_DMA_NAMED(_dma, _name)				\
	DEFINE_RES_NAMED((_dma), 1, (_name), IORESOURCE_DMA)

#define DEFINE_RES_DMA(_dma)						\
	DEFINE_RES_DMA_NAMED((_dma), NULL)

/* PC/ISA/whatever - the normal PC address spaces: IO and memory */
extern struct resource ioport_resource;
extern struct resource iomem_resource;

extern struct resource *request_resource_conflict(struct resource *root, struct resource *new);
extern int request_resource(struct resource *root, struct resource *new);
extern int release_resource(struct resource *new);
void release_child_resources(struct resource *new);
extern void reserve_region_with_split(struct resource *root,
			     resource_size_t start, resource_size_t end,
			     const char *name);
extern struct resource *insert_resource_conflict(struct resource *parent, struct resource *new);
extern int insert_resource(struct resource *parent, struct resource *new);
extern void insert_resource_expand_to_fit(struct resource *root, struct resource *new);
extern int remove_resource(struct resource *old);
extern void arch_remove_reservations(struct resource *avail);
extern int allocate_resource(struct resource *root, struct resource *new,
			     resource_size_t size, resource_size_t min,
			     resource_size_t max, resource_size_t align,
			     resource_size_t (*alignf)(void *,
						       const struct resource *,
						       resource_size_t,
						       resource_size_t),
			     void *alignf_data);
struct resource *lookup_resource(struct resource *root, resource_size_t start);
int adjust_resource(struct resource *res, resource_size_t start,
		    resource_size_t size);
resource_size_t resource_alignment(struct resource *res);

static inline resource_size_t resource_size(const struct resource *res) { return res->end - res->start + 1; }

Contributors

PersonTokensPropCommitsCommitProp
Magnus Damm2395.83%150.00%
Jean Delvare14.17%150.00%
Total24100.00%2100.00%


static inline unsigned long resource_type(const struct resource *res) { return res->flags & IORESOURCE_TYPE_BITS; }

Contributors

PersonTokensPropCommitsCommitProp
Magnus Damm2095.24%150.00%
Jean Delvare14.76%150.00%
Total21100.00%2100.00%


static inline unsigned long resource_ext_type(const struct resource *res) { return res->flags & IORESOURCE_EXT_TYPE_BITS; }

Contributors

PersonTokensPropCommitsCommitProp
Toshi Kani21100.00%1100.00%
Total21100.00%1100.00%

/* True iff r1 completely contains r2 */
static inline bool resource_contains(struct resource *r1, struct resource *r2) { if (resource_type(r1) != resource_type(r2)) return false; if (r1->flags & IORESOURCE_UNSET || r2->flags & IORESOURCE_UNSET) return false; return r1->start <= r2->start && r1->end >= r2->end; }

Contributors

PersonTokensPropCommitsCommitProp
Björn Helgaas66100.00%1100.00%
Total66100.00%1100.00%

/* Convenience shorthand with allocation */ #define request_region(start,n,name) __request_region(&ioport_resource, (start), (n), (name), 0) #define request_muxed_region(start,n,name) __request_region(&ioport_resource, (start), (n), (name), IORESOURCE_MUXED) #define __request_mem_region(start,n,name, excl) __request_region(&iomem_resource, (start), (n), (name), excl) #define request_mem_region(start,n,name) __request_region(&iomem_resource, (start), (n), (name), 0) #define request_mem_region_exclusive(start,n,name) \ __request_region(&iomem_resource, (start), (n), (name), IORESOURCE_EXCLUSIVE) #define rename_region(region, newname) do { (region)->name = (newname); } while (0) extern struct resource * __request_region(struct resource *, resource_size_t start, resource_size_t n, const char *name, int flags); /* Compatibility cruft */ #define release_region(start,n) __release_region(&ioport_resource, (start), (n)) #define release_mem_region(start,n) __release_region(&iomem_resource, (start), (n)) extern void __release_region(struct resource *, resource_size_t, resource_size_t); #ifdef CONFIG_MEMORY_HOTREMOVE extern int release_mem_region_adjustable(struct resource *, resource_size_t, resource_size_t); #endif /* Wrappers for managed devices */ struct device; extern int devm_request_resource(struct device *dev, struct resource *root, struct resource *new); extern void devm_release_resource(struct device *dev, struct resource *new); #define devm_request_region(dev,start,n,name) \ __devm_request_region(dev, &ioport_resource, (start), (n), (name)) #define devm_request_mem_region(dev,start,n,name) \ __devm_request_region(dev, &iomem_resource, (start), (n), (name)) extern struct resource * __devm_request_region(struct device *dev, struct resource *parent, resource_size_t start, resource_size_t n, const char *name); #define devm_release_region(dev, start, n) \ __devm_release_region(dev, &ioport_resource, (start), (n)) #define devm_release_mem_region(dev, start, n) \ __devm_release_region(dev, &iomem_resource, (start), (n)) extern void __devm_release_region(struct device *dev, struct resource *parent, resource_size_t start, resource_size_t n); extern int iomem_map_sanity_check(resource_size_t addr, unsigned long size); extern bool iomem_is_exclusive(u64 addr); extern int walk_system_ram_range(unsigned long start_pfn, unsigned long nr_pages, void *arg, int (*func)(unsigned long, unsigned long, void *)); extern int walk_mem_res(u64 start, u64 end, void *arg, int (*func)(struct resource *, void *)); extern int walk_system_ram_res(u64 start, u64 end, void *arg, int (*func)(struct resource *, void *)); extern int walk_iomem_res_desc(unsigned long desc, unsigned long flags, u64 start, u64 end, void *arg, int (*func)(struct resource *, void *)); /* True if any part of r1 overlaps r2 */
static inline bool resource_overlaps(struct resource *r1, struct resource *r2) { return (r1->start <= r2->end && r1->end >= r2->start); }

Contributors

PersonTokensPropCommitsCommitProp
Wei Yang36100.00%1100.00%
Total36100.00%1100.00%

#endif /* __ASSEMBLY__ */ #endif /* _LINUX_IOPORT_H */

Overall Contributors

PersonTokensPropCommitsCommitProp
Linus Torvalds (pre-git)33926.02%1519.74%
Björn Helgaas15011.51%1215.79%
Toshi Kani1199.13%56.58%
Tejun Heo1017.75%11.32%
Uwe Kleine-König947.21%11.32%
Magnus Damm483.68%22.63%
Arjan van de Ven413.15%11.32%
Vivek Goyal382.92%11.32%
Wei Yang372.84%11.32%
Thierry Reding352.69%11.32%
Tom Lendacky352.69%22.63%
Yinghai Lu342.61%33.95%
Kamezawa Hiroyuki332.53%11.32%
Linus Torvalds241.84%22.63%
Greg Kroah-Hartman221.69%33.95%
Alan Cox161.23%11.32%
Ivan Kokshaysky161.23%22.63%
Benjamin Herrenschmidt151.15%11.32%
Geert Uytterhoeven141.07%11.32%
Matthew Wilcox131.00%11.32%
Suresh B. Siddha120.92%11.32%
Jon Smirl100.77%11.32%
Jérôme Glisse80.61%22.63%
Adam Belay80.61%22.63%
Mark Brown60.46%22.63%
Alex Williamson60.46%11.32%
Bernhard Walle60.46%11.32%
Ralf Bächle60.46%11.32%
Jiang Liu40.31%11.32%
Hiroshi Doyu40.31%11.32%
William Stinson30.23%11.32%
Dominik Brodowski20.15%22.63%
Jean Delvare20.15%11.32%
Randy Dunlap10.08%11.32%
Yaowei Bai10.08%11.32%
Total1303100.00%76100.00%
Directory: include/linux
Information contained on this website is for historical information purposes only and does not indicate or represent copyright ownership.
Created with cregit.