/* SPDX-License-Identifier: GPL-2.0-only */ /* * linux/include/amba/bus.h * * This device type deals with ARM PrimeCells and anything else that * presents a proper CID (0xB105F00D) at the end of the I/O register * region or that is derived from a PrimeCell. * * Copyright (C) 2003 Deep Blue Solutions Ltd, All Rights Reserved. */ #ifndef ASMARM_AMBA_H #define ASMARM_AMBA_H #include <linux/clk.h> #include <linux/device.h> #include <linux/mod_devicetable.h> #include <linux/err.h> #include <linux/resource.h> #include <linux/regulator/consumer.h> #define AMBA_NR_IRQS … #define AMBA_CID … #define CORESIGHT_CID … /* * CoreSight Architecture specification updates the ID specification * for components on the AMBA bus. (ARM IHI 0029E) * * Bits 15:12 of the CID are the device class. * * Class 0xF remains for PrimeCell and legacy components. (AMBA_CID above) * Class 0x9 defines the component as CoreSight (CORESIGHT_CID above) * Class 0x0, 0x1, 0xB, 0xE define components that do not have driver support * at present. * Class 0x2-0x8,0xA and 0xD-0xD are presently reserved. * * Remaining CID bits stay as 0xb105-00d */ /** * Class 0x9 components use additional values to form a Unique Component * Identifier (UCI), where peripheral ID values are identical for different * components. Passed to the amba bus code from the component driver via * the amba_id->data pointer. * @devarch : coresight devarch register value * @devarch_mask: mask bits used for matching. 0 indicates UCI not used. * @devtype : coresight device type value * @data : additional driver data. As we have usurped the original * pointer some devices may still need additional data */ struct amba_cs_uci_id { … }; /* define offsets for registers used by UCI */ #define UCI_REG_DEVTYPE_OFFSET … #define UCI_REG_DEVARCH_OFFSET … struct clk; struct amba_device { … }; struct amba_driver { … }; /* * Constants for the designer field of the Peripheral ID register. When bit 7 * is set to '1', bits [6:0] should be the JEP106 manufacturer identity code. */ enum amba_vendor { … }; extern const struct bus_type amba_bustype; #define to_amba_device(d) … #define amba_get_drvdata(d) … #define amba_set_drvdata(d,p) … /* * use a macro to avoid include chaining to get THIS_MODULE */ #define amba_driver_register(drv) … #ifdef CONFIG_ARM_AMBA int __amba_driver_register(struct amba_driver *, struct module *); void amba_driver_unregister(struct amba_driver *); #else static inline int __amba_driver_register(struct amba_driver *drv, struct module *owner) { … } static inline void amba_driver_unregister(struct amba_driver *drv) { … } #endif struct amba_device *amba_device_alloc(const char *, resource_size_t, size_t); void amba_device_put(struct amba_device *); int amba_device_add(struct amba_device *, struct resource *); int amba_device_register(struct amba_device *, struct resource *); void amba_device_unregister(struct amba_device *); int amba_request_regions(struct amba_device *, const char *); void amba_release_regions(struct amba_device *); /* Some drivers don't use the struct amba_device */ #define AMBA_CONFIG_BITS(a) … #define AMBA_REV_BITS(a) … #define AMBA_MANF_BITS(a) … #define AMBA_PART_BITS(a) … #define amba_config(d) … #define amba_rev(d) … #define amba_manf(d) … #define amba_part(d) … #define __AMBA_DEV(busid, data, mask) … /* * APB devices do not themselves have the ability to address memory, * so DMA masks should be zero (much like USB peripheral devices.) * The DMA controller DMA masks should be used instead (much like * USB host controllers in conventional PCs.) */ #define AMBA_APB_DEVICE(name, busid, id, base, irqs, data) … /* * AHB devices are DMA capable, so set their DMA masks */ #define AMBA_AHB_DEVICE(name, busid, id, base, irqs, data) … /* * module_amba_driver() - Helper macro for drivers that don't do anything * special in module init/exit. This eliminates a lot of boilerplate. Each * module may only use this macro once, and calling it replaces module_init() * and module_exit() */ #define module_amba_driver(__amba_drv) … /* * builtin_amba_driver() - Helper macro for drivers that don't do anything * special in driver initcall. This eliminates a lot of boilerplate. Each * driver may only use this macro once, and calling it replaces the instance * device_initcall(). */ #define builtin_amba_driver(__amba_drv) … #endif