[deliverable/linux.git] / drivers / firewire / fw-device.h

/*
 * Copyright (C) 2005-2006  Kristian Hoegsberg <krh@bitplanet.net>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */

#ifndef __fw_device_h
#define __fw_device_h

#include <linux/fs.h>
#include <linux/cdev.h>
#include <asm/atomic.h>

enum fw_device_state {
	FW_DEVICE_INITIALIZING,
	FW_DEVICE_RUNNING,
	FW_DEVICE_SHUTDOWN,
};

struct fw_attribute_group {
	struct attribute_group *groups[2];
	struct attribute_group group;
	struct attribute *attrs[11];
};

/*
 * Note, fw_device.generation always has to be read before fw_device.node_id.
 * Use SMP memory barriers to ensure this.  Otherwise requests will be sent
 * to an outdated node_id if the generation was updated in the meantime due
 * to a bus reset.
 *
 * Likewise, fw-core will take care to update .node_id before .generation so
 * that whenever fw_device.generation is current WRT the actual bus generation,
 * fw_device.node_id is guaranteed to be current too.
 *
 * The same applies to fw_device.card->node_id vs. fw_device.generation.
 */
struct fw_device {
	atomic_t state;
	struct fw_node *node;
	int node_id;
	int generation;
	unsigned max_speed;
	struct fw_card *card;
	struct device device;
	struct list_head link;
	struct list_head client_list;
	u32 *config_rom;
	size_t config_rom_length;
	int config_rom_retries;
	struct delayed_work work;
	struct fw_attribute_group attribute_group;
};

static inline struct fw_device *
fw_device(struct device *dev)
{
	return container_of(dev, struct fw_device, device);
}

static inline int
fw_device_is_shutdown(struct fw_device *device)
{
	return atomic_read(&device->state) == FW_DEVICE_SHUTDOWN;
}

static inline struct fw_device *
fw_device_get(struct fw_device *device)
{
	get_device(&device->device);

	return device;
}

static inline void
fw_device_put(struct fw_device *device)
{
	put_device(&device->device);
}

struct fw_device *fw_device_get_by_devt(dev_t devt);
int fw_device_enable_phys_dma(struct fw_device *device);

void fw_device_cdev_update(struct fw_device *device);
void fw_device_cdev_remove(struct fw_device *device);

extern int fw_cdev_major;

struct fw_unit {
	struct device device;
	u32 *directory;
	struct fw_attribute_group attribute_group;
};

static inline struct fw_unit *
fw_unit(struct device *dev)
{
	return container_of(dev, struct fw_unit, device);
}

#define CSR_OFFSET	0x40
#define CSR_LEAF	0x80
#define CSR_DIRECTORY	0xc0

#define CSR_DESCRIPTOR		0x01
#define CSR_VENDOR		0x03
#define CSR_HARDWARE_VERSION	0x04
#define CSR_NODE_CAPABILITIES	0x0c
#define CSR_UNIT		0x11
#define CSR_SPECIFIER_ID	0x12
#define CSR_VERSION		0x13
#define CSR_DEPENDENT_INFO	0x14
#define CSR_MODEL		0x17
#define CSR_INSTANCE		0x18
#define CSR_DIRECTORY_ID	0x20

struct fw_csr_iterator {
	u32 *p;
	u32 *end;
};

void fw_csr_iterator_init(struct fw_csr_iterator *ci, u32 *p);
int fw_csr_iterator_next(struct fw_csr_iterator *ci,
			 int *key, int *value);

#define FW_MATCH_VENDOR		0x0001
#define FW_MATCH_MODEL		0x0002
#define FW_MATCH_SPECIFIER_ID	0x0004
#define FW_MATCH_VERSION	0x0008

struct fw_device_id {
	u32 match_flags;
	u32 vendor;
	u32 model;
	u32 specifier_id;
	u32 version;
	void *driver_data;
};

struct fw_driver {
	struct device_driver driver;
	/* Called when the parent device sits through a bus reset. */
	void (*update) (struct fw_unit *unit);
	const struct fw_device_id *id_table;
};

static inline struct fw_driver *
fw_driver(struct device_driver *drv)
{
	return container_of(drv, struct fw_driver, driver);
}

extern const struct file_operations fw_device_ops;

#endif /* __fw_device_h */
Commit	Line	Data
c781c06d	1	/*
19a15b93 KH	2	* Copyright (C) 2005-2006 Kristian Hoegsberg <krh@bitplanet.net>
	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 as published by
	6	* the Free Software Foundation; either version 2 of the License, or
	7	* (at your option) any later version.
	8	*
	9	* This program is distributed in the hope that it will be useful,
	10	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	11	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	12	* GNU General Public License for more details.
	13	*
	14	* You should have received a copy of the GNU General Public License
	15	* along with this program; if not, write to the Free Software Foundation,
	16	* Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
	17	*/
	18
	19	#ifndef __fw_device_h
	20	#define __fw_device_h
	21
	22	#include <linux/fs.h>
	23	#include <linux/cdev.h>
641f8791	24	#include <asm/atomic.h>
19a15b93 KH	25
	26	enum fw_device_state {
	27	FW_DEVICE_INITIALIZING,
	28	FW_DEVICE_RUNNING,
5af4e5ea	29	FW_DEVICE_SHUTDOWN,
19a15b93 KH	30	};
19a15b93 KH	31
6f2e53d5 KH	32	struct fw_attribute_group {
	33	struct attribute_group *groups[2];
	34	struct attribute_group group;
	35	struct attribute *attrs[11];
	36	};
	37
b5d2a5e0 SR	38	/*
	39	* Note, fw_device.generation always has to be read before fw_device.node_id.
	40	* Use SMP memory barriers to ensure this. Otherwise requests will be sent
	41	* to an outdated node_id if the generation was updated in the meantime due
	42	* to a bus reset.
	43	*
	44	* Likewise, fw-core will take care to update .node_id before .generation so
	45	* that whenever fw_device.generation is current WRT the actual bus generation,
	46	* fw_device.node_id is guaranteed to be current too.
	47	*
	48	* The same applies to fw_device.card->node_id vs. fw_device.generation.
	49	*/
19a15b93	50	struct fw_device {
641f8791	51	atomic_t state;
19a15b93 KH	52	struct fw_node *node;
	53	int node_id;
	54	int generation;
f1397490	55	unsigned max_speed;
19a15b93 KH	56	struct fw_card *card;
19a15b93 KH	57	struct device device;
a3aca3da	58	struct list_head link;
97bd9efa	59	struct list_head client_list;
945ac222	60	u32 *config_rom;
19a15b93 KH	61	size_t config_rom_length;
	62	int config_rom_retries;
	63	struct delayed_work work;
6f2e53d5	64	struct fw_attribute_group attribute_group;
19a15b93 KH	65	};
	66
	67	static inline struct fw_device *
	68	fw_device(struct device *dev)
	69	{
5e20c282	70	return container_of(dev, struct fw_device, device);
19a15b93 KH	71	}
19a15b93 KH	72
2603bf21 KH	73	static inline int
	74	fw_device_is_shutdown(struct fw_device *device)
	75	{
	76	return atomic_read(&device->state) == FW_DEVICE_SHUTDOWN;
	77	}
	78
855c603d SR	79	static inline struct fw_device *
	80	fw_device_get(struct fw_device *device)
	81	{
	82	get_device(&device->device);
	83
	84	return device;
	85	}
	86
	87	static inline void
	88	fw_device_put(struct fw_device *device)
	89	{
	90	put_device(&device->device);
	91	}
	92
96b19062	93	struct fw_device *fw_device_get_by_devt(dev_t devt);
19a15b93 KH	94	int fw_device_enable_phys_dma(struct fw_device *device);
19a15b93 KH	95
97bd9efa	96	void fw_device_cdev_update(struct fw_device *device);
2603bf21	97	void fw_device_cdev_remove(struct fw_device *device);
97bd9efa	98
a3aca3da KH	99	extern int fw_cdev_major;
a3aca3da KH	100
19a15b93 KH	101	struct fw_unit {
	102	struct device device;
	103	u32 *directory;
6f2e53d5	104	struct fw_attribute_group attribute_group;
19a15b93 KH	105	};
	106
	107	static inline struct fw_unit *
	108	fw_unit(struct device *dev)
	109	{
5e20c282	110	return container_of(dev, struct fw_unit, device);
19a15b93 KH	111	}
	112
	113	#define CSR_OFFSET 0x40
	114	#define CSR_LEAF 0x80
	115	#define CSR_DIRECTORY 0xc0
	116
	117	#define CSR_DESCRIPTOR 0x01
	118	#define CSR_VENDOR 0x03
	119	#define CSR_HARDWARE_VERSION 0x04
	120	#define CSR_NODE_CAPABILITIES 0x0c
	121	#define CSR_UNIT 0x11
	122	#define CSR_SPECIFIER_ID 0x12
	123	#define CSR_VERSION 0x13
	124	#define CSR_DEPENDENT_INFO 0x14
	125	#define CSR_MODEL 0x17
	126	#define CSR_INSTANCE 0x18
14e21986	127	#define CSR_DIRECTORY_ID 0x20
19a15b93	128
19a15b93 KH	129	struct fw_csr_iterator {
	130	u32 *p;
	131	u32 *end;
	132	};
	133
	134	void fw_csr_iterator_init(struct fw_csr_iterator ci, u32 p);
	135	int fw_csr_iterator_next(struct fw_csr_iterator *ci,
	136	int key, int value);
	137
	138	#define FW_MATCH_VENDOR 0x0001
	139	#define FW_MATCH_MODEL 0x0002
	140	#define FW_MATCH_SPECIFIER_ID 0x0004
	141	#define FW_MATCH_VERSION 0x0008
	142
	143	struct fw_device_id {
	144	u32 match_flags;
	145	u32 vendor;
	146	u32 model;
	147	u32 specifier_id;
	148	u32 version;
	149	void *driver_data;
	150	};
	151
	152	struct fw_driver {
	153	struct device_driver driver;
	154	/* Called when the parent device sits through a bus reset. */
	155	void (update) (struct fw_unit unit);
21ebcd12	156	const struct fw_device_id *id_table;
19a15b93 KH	157	};
	158
	159	static inline struct fw_driver *
	160	fw_driver(struct device_driver *drv)
	161	{
5e20c282	162	return container_of(drv, struct fw_driver, driver);
19a15b93 KH	163	}
19a15b93 KH	164
21ebcd12	165	extern const struct file_operations fw_device_ops;
19a15b93	166
687198bb	167	#endif /* __fw_device_h */