[net-next-2.6.git] / drivers / pcmcia / cs_internal.h

/*
 * cs_internal.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_CS_INTERNAL_H
#define _LINUX_CS_INTERNAL_H

#include <linux/config.h>

/* Flags in client state */
#define CLIENT_CONFIG_LOCKED	0x0001
#define CLIENT_IRQ_REQ		0x0002
#define CLIENT_IO_REQ		0x0004
#define CLIENT_UNBOUND		0x0008
#define CLIENT_STALE		0x0010
#define CLIENT_WIN_REQ(i)	(0x20<<(i))
#define CLIENT_CARDBUS		0x8000

#define REGION_MAGIC	0xE3C9
typedef struct region_t {
    u_short		region_magic;
    u_short		state;
    dev_info_t		dev_info;
    client_handle_t	mtd;
    u_int		MediaID;
    region_info_t	info;
} region_t;

#define REGION_STALE	0x01

/* Each card function gets one of these guys */
typedef struct config_t {
    u_int		state;
    u_int		Attributes;
    u_int		IntType;
    u_int		ConfigBase;
    u_char		Status, Pin, Copy, Option, ExtStatus;
    u_int		CardValues;
    io_req_t		io;
    struct {
	u_int		Attributes;
    } irq;
} config_t;

struct cis_cache_entry {
	struct list_head	node;
	unsigned int		addr;
	unsigned int		len;
	unsigned int		attr;
	unsigned char		cache[0];
};

/* Flags in config state */
#define CONFIG_LOCKED		0x01
#define CONFIG_IRQ_REQ		0x02
#define CONFIG_IO_REQ		0x04

/* Flags in socket state */
#define SOCKET_PRESENT		0x0008
#define SOCKET_INUSE		0x0010
#define SOCKET_SUSPEND		0x0080
#define SOCKET_WIN_REQ(i)	(0x0100<<(i))
#define SOCKET_REGION_INFO	0x4000
#define SOCKET_CARDBUS		0x8000
#define SOCKET_CARDBUS_CONFIG	0x10000

static inline int cs_socket_get(struct pcmcia_socket *skt)
{
	int ret;

	WARN_ON(skt->state & SOCKET_INUSE);

	ret = try_module_get(skt->owner);
	if (ret)
		skt->state |= SOCKET_INUSE;
	return ret;
}

static inline void cs_socket_put(struct pcmcia_socket *skt)
{
	if (skt->state & SOCKET_INUSE) {
		skt->state &= ~SOCKET_INUSE;
		module_put(skt->owner);
	}
}

/* In cardbus.c */
int cb_alloc(struct pcmcia_socket *s);
void cb_free(struct pcmcia_socket *s);
int read_cb_mem(struct pcmcia_socket *s, int space, u_int addr, u_int len, void *ptr);

/* In cistpl.c */
int pcmcia_read_cis_mem(struct pcmcia_socket *s, int attr,
		 u_int addr, u_int len, void *ptr);
void pcmcia_write_cis_mem(struct pcmcia_socket *s, int attr,
		   u_int addr, u_int len, void *ptr);
void release_cis_mem(struct pcmcia_socket *s);
void destroy_cis_cache(struct pcmcia_socket *s);
int verify_cis_cache(struct pcmcia_socket *s);
int pccard_read_tuple(struct pcmcia_socket *s, unsigned int function, cisdata_t code, void *parse);

/* In rsrc_mgr */
int pcmcia_validate_mem(struct pcmcia_socket *s);
struct resource *pcmcia_find_io_region(unsigned long base, int num, unsigned long align,
		   struct pcmcia_socket *s);
int pcmcia_adjust_io_region(struct resource *res, unsigned long r_start,
		     unsigned long r_end, struct pcmcia_socket *s);
struct resource *pcmcia_find_mem_region(u_long base, u_long num, u_long align,
		    int low, struct pcmcia_socket *s);
void release_resource_db(struct pcmcia_socket *s);

/* In socket_sysfs.c */
extern struct class_interface pccard_sysfs_interface;

/* In cs.c */
extern struct rw_semaphore pcmcia_socket_list_rwsem;
extern struct list_head pcmcia_socket_list;
int pcmcia_get_window(struct pcmcia_socket *s, window_handle_t *handle, int idx, win_req_t *req);
int pccard_get_configuration_info(struct pcmcia_socket *s, struct pcmcia_device *p_dev, config_info_t *config);
int pccard_reset_card(struct pcmcia_socket *skt);
int pccard_get_status(struct pcmcia_socket *s, struct pcmcia_device *p_dev, cs_status_t *status);


struct pcmcia_callback{
	struct module	*owner;
	int		(*event) (struct pcmcia_socket *s, event_t event, int priority);
	void		(*requery) (struct pcmcia_socket *s);
	int		(*suspend) (struct pcmcia_socket *s);
	int		(*resume) (struct pcmcia_socket *s);
};

int pccard_register_pcmcia(struct pcmcia_socket *s, struct pcmcia_callback *c);

#define cs_socket_name(skt)	((skt)->dev.class_id)

#ifdef DEBUG
extern int cs_debug_level(int);

#define cs_dbg(skt, lvl, fmt, arg...) do {		\
	if (cs_debug_level(lvl))			\
		printk(KERN_DEBUG "cs: %s: " fmt, 	\
		       cs_socket_name(skt) , ## arg);	\
} while (0)

#else
#define cs_dbg(skt, lvl, fmt, arg...) do { } while (0)
#endif

#define cs_err(skt, fmt, arg...) \
	printk(KERN_ERR "cs: %s: " fmt, (skt)->dev.class_id , ## arg)

#endif /* _LINUX_CS_INTERNAL_H */
Commit	Line	Data
1da177e4 LT	1	/*
	2	* cs_internal.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_CS_INTERNAL_H
	16	#define _LINUX_CS_INTERNAL_H
	17
	18	#include <linux/config.h>
	19
1da177e4 LT	20	/* Flags in client state */
	21	#define CLIENT_CONFIG_LOCKED 0x0001
	22	#define CLIENT_IRQ_REQ 0x0002
	23	#define CLIENT_IO_REQ 0x0004
	24	#define CLIENT_UNBOUND 0x0008
	25	#define CLIENT_STALE 0x0010
	26	#define CLIENT_WIN_REQ(i) (0x20<<(i))
	27	#define CLIENT_CARDBUS 0x8000
	28
	29	#define REGION_MAGIC 0xE3C9
	30	typedef struct region_t {
	31	u_short region_magic;
	32	u_short state;
	33	dev_info_t dev_info;
	34	client_handle_t mtd;
	35	u_int MediaID;
	36	region_info_t info;
	37	} region_t;
	38
	39	#define REGION_STALE 0x01
	40
	41	/* Each card function gets one of these guys */
	42	typedef struct config_t {
	43	u_int state;
	44	u_int Attributes;
1da177e4 LT	45	u_int IntType;
	46	u_int ConfigBase;
	47	u_char Status, Pin, Copy, Option, ExtStatus;
1da177e4 LT	48	u_int CardValues;
	49	io_req_t io;
	50	struct {
	51	u_int Attributes;
	52	} irq;
	53	} config_t;
	54
	55	struct cis_cache_entry {
	56	struct list_head node;
	57	unsigned int addr;
	58	unsigned int len;
	59	unsigned int attr;
	60	unsigned char cache[0];
	61	};
	62
	63	/* Flags in config state */
	64	#define CONFIG_LOCKED 0x01
	65	#define CONFIG_IRQ_REQ 0x02
	66	#define CONFIG_IO_REQ 0x04
	67
	68	/* Flags in socket state */
	69	#define SOCKET_PRESENT 0x0008
	70	#define SOCKET_INUSE 0x0010
	71	#define SOCKET_SUSPEND 0x0080
	72	#define SOCKET_WIN_REQ(i) (0x0100<<(i))
	73	#define SOCKET_REGION_INFO 0x4000
	74	#define SOCKET_CARDBUS 0x8000
	75	#define SOCKET_CARDBUS_CONFIG 0x10000
	76
	77	static inline int cs_socket_get(struct pcmcia_socket *skt)
	78	{
	79	int ret;
	80
	81	WARN_ON(skt->state & SOCKET_INUSE);
	82
	83	ret = try_module_get(skt->owner);
	84	if (ret)
	85	skt->state \|= SOCKET_INUSE;
	86	return ret;
	87	}
	88
	89	static inline void cs_socket_put(struct pcmcia_socket *skt)
	90	{
	91	if (skt->state & SOCKET_INUSE) {
	92	skt->state &= ~SOCKET_INUSE;
	93	module_put(skt->owner);
	94	}
	95	}
	96
1da177e4 LT	97	/* In cardbus.c */
	98	int cb_alloc(struct pcmcia_socket *s);
	99	void cb_free(struct pcmcia_socket *s);
	100	int read_cb_mem(struct pcmcia_socket s, int space, u_int addr, u_int len, void ptr);
	101
	102	/* In cistpl.c */
e6ea0b9e	103	int pcmcia_read_cis_mem(struct pcmcia_socket *s, int attr,
1da177e4	104	u_int addr, u_int len, void *ptr);
e6ea0b9e	105	void pcmcia_write_cis_mem(struct pcmcia_socket *s, int attr,
1da177e4 LT	106	u_int addr, u_int len, void *ptr);
	107	void release_cis_mem(struct pcmcia_socket *s);
	108	void destroy_cis_cache(struct pcmcia_socket *s);
	109	int verify_cis_cache(struct pcmcia_socket *s);
	110	int pccard_read_tuple(struct pcmcia_socket s, unsigned int function, cisdata_t code, void parse);
	111
	112	/* In rsrc_mgr */
de75914e	113	int pcmcia_validate_mem(struct pcmcia_socket *s);
e6ea0b9e	114	struct resource *pcmcia_find_io_region(unsigned long base, int num, unsigned long align,
1da177e4	115	struct pcmcia_socket *s);
e6ea0b9e	116	int pcmcia_adjust_io_region(struct resource *res, unsigned long r_start,
1da177e4	117	unsigned long r_end, struct pcmcia_socket *s);
e6ea0b9e	118	struct resource *pcmcia_find_mem_region(u_long base, u_long num, u_long align,
1da177e4	119	int low, struct pcmcia_socket *s);
1da177e4 LT	120	void release_resource_db(struct pcmcia_socket *s);
	121
	122	/* In socket_sysfs.c */
	123	extern struct class_interface pccard_sysfs_interface;
	124
	125	/* In cs.c */
	126	extern struct rw_semaphore pcmcia_socket_list_rwsem;
	127	extern struct list_head pcmcia_socket_list;
	128	int pcmcia_get_window(struct pcmcia_socket s, window_handle_t handle, int idx, win_req_t *req);
855cdf13	129	int pccard_get_configuration_info(struct pcmcia_socket s, struct pcmcia_device p_dev, config_info_t *config);
1da177e4	130	int pccard_reset_card(struct pcmcia_socket *skt);
855cdf13	131	int pccard_get_status(struct pcmcia_socket s, struct pcmcia_device p_dev, cs_status_t *status);
1da177e4 LT	132
	133
	134	struct pcmcia_callback{
	135	struct module *owner;
	136	int (event) (struct pcmcia_socket s, event_t event, int priority);
e2f0b534	137	void (requery) (struct pcmcia_socket s);
8e9e793d DB	138	int (suspend) (struct pcmcia_socket s);
8e9e793d DB	139	int (resume) (struct pcmcia_socket s);
1da177e4 LT	140	};
	141
	142	int pccard_register_pcmcia(struct pcmcia_socket s, struct pcmcia_callback c);
	143
	144	#define cs_socket_name(skt) ((skt)->dev.class_id)
	145
	146	#ifdef DEBUG
	147	extern int cs_debug_level(int);
	148
	149	#define cs_dbg(skt, lvl, fmt, arg...) do { \
	150	if (cs_debug_level(lvl)) \
	151	printk(KERN_DEBUG "cs: %s: " fmt, \
	152	cs_socket_name(skt) , ## arg); \
	153	} while (0)
	154
	155	#else
	156	#define cs_dbg(skt, lvl, fmt, arg...) do { } while (0)
	157	#endif
	158
	159	#define cs_err(skt, fmt, arg...) \
	160	printk(KERN_ERR "cs: %s: " fmt, (skt)->dev.class_id , ## arg)
	161
	162	#endif /* _LINUX_CS_INTERNAL_H */