xref: /OK3568_Linux_fs/kernel/include/linux/mfd/kempld.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0-only */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * Kontron PLD driver definitions
4*4882a593Smuzhiyun  *
5*4882a593Smuzhiyun  * Copyright (c) 2010-2012 Kontron Europe GmbH
6*4882a593Smuzhiyun  * Author: Michael Brunner <michael.brunner@kontron.com>
7*4882a593Smuzhiyun  */
8*4882a593Smuzhiyun 
9*4882a593Smuzhiyun #ifndef _LINUX_MFD_KEMPLD_H_
10*4882a593Smuzhiyun #define _LINUX_MFD_KEMPLD_H_
11*4882a593Smuzhiyun 
12*4882a593Smuzhiyun /* kempld register definitions */
13*4882a593Smuzhiyun #define KEMPLD_IOINDEX			0xa80
14*4882a593Smuzhiyun #define KEMPLD_IODATA			0xa81
15*4882a593Smuzhiyun #define KEMPLD_MUTEX_KEY		0x80
16*4882a593Smuzhiyun #define KEMPLD_VERSION			0x00
17*4882a593Smuzhiyun #define KEMPLD_VERSION_LSB		0x00
18*4882a593Smuzhiyun #define KEMPLD_VERSION_MSB		0x01
19*4882a593Smuzhiyun #define KEMPLD_VERSION_GET_MINOR(x)	(x & 0x1f)
20*4882a593Smuzhiyun #define KEMPLD_VERSION_GET_MAJOR(x)	((x >> 5) & 0x1f)
21*4882a593Smuzhiyun #define KEMPLD_VERSION_GET_NUMBER(x)	((x >> 10) & 0xf)
22*4882a593Smuzhiyun #define KEMPLD_VERSION_GET_TYPE(x)	((x >> 14) & 0x3)
23*4882a593Smuzhiyun #define KEMPLD_BUILDNR			0x02
24*4882a593Smuzhiyun #define KEMPLD_BUILDNR_LSB		0x02
25*4882a593Smuzhiyun #define KEMPLD_BUILDNR_MSB		0x03
26*4882a593Smuzhiyun #define KEMPLD_FEATURE			0x04
27*4882a593Smuzhiyun #define KEMPLD_FEATURE_LSB		0x04
28*4882a593Smuzhiyun #define KEMPLD_FEATURE_MSB		0x05
29*4882a593Smuzhiyun #define KEMPLD_FEATURE_BIT_I2C		(1 << 0)
30*4882a593Smuzhiyun #define KEMPLD_FEATURE_BIT_WATCHDOG	(1 << 1)
31*4882a593Smuzhiyun #define KEMPLD_FEATURE_BIT_GPIO		(1 << 2)
32*4882a593Smuzhiyun #define KEMPLD_FEATURE_MASK_UART	(7 << 3)
33*4882a593Smuzhiyun #define KEMPLD_FEATURE_BIT_NMI		(1 << 8)
34*4882a593Smuzhiyun #define KEMPLD_FEATURE_BIT_SMI		(1 << 9)
35*4882a593Smuzhiyun #define KEMPLD_FEATURE_BIT_SCI		(1 << 10)
36*4882a593Smuzhiyun #define KEMPLD_SPEC			0x06
37*4882a593Smuzhiyun #define KEMPLD_SPEC_GET_MINOR(x)	(x & 0x0f)
38*4882a593Smuzhiyun #define KEMPLD_SPEC_GET_MAJOR(x)	((x >> 4) & 0x0f)
39*4882a593Smuzhiyun #define KEMPLD_IRQ_GPIO			0x35
40*4882a593Smuzhiyun #define KEMPLD_IRQ_I2C			0x36
41*4882a593Smuzhiyun #define KEMPLD_CFG			0x37
42*4882a593Smuzhiyun #define KEMPLD_CFG_GPIO_I2C_MUX		(1 << 0)
43*4882a593Smuzhiyun #define KEMPLD_CFG_BIOS_WP		(1 << 7)
44*4882a593Smuzhiyun 
45*4882a593Smuzhiyun #define KEMPLD_CLK			33333333
46*4882a593Smuzhiyun 
47*4882a593Smuzhiyun #define	KEMPLD_TYPE_RELEASE		0x0
48*4882a593Smuzhiyun #define	KEMPLD_TYPE_DEBUG		0x1
49*4882a593Smuzhiyun #define	KEMPLD_TYPE_CUSTOM		0x2
50*4882a593Smuzhiyun 
51*4882a593Smuzhiyun #define KEMPLD_VERSION_LEN		10
52*4882a593Smuzhiyun 
53*4882a593Smuzhiyun /**
54*4882a593Smuzhiyun  * struct kempld_info - PLD device information structure
55*4882a593Smuzhiyun  * @major:	PLD major revision
56*4882a593Smuzhiyun  * @minor:	PLD minor revision
57*4882a593Smuzhiyun  * @buildnr:	PLD build number
58*4882a593Smuzhiyun  * @number:	PLD board specific index
59*4882a593Smuzhiyun  * @type:	PLD type
60*4882a593Smuzhiyun  * @spec_major:	PLD FW specification major revision
61*4882a593Smuzhiyun  * @spec_minor:	PLD FW specification minor revision
62*4882a593Smuzhiyun  * @version:	PLD version string
63*4882a593Smuzhiyun  */
64*4882a593Smuzhiyun struct kempld_info {
65*4882a593Smuzhiyun 	unsigned int major;
66*4882a593Smuzhiyun 	unsigned int minor;
67*4882a593Smuzhiyun 	unsigned int buildnr;
68*4882a593Smuzhiyun 	unsigned int number;
69*4882a593Smuzhiyun 	unsigned int type;
70*4882a593Smuzhiyun 	unsigned int spec_major;
71*4882a593Smuzhiyun 	unsigned int spec_minor;
72*4882a593Smuzhiyun 	char version[KEMPLD_VERSION_LEN];
73*4882a593Smuzhiyun };
74*4882a593Smuzhiyun 
75*4882a593Smuzhiyun /**
76*4882a593Smuzhiyun  * struct kempld_device_data - Internal representation of the PLD device
77*4882a593Smuzhiyun  * @io_base:		Pointer to the IO memory
78*4882a593Smuzhiyun  * @io_index:		Pointer to the IO index register
79*4882a593Smuzhiyun  * @io_data:		Pointer to the IO data register
80*4882a593Smuzhiyun  * @pld_clock:		PLD clock frequency
81*4882a593Smuzhiyun  * @feature_mask:	PLD feature mask
82*4882a593Smuzhiyun  * @dev:		Pointer to kernel device structure
83*4882a593Smuzhiyun  * @info:		KEMPLD info structure
84*4882a593Smuzhiyun  * @lock:		PLD mutex
85*4882a593Smuzhiyun  */
86*4882a593Smuzhiyun struct kempld_device_data {
87*4882a593Smuzhiyun 	void __iomem		*io_base;
88*4882a593Smuzhiyun 	void __iomem		*io_index;
89*4882a593Smuzhiyun 	void __iomem		*io_data;
90*4882a593Smuzhiyun 	u32			pld_clock;
91*4882a593Smuzhiyun 	u32			feature_mask;
92*4882a593Smuzhiyun 	struct device		*dev;
93*4882a593Smuzhiyun 	struct kempld_info	info;
94*4882a593Smuzhiyun 	struct mutex		lock;
95*4882a593Smuzhiyun };
96*4882a593Smuzhiyun 
97*4882a593Smuzhiyun /**
98*4882a593Smuzhiyun  * struct kempld_platform_data - PLD hardware configuration structure
99*4882a593Smuzhiyun  * @pld_clock:			PLD clock frequency
100*4882a593Smuzhiyun  * @gpio_base			GPIO base pin number
101*4882a593Smuzhiyun  * @ioresource:			IO addresses of the PLD
102*4882a593Smuzhiyun  * @get_mutex:			PLD specific get_mutex callback
103*4882a593Smuzhiyun  * @release_mutex:		PLD specific release_mutex callback
104*4882a593Smuzhiyun  * @get_info:			PLD specific get_info callback
105*4882a593Smuzhiyun  * @register_cells:		PLD specific register_cells callback
106*4882a593Smuzhiyun  */
107*4882a593Smuzhiyun struct kempld_platform_data {
108*4882a593Smuzhiyun 	u32				pld_clock;
109*4882a593Smuzhiyun 	int				gpio_base;
110*4882a593Smuzhiyun 	struct resource			*ioresource;
111*4882a593Smuzhiyun 	void (*get_hardware_mutex)	(struct kempld_device_data *);
112*4882a593Smuzhiyun 	void (*release_hardware_mutex)	(struct kempld_device_data *);
113*4882a593Smuzhiyun 	int (*get_info)			(struct kempld_device_data *);
114*4882a593Smuzhiyun 	int (*register_cells)		(struct kempld_device_data *);
115*4882a593Smuzhiyun };
116*4882a593Smuzhiyun 
117*4882a593Smuzhiyun extern void kempld_get_mutex(struct kempld_device_data *pld);
118*4882a593Smuzhiyun extern void kempld_release_mutex(struct kempld_device_data *pld);
119*4882a593Smuzhiyun extern u8 kempld_read8(struct kempld_device_data *pld, u8 index);
120*4882a593Smuzhiyun extern void kempld_write8(struct kempld_device_data *pld, u8 index, u8 data);
121*4882a593Smuzhiyun extern u16 kempld_read16(struct kempld_device_data *pld, u8 index);
122*4882a593Smuzhiyun extern void kempld_write16(struct kempld_device_data *pld, u8 index, u16 data);
123*4882a593Smuzhiyun extern u32 kempld_read32(struct kempld_device_data *pld, u8 index);
124*4882a593Smuzhiyun extern void kempld_write32(struct kempld_device_data *pld, u8 index, u32 data);
125*4882a593Smuzhiyun 
126*4882a593Smuzhiyun #endif /* _LINUX_MFD_KEMPLD_H_ */
127