xref: /linux-6.15/include/linux/amba/bus.h (revision 71ccc212)
1 /*
2  *  linux/include/amba/bus.h
3  *
4  *  This device type deals with ARM PrimeCells and anything else that
5  *  presents a proper CID (0xB105F00D) at the end of the I/O register
6  *  region or that is derived from a PrimeCell.
7  *
8  *  Copyright (C) 2003 Deep Blue Solutions Ltd, All Rights Reserved.
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License version 2 as
12  * published by the Free Software Foundation.
13  */
14 #ifndef ASMARM_AMBA_H
15 #define ASMARM_AMBA_H
16 
17 #include <linux/clk.h>
18 #include <linux/device.h>
19 #include <linux/err.h>
20 #include <linux/resource.h>
21 
22 #define AMBA_NR_IRQS	2
23 #define AMBA_CID	0xb105f00d
24 
25 struct clk;
26 
27 struct amba_device {
28 	struct device		dev;
29 	struct resource		res;
30 	struct clk		*pclk;
31 	u64			dma_mask;
32 	unsigned int		periphid;
33 	unsigned int		irq[AMBA_NR_IRQS];
34 };
35 
36 struct amba_id {
37 	unsigned int		id;
38 	unsigned int		mask;
39 	void			*data;
40 };
41 
42 struct amba_driver {
43 	struct device_driver	drv;
44 	int			(*probe)(struct amba_device *, struct amba_id *);
45 	int			(*remove)(struct amba_device *);
46 	void			(*shutdown)(struct amba_device *);
47 	int			(*suspend)(struct amba_device *, pm_message_t);
48 	int			(*resume)(struct amba_device *);
49 	struct amba_id		*id_table;
50 };
51 
52 enum amba_vendor {
53 	AMBA_VENDOR_ARM = 0x41,
54 	AMBA_VENDOR_ST = 0x80,
55 };
56 
57 #define amba_get_drvdata(d)	dev_get_drvdata(&d->dev)
58 #define amba_set_drvdata(d,p)	dev_set_drvdata(&d->dev, p)
59 
60 int amba_driver_register(struct amba_driver *);
61 void amba_driver_unregister(struct amba_driver *);
62 int amba_device_register(struct amba_device *, struct resource *);
63 void amba_device_unregister(struct amba_device *);
64 struct amba_device *amba_find_device(const char *, struct device *, unsigned int, unsigned int);
65 int amba_request_regions(struct amba_device *, const char *);
66 void amba_release_regions(struct amba_device *);
67 
68 #define amba_pclk_enable(d)	\
69 	(IS_ERR((d)->pclk) ? 0 : clk_enable((d)->pclk))
70 
71 #define amba_pclk_disable(d)	\
72 	do { if (!IS_ERR((d)->pclk)) clk_disable((d)->pclk); } while (0)
73 
74 /* Some drivers don't use the struct amba_device */
75 #define AMBA_CONFIG_BITS(a) (((a) >> 24) & 0xff)
76 #define AMBA_REV_BITS(a) (((a) >> 20) & 0x0f)
77 #define AMBA_MANF_BITS(a) (((a) >> 12) & 0xff)
78 #define AMBA_PART_BITS(a) ((a) & 0xfff)
79 
80 #define amba_config(d)	AMBA_CONFIG_BITS((d)->periphid)
81 #define amba_rev(d)	AMBA_REV_BITS((d)->periphid)
82 #define amba_manf(d)	AMBA_MANF_BITS((d)->periphid)
83 #define amba_part(d)	AMBA_PART_BITS((d)->periphid)
84 
85 #endif
86