[mirror_ubuntu-hirsute-kernel.git] / drivers / firewire / fw-device.h

/*						-*- c-basic-offset: 8 -*-
 *
 * fw-device.h - Device probing and sysfs code.
 *
 * 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_device {
	atomic_t state;
	struct fw_node *node;
	int node_id;
	int generation;
	struct fw_card *card;
	struct device device;
	struct cdev cdev;
	struct list_head client_list;
	__be32 *config_rom;
	size_t config_rom_length;
	int config_rom_retries;
	struct delayed_work work;
};

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

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);

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

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
19a15b93 KH	1	/* -- c-basic-offset: 8 --
	2	*
	3	* fw-device.h - Device probing and sysfs code.
	4	*
	5	* Copyright (C) 2005-2006 Kristian Hoegsberg <krh@bitplanet.net>
	6	*
	7	* This program is free software; you can redistribute it and/or modify
	8	* it under the terms of the GNU General Public License as published by
	9	* the Free Software Foundation; either version 2 of the License, or
	10	* (at your option) any later version.
	11	*
	12	* This program is distributed in the hope that it will be useful,
	13	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	14	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	15	* GNU General Public License for more details.
	16	*
	17	* You should have received a copy of the GNU General Public License
	18	* along with this program; if not, write to the Free Software Foundation,
	19	* Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
	20	*/
	21
	22	#ifndef __fw_device_h
	23	#define __fw_device_h
	24
	25	#include <linux/fs.h>
	26	#include <linux/cdev.h>
641f8791	27	#include <asm/atomic.h>
19a15b93 KH	28
	29	enum fw_device_state {
	30	FW_DEVICE_INITIALIZING,
	31	FW_DEVICE_RUNNING,
5af4e5ea	32	FW_DEVICE_SHUTDOWN,
19a15b93 KH	33	};
	34
	35	struct fw_device {
641f8791	36	atomic_t state;
19a15b93 KH	37	struct fw_node *node;
	38	int node_id;
	39	int generation;
	40	struct fw_card *card;
	41	struct device device;
	42	struct cdev cdev;
97bd9efa	43	struct list_head client_list;
19a15b93 KH	44	__be32 *config_rom;
	45	size_t config_rom_length;
	46	int config_rom_retries;
	47	struct delayed_work work;
	48	};
	49
	50	static inline struct fw_device *
	51	fw_device(struct device *dev)
	52	{
5e20c282	53	return container_of(dev, struct fw_device, device);
19a15b93 KH	54	}
	55
	56	struct fw_device fw_device_get(struct fw_device device);
	57	void fw_device_put(struct fw_device *device);
	58	int fw_device_enable_phys_dma(struct fw_device *device);
	59
97bd9efa KH	60	void fw_device_cdev_update(struct fw_device *device);
97bd9efa KH	61
19a15b93 KH	62	struct fw_unit {
	63	struct device device;
	64	u32 *directory;
	65	};
	66
	67	static inline struct fw_unit *
	68	fw_unit(struct device *dev)
	69	{
5e20c282	70	return container_of(dev, struct fw_unit, device);
19a15b93 KH	71	}
	72
	73	#define CSR_OFFSET 0x40
	74	#define CSR_LEAF 0x80
	75	#define CSR_DIRECTORY 0xc0
	76
	77	#define CSR_DESCRIPTOR 0x01
	78	#define CSR_VENDOR 0x03
	79	#define CSR_HARDWARE_VERSION 0x04
	80	#define CSR_NODE_CAPABILITIES 0x0c
	81	#define CSR_UNIT 0x11
	82	#define CSR_SPECIFIER_ID 0x12
	83	#define CSR_VERSION 0x13
	84	#define CSR_DEPENDENT_INFO 0x14
	85	#define CSR_MODEL 0x17
	86	#define CSR_INSTANCE 0x18
	87
	88	#define SBP2_COMMAND_SET_SPECIFIER 0x38
	89	#define SBP2_COMMAND_SET 0x39
	90	#define SBP2_COMMAND_SET_REVISION 0x3b
	91	#define SBP2_FIRMWARE_REVISION 0x3c
	92
	93	struct fw_csr_iterator {
	94	u32 *p;
	95	u32 *end;
	96	};
	97
	98	void fw_csr_iterator_init(struct fw_csr_iterator ci, u32 p);
	99	int fw_csr_iterator_next(struct fw_csr_iterator *ci,
	100	int key, int value);
	101
	102	#define FW_MATCH_VENDOR 0x0001
	103	#define FW_MATCH_MODEL 0x0002
	104	#define FW_MATCH_SPECIFIER_ID 0x0004
	105	#define FW_MATCH_VERSION 0x0008
	106
	107	struct fw_device_id {
	108	u32 match_flags;
	109	u32 vendor;
	110	u32 model;
	111	u32 specifier_id;
	112	u32 version;
	113	void *driver_data;
	114	};
	115
	116	struct fw_driver {
	117	struct device_driver driver;
	118	/* Called when the parent device sits through a bus reset. */
	119	void (update) (struct fw_unit unit);
21ebcd12	120	const struct fw_device_id *id_table;
19a15b93 KH	121	};
	122
	123	static inline struct fw_driver *
	124	fw_driver(struct device_driver *drv)
	125	{
5e20c282	126	return container_of(drv, struct fw_driver, driver);
19a15b93 KH	127	}
19a15b93 KH	128
21ebcd12	129	extern const struct file_operations fw_device_ops;
19a15b93	130
687198bb	131	#endif /* __fw_device_h */