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

/*
 * ss.h
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 *
 * 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>

#include <pcmcia/cs_types.h>
#include <pcmcia/cs.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;
	spinlock_t			lock;
	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;
	struct {
		u_int			AssignedIRQ;
		u_int			Config;
	} irq;
	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:1;

	/* It's old if resource setup is done using adjust_resource_info() */
	u8				resource_setup_old:1;
	u8				resource_setup_new:1;

	u8				reserved:5;

	/* 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;
	/* protects socket h/w state */
	struct mutex			skt_mutex;
	/* protects PCMCIA state */
	struct mutex			ops_mutex;
	/* protects thread_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;

	/* 16-bit state: */
	struct {
		/* PCMCIA card is present in socket */
		u8			present:1;
		/* "master" ioctl is used */
		u8			busy:1;
		/* pcmcia module is being unloaded */
		u8			dead:1;
		/* a multifunction-device add event is pending */
		u8			device_add_pending:1;
		/* the pending event adds a mfc (1) or pfc (0) */
		u8			mfc_pfc:1;

		u8			reserved:3;
	} pcmcia_state;


	/* for adding further pseudo-multifunction devices */
	struct work_struct		device_add;

#ifdef CONFIG_PCMCIA_IOCTL
	struct user_info_t		*user;
	wait_queue_head_t		queue;
#endif /* CONFIG_PCMCIA_IOCTL */
#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 are expected to use these callbacks in their .drv struct */
extern int pcmcia_socket_dev_suspend(struct device *dev);
extern void pcmcia_socket_dev_early_resume(struct device *dev);
extern void pcmcia_socket_dev_late_resume(struct device *dev);
extern int pcmcia_socket_dev_resume(struct device *dev);

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