[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];
};

struct fw_device {
	atomic_t state;
	struct fw_node *node;
	int node_id;
	int generation;
	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;
}

struct fw_device *fw_device_get(struct fw_device *device);
void fw_device_put(struct fw_device *device);
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);

struct fw_device *fw_device_from_devt(dev_t devt);
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 SBP2_COMMAND_SET_SPECIFIER	0x38
#define SBP2_COMMAND_SET		0x39
#define SBP2_COMMAND_SET_REVISION	0x3b
#define SBP2_FIRMWARE_REVISION		0x3c

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
19a15b93	38	struct fw_device {
641f8791	39	atomic_t state;
19a15b93 KH	40	struct fw_node *node;
	41	int node_id;
	42	int generation;
	43	struct fw_card *card;
	44	struct device device;
a3aca3da	45	struct list_head link;
97bd9efa	46	struct list_head client_list;
945ac222	47	u32 *config_rom;
19a15b93 KH	48	size_t config_rom_length;
	49	int config_rom_retries;
	50	struct delayed_work work;
6f2e53d5	51	struct fw_attribute_group attribute_group;
19a15b93 KH	52	};
	53
	54	static inline struct fw_device *
	55	fw_device(struct device *dev)
	56	{
5e20c282	57	return container_of(dev, struct fw_device, device);
19a15b93 KH	58	}
19a15b93 KH	59
2603bf21 KH	60	static inline int
	61	fw_device_is_shutdown(struct fw_device *device)
	62	{
	63	return atomic_read(&device->state) == FW_DEVICE_SHUTDOWN;
	64	}
	65
19a15b93 KH	66	struct fw_device fw_device_get(struct fw_device device);
	67	void fw_device_put(struct fw_device *device);
	68	int fw_device_enable_phys_dma(struct fw_device *device);
	69
97bd9efa	70	void fw_device_cdev_update(struct fw_device *device);
2603bf21	71	void fw_device_cdev_remove(struct fw_device *device);
97bd9efa	72
a3aca3da KH	73	struct fw_device *fw_device_from_devt(dev_t devt);
	74	extern int fw_cdev_major;
	75
19a15b93 KH	76	struct fw_unit {
	77	struct device device;
	78	u32 *directory;
6f2e53d5	79	struct fw_attribute_group attribute_group;
19a15b93 KH	80	};
	81
	82	static inline struct fw_unit *
	83	fw_unit(struct device *dev)
	84	{
5e20c282	85	return container_of(dev, struct fw_unit, device);
19a15b93 KH	86	}
	87
	88	#define CSR_OFFSET 0x40
	89	#define CSR_LEAF 0x80
	90	#define CSR_DIRECTORY 0xc0
	91
	92	#define CSR_DESCRIPTOR 0x01
	93	#define CSR_VENDOR 0x03
	94	#define CSR_HARDWARE_VERSION 0x04
	95	#define CSR_NODE_CAPABILITIES 0x0c
	96	#define CSR_UNIT 0x11
	97	#define CSR_SPECIFIER_ID 0x12
	98	#define CSR_VERSION 0x13
	99	#define CSR_DEPENDENT_INFO 0x14
	100	#define CSR_MODEL 0x17
	101	#define CSR_INSTANCE 0x18
	102
	103	#define SBP2_COMMAND_SET_SPECIFIER 0x38
	104	#define SBP2_COMMAND_SET 0x39
	105	#define SBP2_COMMAND_SET_REVISION 0x3b
	106	#define SBP2_FIRMWARE_REVISION 0x3c
	107
	108	struct fw_csr_iterator {
	109	u32 *p;
	110	u32 *end;
	111	};
	112
	113	void fw_csr_iterator_init(struct fw_csr_iterator ci, u32 p);
	114	int fw_csr_iterator_next(struct fw_csr_iterator *ci,
	115	int key, int value);
	116
	117	#define FW_MATCH_VENDOR 0x0001
	118	#define FW_MATCH_MODEL 0x0002
	119	#define FW_MATCH_SPECIFIER_ID 0x0004
	120	#define FW_MATCH_VERSION 0x0008
	121
	122	struct fw_device_id {
	123	u32 match_flags;
	124	u32 vendor;
	125	u32 model;
	126	u32 specifier_id;
	127	u32 version;
	128	void *driver_data;
	129	};
	130
	131	struct fw_driver {
	132	struct device_driver driver;
	133	/* Called when the parent device sits through a bus reset. */
	134	void (update) (struct fw_unit unit);
21ebcd12	135	const struct fw_device_id *id_table;
19a15b93 KH	136	};
	137
	138	static inline struct fw_driver *
	139	fw_driver(struct device_driver *drv)
	140	{
5e20c282	141	return container_of(drv, struct fw_driver, driver);
19a15b93 KH	142	}
19a15b93 KH	143
21ebcd12	144	extern const struct file_operations fw_device_ops;
19a15b93	145
687198bb	146	#endif /* __fw_device_h */