[mirror_ubuntu-focal-kernel.git] / include / pcmcia / ss.h

/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * ss.h
 *
 * The initial developer of the original code is David A. Hinds
 * <dahinds@users.sourceforge.net>.  Portions created by David A. Hinds
 * are Copyright (C) 1999 David A. Hinds.  All Rights Reserved.
 *
 * (C) 1999             David A. Hinds
 */

#ifndef _LINUX_SS_H
#define _LINUX_SS_H

#include <linux/device.h>
#include <linux/sched.h>	/* task_struct, completion */
#include <linux/mutex.h>

#ifdef CONFIG_CARDBUS
#include <linux/pci.h>
#endif

/* Definitions for card status flags for GetStatus */
#define SS_WRPROT	0x0001
#define SS_CARDLOCK	0x0002
#define SS_EJECTION	0x0004
#define SS_INSERTION	0x0008
#define SS_BATDEAD	0x0010
#define SS_BATWARN	0x0020
#define SS_READY	0x0040
#define SS_DETECT	0x0080
#define SS_POWERON	0x0100
#define SS_GPI		0x0200
#define SS_STSCHG	0x0400
#define SS_CARDBUS	0x0800
#define SS_3VCARD	0x1000
#define SS_XVCARD	0x2000
#define SS_PENDING	0x4000
#define SS_ZVCARD	0x8000

/* InquireSocket capabilities */
#define SS_CAP_PAGE_REGS	0x0001
#define SS_CAP_VIRTUAL_BUS	0x0002
#define SS_CAP_MEM_ALIGN	0x0004
#define SS_CAP_STATIC_MAP	0x0008
#define SS_CAP_PCCARD		0x4000
#define SS_CAP_CARDBUS		0x8000

/* for GetSocket, SetSocket */
typedef struct socket_state_t {
	u_int	flags;
	u_int	csc_mask;
	u_char	Vcc, Vpp;
	u_char	io_irq;
} socket_state_t;

extern socket_state_t dead_socket;

/* Socket configuration flags */
#define SS_PWR_AUTO	0x0010
#define SS_IOCARD	0x0020
#define SS_RESET	0x0040
#define SS_DMA_MODE	0x0080
#define SS_SPKR_ENA	0x0100
#define SS_OUTPUT_ENA	0x0200

/* Flags for I/O port and memory windows */
#define MAP_ACTIVE	0x01
#define MAP_16BIT	0x02
#define MAP_AUTOSZ	0x04
#define MAP_0WS		0x08
#define MAP_WRPROT	0x10
#define MAP_ATTRIB	0x20
#define MAP_USE_WAIT	0x40
#define MAP_PREFETCH	0x80

/* Use this just for bridge windows */
#define MAP_IOSPACE	0x20

/* power hook operations */
#define HOOK_POWER_PRE	0x01
#define HOOK_POWER_POST	0x02

typedef struct pccard_io_map {
	u_char	map;
	u_char	flags;
	u_short	speed;
	phys_addr_t start, stop;
} pccard_io_map;

typedef struct pccard_mem_map {
	u_char		map;
	u_char		flags;
	u_short		speed;
	phys_addr_t	static_start;
	u_int		card_start;
	struct resource	*res;
} pccard_mem_map;

typedef struct io_window_t {
	u_int			InUse, Config;
	struct resource		*res;
} io_window_t;

/* Maximum number of IO windows per socket */
#define MAX_IO_WIN 2

/* Maximum number of memory windows per socket */
#define MAX_WIN 4


/*
 * Socket operations.
 */
struct pcmcia_socket;
struct pccard_resource_ops;
struct config_t;
struct pcmcia_callback;
struct user_info_t;

struct pccard_operations {
	int (*init)(struct pcmcia_socket *s);
	int (*suspend)(struct pcmcia_socket *s);
	int (*get_status)(struct pcmcia_socket *s, u_int *value);
	int (*set_socket)(struct pcmcia_socket *s, socket_state_t *state);
	int (*set_io_map)(struct pcmcia_socket *s, struct pccard_io_map *io);
	int (*set_mem_map)(struct pcmcia_socket *s, struct pccard_mem_map *mem);
};

struct pcmcia_socket {
	struct module			*owner;
	socket_state_t			socket;
	u_int				state;
	u_int				suspended_state;	/* state before suspend */
	u_short				functions;
	u_short				lock_count;
	pccard_mem_map			cis_mem;
	void __iomem 			*cis_virt;
	io_window_t			io[MAX_IO_WIN];
	pccard_mem_map			win[MAX_WIN];
	struct list_head		cis_cache;
	size_t				fake_cis_len;
	u8				*fake_cis;

	struct list_head		socket_list;
	struct completion		socket_released;

	/* deprecated */
	unsigned int			sock;		/* socket number */


	/* socket capabilities */
	u_int				features;
	u_int				irq_mask;
	u_int				map_size;
	u_int				io_offset;
	u_int				pci_irq;
	struct pci_dev			*cb_dev;

	/* socket setup is done so resources should be able to be allocated.
	 * Only if set to 1, calls to find_{io,mem}_region are handled, and
	 * insertio events are actually managed by the PCMCIA layer.*/
	u8				resource_setup_done;

	/* socket operations */
	struct pccard_operations	*ops;
	struct pccard_resource_ops	*resource_ops;
	void				*resource_data;

	/* Zoom video behaviour is so chip specific its not worth adding
	   this to _ops */
	void 				(*zoom_video)(struct pcmcia_socket *,
						      int);

	/* so is power hook */
	int (*power_hook)(struct pcmcia_socket *sock, int operation);

	/* allows tuning the CB bridge before loading driver for the CB card */
#ifdef CONFIG_CARDBUS
	void (*tune_bridge)(struct pcmcia_socket *sock, struct pci_bus *bus);
#endif

	/* state thread */
	struct task_struct		*thread;
	struct completion		thread_done;
	unsigned int			thread_events;
	unsigned int			sysfs_events;

	/* For the non-trivial interaction between these locks,
	 * see Documentation/pcmcia/locking.rst */
	struct mutex			skt_mutex;
	struct mutex			ops_mutex;

	/* protects thread_events and sysfs_events */
	spinlock_t			thread_lock;

	/* pcmcia (16-bit) */
	struct pcmcia_callback		*callback;

#if defined(CONFIG_PCMCIA) || defined(CONFIG_PCMCIA_MODULE)
	/* The following elements refer to 16-bit PCMCIA devices inserted
	 * into the socket */
	struct list_head		devices_list;

	/* the number of devices, used only internally and subject to
	 * incorrectness and change */
	u8				device_count;

	/* does the PCMCIA card consist of two pseudo devices? */
	u8				pcmcia_pfc;

	/* non-zero if PCMCIA card is present */
	atomic_t			present;

	/* IRQ to be used by PCMCIA devices. May not be IRQ 0. */
	unsigned int			pcmcia_irq;

#endif /* CONFIG_PCMCIA */

	/* socket device */
	struct device			dev;
	/* data internal to the socket driver */
	void				*driver_data;
	/* status of the card during resume from a system sleep state */
	int				resume_status;
};


/* socket drivers must define the resource operations type they use. There
 * are three options:
 * - pccard_static_ops		iomem and ioport areas are assigned statically
 * - pccard_iodyn_ops		iomem areas is assigned statically, ioport
 *				areas dynamically
 *				If this option is selected, use
 *				"select PCCARD_IODYN" in Kconfig.
 * - pccard_nonstatic_ops	iomem and ioport areas are assigned dynamically.
 *				If this option is selected, use
 *				"select PCCARD_NONSTATIC" in Kconfig.
 *
 */
extern struct pccard_resource_ops pccard_static_ops;
#if defined(CONFIG_PCMCIA) || defined(CONFIG_PCMCIA_MODULE)
extern struct pccard_resource_ops pccard_iodyn_ops;
extern struct pccard_resource_ops pccard_nonstatic_ops;
#else
/* If PCMCIA is not used, but only CARDBUS, these functions are not used
 * at all. Therefore, do not use the large (240K!) rsrc_nonstatic module
 */
#define pccard_iodyn_ops pccard_static_ops
#define pccard_nonstatic_ops pccard_static_ops
#endif


/* socket drivers use this callback in their IRQ handler */
extern void pcmcia_parse_events(struct pcmcia_socket *socket,
				unsigned int events);

/* to register and unregister a socket */
extern int pcmcia_register_socket(struct pcmcia_socket *socket);
extern void pcmcia_unregister_socket(struct pcmcia_socket *socket);


#endif /* _LINUX_SS_H */
Commit	Line	Data
d2912cb1	1	/* SPDX-License-Identifier: GPL-2.0-only */
1da177e4 LT	2	/*
	3	* ss.h
	4	*
1da177e4 LT	5	* The initial developer of the original code is David A. Hinds
	6	* <dahinds@users.sourceforge.net>. Portions created by David A. Hinds
	7	* are Copyright (C) 1999 David A. Hinds. All Rights Reserved.
	8	*
	9	* (C) 1999 David A. Hinds
	10	*/
	11
	12	#ifndef _LINUX_SS_H
	13	#define _LINUX_SS_H
	14
dc109497	15	#include <linux/device.h>
4e57b681	16	#include <linux/sched.h> /* task_struct, completion */
7fe908dd	17	#include <linux/mutex.h>
dc109497	18
8c3520d4 DR	19	#ifdef CONFIG_CARDBUS
	20	#include <linux/pci.h>
	21	#endif
1da177e4 LT	22
	23	/* Definitions for card status flags for GetStatus */
	24	#define SS_WRPROT 0x0001
	25	#define SS_CARDLOCK 0x0002
	26	#define SS_EJECTION 0x0004
	27	#define SS_INSERTION 0x0008
	28	#define SS_BATDEAD 0x0010
	29	#define SS_BATWARN 0x0020
	30	#define SS_READY 0x0040
	31	#define SS_DETECT 0x0080
	32	#define SS_POWERON 0x0100
	33	#define SS_GPI 0x0200
	34	#define SS_STSCHG 0x0400
	35	#define SS_CARDBUS 0x0800
	36	#define SS_3VCARD 0x1000
	37	#define SS_XVCARD 0x2000
	38	#define SS_PENDING 0x4000
	39	#define SS_ZVCARD 0x8000
	40
	41	/* InquireSocket capabilities */
	42	#define SS_CAP_PAGE_REGS 0x0001
	43	#define SS_CAP_VIRTUAL_BUS 0x0002
	44	#define SS_CAP_MEM_ALIGN 0x0004
	45	#define SS_CAP_STATIC_MAP 0x0008
	46	#define SS_CAP_PCCARD 0x4000
	47	#define SS_CAP_CARDBUS 0x8000
	48
	49	/* for GetSocket, SetSocket */
	50	typedef struct socket_state_t {
c23889ca DB	51	u_int flags;
	52	u_int csc_mask;
	53	u_char Vcc, Vpp;
	54	u_char io_irq;
1da177e4 LT	55	} socket_state_t;
	56
	57	extern socket_state_t dead_socket;
	58
	59	/* Socket configuration flags */
	60	#define SS_PWR_AUTO 0x0010
	61	#define SS_IOCARD 0x0020
	62	#define SS_RESET 0x0040
	63	#define SS_DMA_MODE 0x0080
	64	#define SS_SPKR_ENA 0x0100
	65	#define SS_OUTPUT_ENA 0x0200
	66
	67	/* Flags for I/O port and memory windows */
	68	#define MAP_ACTIVE 0x01
	69	#define MAP_16BIT 0x02
	70	#define MAP_AUTOSZ 0x04
	71	#define MAP_0WS 0x08
	72	#define MAP_WRPROT 0x10
	73	#define MAP_ATTRIB 0x20
	74	#define MAP_USE_WAIT 0x40
	75	#define MAP_PREFETCH 0x80
	76
	77	/* Use this just for bridge windows */
	78	#define MAP_IOSPACE 0x20
	79
fa912bcb DR	80	/* power hook operations */
	81	#define HOOK_POWER_PRE 0x01
	82	#define HOOK_POWER_POST 0x02
	83
1da177e4	84	typedef struct pccard_io_map {
c23889ca DB	85	u_char map;
	86	u_char flags;
	87	u_short speed;
1d807665	88	phys_addr_t start, stop;
1da177e4 LT	89	} pccard_io_map;
	90
	91	typedef struct pccard_mem_map {
c23889ca DB	92	u_char map;
	93	u_char flags;
	94	u_short speed;
1d807665	95	phys_addr_t static_start;
c23889ca DB	96	u_int card_start;
c23889ca DB	97	struct resource *res;
1da177e4 LT	98	} pccard_mem_map;
1da177e4 LT	99
1da177e4	100	typedef struct io_window_t {
906da809	101	u_int InUse, Config;
1da177e4 LT	102	struct resource *res;
	103	} io_window_t;
	104
1da177e4 LT	105	/* Maximum number of IO windows per socket */
	106	#define MAX_IO_WIN 2
	107
	108	/* Maximum number of memory windows per socket */
	109	#define MAX_WIN 4
	110
c23889ca DB	111
	112	/*
	113	* Socket operations.
	114	*/
	115	struct pcmcia_socket;
	116	struct pccard_resource_ops;
1da177e4 LT	117	struct config_t;
1da177e4 LT	118	struct pcmcia_callback;
dc109497	119	struct user_info_t;
1da177e4	120
c23889ca DB	121	struct pccard_operations {
	122	int (init)(struct pcmcia_socket s);
	123	int (suspend)(struct pcmcia_socket s);
	124	int (get_status)(struct pcmcia_socket s, u_int *value);
	125	int (set_socket)(struct pcmcia_socket s, socket_state_t *state);
	126	int (set_io_map)(struct pcmcia_socket s, struct pccard_io_map *io);
	127	int (set_mem_map)(struct pcmcia_socket s, struct pccard_mem_map *mem);
	128	};
	129
1da177e4 LT	130	struct pcmcia_socket {
1da177e4 LT	131	struct module *owner;
1da177e4 LT	132	socket_state_t socket;
1da177e4 LT	133	u_int state;
88b060d6	134	u_int suspended_state; /* state before suspend */
1da177e4 LT	135	u_short functions;
	136	u_short lock_count;
	137	pccard_mem_map cis_mem;
	138	void __iomem *cis_virt;
1da177e4	139	io_window_t io[MAX_IO_WIN];
82f88e36	140	pccard_mem_map win[MAX_WIN];
1da177e4	141	struct list_head cis_cache;
53efec95 DB	142	size_t fake_cis_len;
53efec95 DB	143	u8 *fake_cis;
1da177e4 LT	144
	145	struct list_head socket_list;
	146	struct completion socket_released;
	147
9fea84f4	148	/* deprecated */
1da177e4 LT	149	unsigned int sock; /* socket number */
	150
	151
	152	/* socket capabilities */
	153	u_int features;
	154	u_int irq_mask;
	155	u_int map_size;
906da809	156	u_int io_offset;
1689164a	157	u_int pci_irq;
9fea84f4	158	struct pci_dev *cb_dev;
1da177e4	159
c23889ca DB	160	/* socket setup is done so resources should be able to be allocated.
	161	* Only if set to 1, calls to find_{io,mem}_region are handled, and
	162	* insertio events are actually managed by the PCMCIA layer.*/
ce3f9d71	163	u8 resource_setup_done;
1da177e4 LT	164
1da177e4 LT	165	/* socket operations */
9fea84f4 DB	166	struct pccard_operations *ops;
	167	struct pccard_resource_ops *resource_ops;
	168	void *resource_data;
1da177e4 LT	169
	170	/* Zoom video behaviour is so chip specific its not worth adding
	171	this to _ops */
c23889ca DB	172	void (zoom_video)(struct pcmcia_socket ,
c23889ca DB	173	int);
fa912bcb DR	174
	175	/* so is power hook */
	176	int (power_hook)(struct pcmcia_socket sock, int operation);
c23889ca	177
8c3520d4	178	/* allows tuning the CB bridge before loading driver for the CB card */
c23889ca	179	#ifdef CONFIG_CARDBUS
8c3520d4 DR	180	void (tune_bridge)(struct pcmcia_socket sock, struct pci_bus *bus);
	181	#endif
	182
1da177e4	183	/* state thread */
1da177e4 LT	184	struct task_struct *thread;
1da177e4 LT	185	struct completion thread_done;
1da177e4	186	unsigned int thread_events;
f971dbd5	187	unsigned int sysfs_events;
00ce99ff DB	188
00ce99ff DB	189	/* For the non-trivial interaction between these locks,
3bdab16c	190	* see Documentation/pcmcia/locking.rst */
c23889ca	191	struct mutex skt_mutex;
6b8e087b	192	struct mutex ops_mutex;
00ce99ff	193
f971dbd5	194	/* protects thread_events and sysfs_events */
c23889ca	195	spinlock_t thread_lock;
1da177e4 LT	196
1da177e4 LT	197	/* pcmcia (16-bit) */
1da177e4 LT	198	struct pcmcia_callback *callback;
1da177e4 LT	199
dc109497	200	#if defined(CONFIG_PCMCIA) \|\| defined(CONFIG_PCMCIA_MODULE)
c23889ca DB	201	/* The following elements refer to 16-bit PCMCIA devices inserted
	202	* into the socket */
	203	struct list_head devices_list;
	204
	205	/* the number of devices, used only internally and subject to
	206	* incorrectness and change */
	207	u8 device_count;
dc109497	208
ce3f9d71 DB	209	/* does the PCMCIA card consist of two pseudo devices? */
ce3f9d71 DB	210	u8 pcmcia_pfc;
c23889ca	211
04de0816 DB	212	/* non-zero if PCMCIA card is present */
04de0816 DB	213	atomic_t present;
c23889ca	214
6f840afb DB	215	/* IRQ to be used by PCMCIA devices. May not be IRQ 0. */
	216	unsigned int pcmcia_irq;
	217
c23889ca	218	#endif /* CONFIG_PCMCIA */
dc109497	219
1da177e4	220	/* socket device */
87373318	221	struct device dev;
c23889ca DB	222	/* data internal to the socket driver */
c23889ca DB	223	void *driver_data;
9905d1b4 RW	224	/* status of the card during resume from a system sleep state */
9905d1b4 RW	225	int resume_status;
1da177e4 LT	226	};
1da177e4 LT	227
1da177e4	228
c23889ca DB	229	/* socket drivers must define the resource operations type they use. There
	230	* are three options:
	231	* - pccard_static_ops iomem and ioport areas are assigned statically
	232	* - pccard_iodyn_ops iomem areas is assigned statically, ioport
	233	* areas dynamically
4e8804ff DB	234	* If this option is selected, use
4e8804ff DB	235	* "select PCCARD_IODYN" in Kconfig.
c23889ca DB	236	* - pccard_nonstatic_ops iomem and ioport areas are assigned dynamically.
	237	* If this option is selected, use
	238	* "select PCCARD_NONSTATIC" in Kconfig.
3a86e180	239	*
c23889ca DB	240	*/
c23889ca DB	241	extern struct pccard_resource_ops pccard_static_ops;
3a86e180	242	#if defined(CONFIG_PCMCIA) \|\| defined(CONFIG_PCMCIA_MODULE)
c23889ca DB	243	extern struct pccard_resource_ops pccard_iodyn_ops;
c23889ca DB	244	extern struct pccard_resource_ops pccard_nonstatic_ops;
3a86e180 DB	245	#else
	246	/* If PCMCIA is not used, but only CARDBUS, these functions are not used
	247	* at all. Therefore, do not use the large (240K!) rsrc_nonstatic module
	248	*/
	249	#define pccard_iodyn_ops pccard_static_ops
	250	#define pccard_nonstatic_ops pccard_static_ops
	251	#endif
	252
1da177e4	253
c23889ca DB	254	/* socket drivers use this callback in their IRQ handler */
	255	extern void pcmcia_parse_events(struct pcmcia_socket *socket,
	256	unsigned int events);
1da177e4	257
c23889ca	258	/* to register and unregister a socket */
1da177e4 LT	259	extern int pcmcia_register_socket(struct pcmcia_socket *socket);
	260	extern void pcmcia_unregister_socket(struct pcmcia_socket *socket);
	261
1da177e4 LT	262
1da177e4 LT	263	#endif /* _LINUX_SS_H */