[mirror_ubuntu-zesty-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/config.h>
#include <linux/device.h>

#include <pcmcia/cs_types.h>
#include <pcmcia/cs.h>
#include <pcmcia/bulkmem.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;
    kio_addr_t	start, stop;
} pccard_io_map;

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

typedef struct cb_bridge_map {
    u_char	map;
    u_char	flags;
    u_int	start, stop;
} cb_bridge_map;

/*
 * Socket operations.
 */
struct pcmcia_socket;

struct pccard_operations {
	int (*init)(struct pcmcia_socket *sock);
	int (*suspend)(struct pcmcia_socket *sock);
	int (*register_callback)(struct pcmcia_socket *sock, void (*handler)(void *, unsigned int), void * info);
	int (*get_status)(struct pcmcia_socket *sock, u_int *value);
	int (*get_socket)(struct pcmcia_socket *sock, socket_state_t *state);
	int (*set_socket)(struct pcmcia_socket *sock, socket_state_t *state);
	int (*set_io_map)(struct pcmcia_socket *sock, struct pccard_io_map *io);
	int (*set_mem_map)(struct pcmcia_socket *sock, struct pccard_mem_map *mem);
};

struct pccard_resource_ops {
	void	(*validate_mem)		(struct pcmcia_socket *s);
	int	(*adjust_io_region)	(struct resource *res,
					 unsigned long r_start,
					 unsigned long r_end,
					 struct pcmcia_socket *s);
	struct resource* (*find_io)	(unsigned long base, int num,
					 unsigned long align,
					 struct pcmcia_socket *s);
	struct resource* (*find_mem)	(unsigned long base, unsigned long num,
					 unsigned long align, int low,
					 struct pcmcia_socket *s);
	int	(*adjust_resource)	(struct pcmcia_socket *s,
					 adjust_t *adj);
	int	(*init)			(struct pcmcia_socket *s);
	void	(*exit)			(struct pcmcia_socket *s);
};
/* SS_CAP_STATIC_MAP */
extern struct pccard_resource_ops pccard_static_ops;
/* !SS_CAP_STATIC_MAP */
extern struct pccard_resource_ops pccard_nonstatic_ops;

/*
 *  Calls to set up low-level "Socket Services" drivers
 */
struct pcmcia_socket;

typedef struct io_window_t {
	u_int			Attributes;
	kio_addr_t		BasePort, NumPorts;
	kio_addr_t		InUse, Config;
	struct resource		*res;
} io_window_t;

#define WINDOW_MAGIC	0xB35C
typedef struct window_t {
	u_short			magic;
	u_short			index;
	client_handle_t		handle;
	struct pcmcia_socket 	*sock;
	pccard_mem_map		ctl;
} 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

struct config_t;
struct pcmcia_callback;
struct user_info_t;

struct pcmcia_socket {
	struct module			*owner;
	spinlock_t			lock;
	socket_state_t			socket;
	u_int				state;
	u_short				functions;
	u_short				lock_count;
	pccard_mem_map			cis_mem;
	void __iomem 			*cis_virt;
	struct config_t			*config;
	struct {
		u_int			AssignedIRQ;
		u_int			Config;
	} irq;
	io_window_t			io[MAX_IO_WIN];
	window_t			win[MAX_WIN];
	struct list_head		cis_cache;
	u_int				fake_cis_len;
	char				*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;
	kio_addr_t			io_offset;
	u_char				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 insertion
	 * events are actually managed by the PCMCIA layer.*/
	u8				resource_setup_done:1;

	/* is set to one 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);
#ifdef CONFIG_CARDBUS
	/* allows tuning the CB bridge before loading driver for the CB card */
	void (*tune_bridge)(struct pcmcia_socket *sock, struct pci_bus *bus);
#endif

	/* state thread */
	struct semaphore		skt_sem;	/* protects socket h/w state */

	struct task_struct		*thread;
	struct completion		thread_done;
	wait_queue_head_t		thread_wait;
	spinlock_t			thread_lock;	/* protects thread_events */
	unsigned int			thread_events;

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

#if defined(CONFIG_PCMCIA) || defined(CONFIG_PCMCIA_MODULE)
	struct list_head		devices_list;	/*  PCMCIA devices */
	u8				device_count;	/* the number of devices, used
							 * only internally and subject
							 * to incorrectness and change */

	struct {
		u8			present:1,	/* PCMCIA card is present in socket */
					busy:1,		/* "master" ioctl is used */
					dead:1,		/* pcmcia module is being unloaded */
					device_add_pending:1, /* a pseudo-multifunction-device
							       * add event is pending */
					reserved:4;
	} 				pcmcia_state;

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

#ifdef CONFIG_PCMCIA_IOCTL
	struct user_info_t		*user;
	wait_queue_head_t		queue;
#endif
#endif

	/* cardbus (32-bit) */
#ifdef CONFIG_CARDBUS
	struct resource *		cb_cis_res;
	void __iomem			*cb_cis_virt;
#endif

	/* socket device */
	struct class_device		dev;
	void				*driver_data;	/* data internal to the socket driver */

};

struct pcmcia_socket * pcmcia_get_socket_by_nr(unsigned int nr);


extern void pcmcia_parse_events(struct pcmcia_socket *socket, unsigned int events);
extern int pcmcia_register_socket(struct pcmcia_socket *socket);
extern void pcmcia_unregister_socket(struct pcmcia_socket *socket);

extern struct class pcmcia_socket_class;

/* socket drivers are expected to use these callbacks in their .drv struct */
extern int pcmcia_socket_dev_suspend(struct device *dev, pm_message_t state);
extern int pcmcia_socket_dev_resume(struct device *dev);

#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 DB	18	#include <linux/config.h>
	19	#include <linux/device.h>
	20
1da177e4 LT	21	#include <pcmcia/cs_types.h>
	22	#include <pcmcia/cs.h>
	23	#include <pcmcia/bulkmem.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 {
	56	u_int flags;
	57	u_int csc_mask;
	58	u_char Vcc, Vpp;
	59	u_char io_irq;
	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
	89
1da177e4 LT	90	typedef struct pccard_io_map {
	91	u_char map;
	92	u_char flags;
	93	u_short speed;
	94	kio_addr_t start, stop;
	95	} pccard_io_map;
	96
	97	typedef struct pccard_mem_map {
	98	u_char map;
	99	u_char flags;
	100	u_short speed;
	101	u_long static_start;
	102	u_int card_start;
	103	struct resource *res;
	104	} pccard_mem_map;
	105
	106	typedef struct cb_bridge_map {
	107	u_char map;
	108	u_char flags;
	109	u_int start, stop;
	110	} cb_bridge_map;
	111
	112	/*
	113	* Socket operations.
	114	*/
	115	struct pcmcia_socket;
	116
	117	struct pccard_operations {
	118	int (init)(struct pcmcia_socket sock);
	119	int (suspend)(struct pcmcia_socket sock);
	120	int (register_callback)(struct pcmcia_socket sock, void (handler)(void , unsigned int), void * info);
	121	int (get_status)(struct pcmcia_socket sock, u_int *value);
	122	int (get_socket)(struct pcmcia_socket sock, socket_state_t *state);
	123	int (set_socket)(struct pcmcia_socket sock, socket_state_t *state);
	124	int (set_io_map)(struct pcmcia_socket sock, struct pccard_io_map *io);
	125	int (set_mem_map)(struct pcmcia_socket sock, struct pccard_mem_map *mem);
	126	};
	127
	128	struct pccard_resource_ops {
	129	void (validate_mem) (struct pcmcia_socket s);
	130	int (adjust_io_region) (struct resource res,
	131	unsigned long r_start,
	132	unsigned long r_end,
	133	struct pcmcia_socket *s);
	134	struct resource* (*find_io) (unsigned long base, int num,
	135	unsigned long align,
	136	struct pcmcia_socket *s);
	137	struct resource* (*find_mem) (unsigned long base, unsigned long num,
	138	unsigned long align, int low,
	139	struct pcmcia_socket *s);
	140	int (adjust_resource) (struct pcmcia_socket s,
	141	adjust_t *adj);
	142	int (init) (struct pcmcia_socket s);
	143	void (exit) (struct pcmcia_socket s);
	144	};
	145	/* SS_CAP_STATIC_MAP */
	146	extern struct pccard_resource_ops pccard_static_ops;
	147	/* !SS_CAP_STATIC_MAP */
	148	extern struct pccard_resource_ops pccard_nonstatic_ops;
	149
	150	/*
	151	* Calls to set up low-level "Socket Services" drivers
	152	*/
	153	struct pcmcia_socket;
154
155	typedef struct io_window_t {
156	u_int Attributes;
157	kio_addr_t BasePort, NumPorts;
158	kio_addr_t InUse, Config;
159	struct resource *res;
160	} io_window_t;
161
162	#define WINDOW_MAGIC 0xB35C
163	typedef struct window_t {
164	u_short magic;
165	u_short index;
166	client_handle_t handle;
167	struct pcmcia_socket *sock;
168	pccard_mem_map ctl;
169	} window_t;
170
171	/* Maximum number of IO windows per socket */
172	#define MAX_IO_WIN 2
173
174	/* Maximum number of memory windows per socket */
175	#define MAX_WIN 4
176
177	struct config_t;
178	struct pcmcia_callback;
dc109497	179	struct user_info_t;
1da177e4 LT	180
	181	struct pcmcia_socket {
	182	struct module *owner;
	183	spinlock_t lock;
	184	socket_state_t socket;
	185	u_int state;
	186	u_short functions;
	187	u_short lock_count;
	188	pccard_mem_map cis_mem;
	189	void __iomem *cis_virt;
	190	struct config_t *config;
	191	struct {
	192	u_int AssignedIRQ;
	193	u_int Config;
	194	} irq;
	195	io_window_t io[MAX_IO_WIN];
	196	window_t win[MAX_WIN];
	197	struct list_head cis_cache;
	198	u_int fake_cis_len;
	199	char *fake_cis;
	200
	201	struct list_head socket_list;
	202	struct completion socket_released;
	203
	204	/* deprecated */
	205	unsigned int sock; /* socket number */
	206
	207
	208	/* socket capabilities */
	209	u_int features;
	210	u_int irq_mask;
	211	u_int map_size;
	212	kio_addr_t io_offset;
	213	u_char pci_irq;
	214	struct pci_dev * cb_dev;
	215
	216
	217	/* socket setup is done so resources should be able to be allocated. Only
	218	* if set to 1, calls to find_{io,mem}_region are handled, and insertion
	219	* events are actually managed by the PCMCIA layer.*/
	220	u8 resource_setup_done:1;
	221
	222	/* is set to one if resource setup is done using adjust_resource_info() */
	223	u8 resource_setup_old:1;
3c29976a	224	u8 resource_setup_new:1;
1da177e4	225
3c29976a	226	u8 reserved:5;
1da177e4 LT	227
	228	/* socket operations */
	229	struct pccard_operations * ops;
	230	struct pccard_resource_ops * resource_ops;
	231	void * resource_data;
	232
	233	/* Zoom video behaviour is so chip specific its not worth adding
	234	this to _ops */
	235	void (zoom_video)(struct pcmcia_socket , int);
fa912bcb DR	236
	237	/* so is power hook */
	238	int (power_hook)(struct pcmcia_socket sock, int operation);
8c3520d4 DR	239	#ifdef CONFIG_CARDBUS
	240	/* allows tuning the CB bridge before loading driver for the CB card */
	241	void (tune_bridge)(struct pcmcia_socket sock, struct pci_bus *bus);
	242	#endif
	243
1da177e4 LT	244	/* state thread */
	245	struct semaphore skt_sem; /* protects socket h/w state */
	246
	247	struct task_struct *thread;
	248	struct completion thread_done;
	249	wait_queue_head_t thread_wait;
	250	spinlock_t thread_lock; /* protects thread_events */
	251	unsigned int thread_events;
	252
	253	/* pcmcia (16-bit) */
1da177e4 LT	254	struct pcmcia_callback *callback;
1da177e4 LT	255
dc109497 DB	256	#if defined(CONFIG_PCMCIA) \|\| defined(CONFIG_PCMCIA_MODULE)
	257	struct list_head devices_list; /* PCMCIA devices */
	258	u8 device_count; /* the number of devices, used
	259	* only internally and subject
	260	* to incorrectness and change */
	261
	262	struct {
	263	u8 present:1, /* PCMCIA card is present in socket */
	264	busy:1, /* "master" ioctl is used */
	265	dead:1, /* pcmcia module is being unloaded */
	266	device_add_pending:1, /* a pseudo-multifunction-device
	267	* add event is pending */
	268	reserved:4;
	269	} pcmcia_state;
	270
	271	struct work_struct device_add; /* for adding further pseudo-multifunction
	272	* devices */
	273
	274	#ifdef CONFIG_PCMCIA_IOCTL
	275	struct user_info_t *user;
	276	wait_queue_head_t queue;
	277	#endif
	278	#endif
	279
1da177e4 LT	280	/* cardbus (32-bit) */
	281	#ifdef CONFIG_CARDBUS
	282	struct resource * cb_cis_res;
	283	void __iomem *cb_cis_virt;
	284	#endif
	285
	286	/* socket device */
	287	struct class_device dev;
	288	void driver_data; / data internal to the socket driver */
	289
	290	};
	291
	292	struct pcmcia_socket * pcmcia_get_socket_by_nr(unsigned int nr);
	293
	294
	295
	296	extern void pcmcia_parse_events(struct pcmcia_socket *socket, unsigned int events);
	297	extern int pcmcia_register_socket(struct pcmcia_socket *socket);
	298	extern void pcmcia_unregister_socket(struct pcmcia_socket *socket);
	299
	300	extern struct class pcmcia_socket_class;
	301
	302	/* socket drivers are expected to use these callbacks in their .drv struct */
	303	extern int pcmcia_socket_dev_suspend(struct device *dev, pm_message_t state);
	304	extern int pcmcia_socket_dev_resume(struct device *dev);
	305
	306	#endif /* _LINUX_SS_H */