xref: /linux-6.15/include/linux/amba/bus.h (revision 4e8cec26)
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 
24 struct clk;
25 
26 struct amba_device {
27 	struct device		dev;
28 	struct resource		res;
29 	struct clk		*pclk;
30 	u64			dma_mask;
31 	unsigned int		periphid;
32 	unsigned int		irq[AMBA_NR_IRQS];
33 };
34 
35 struct amba_id {
36 	unsigned int		id;
37 	unsigned int		mask;
38 	void			*data;
39 };
40 
41 struct amba_driver {
42 	struct device_driver	drv;
43 	int			(*probe)(struct amba_device *, struct amba_id *);
44 	int			(*remove)(struct amba_device *);
45 	void			(*shutdown)(struct amba_device *);
46 	int			(*suspend)(struct amba_device *, pm_message_t);
47 	int			(*resume)(struct amba_device *);
48 	struct amba_id		*id_table;
49 };
50 
51 enum amba_vendor {
52 	AMBA_VENDOR_ARM = 0x41,
53 	AMBA_VENDOR_ST = 0x80,
54 };
55 
56 #define amba_get_drvdata(d)	dev_get_drvdata(&d->dev)
57 #define amba_set_drvdata(d,p)	dev_set_drvdata(&d->dev, p)
58 
59 int amba_driver_register(struct amba_driver *);
60 void amba_driver_unregister(struct amba_driver *);
61 int amba_device_register(struct amba_device *, struct resource *);
62 void amba_device_unregister(struct amba_device *);
63 struct amba_device *amba_find_device(const char *, struct device *, unsigned int, unsigned int);
64 int amba_request_regions(struct amba_device *, const char *);
65 void amba_release_regions(struct amba_device *);
66 
67 #define amba_pclk_enable(d)	\
68 	(IS_ERR((d)->pclk) ? 0 : clk_enable((d)->pclk))
69 
70 #define amba_pclk_disable(d)	\
71 	do { if (!IS_ERR((d)->pclk)) clk_disable((d)->pclk); } while (0)
72 
73 #define amba_config(d)	(((d)->periphid >> 24) & 0xff)
74 #define amba_rev(d)	(((d)->periphid >> 20) & 0x0f)
75 #define amba_manf(d)	(((d)->periphid >> 12) & 0xff)
76 #define amba_part(d)	((d)->periphid & 0xfff)
77 
78 #endif
79