/*
   * 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>
  #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 (*get_status)(struct pcmcia_socket *sock, u_int *value);

  	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 {

  	int	(*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;

  /* static mem, dynamic IO sockets */
  extern struct pccard_resource_ops pccard_iodyn_ops;

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

  	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;

  	struct pcmcia_device	*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 {
  		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 mutex			skt_mutex;	/* 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 multifunction-device

  							       * add event is pending */

  					mfc_pfc:1,	/* the pending event adds a mfc (1) or pfc (0) */
  					reserved:3;

  	} 				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 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 */