[deliverable/linux.git] / drivers / w1 / w1_family.h

/*
 *	w1_family.h
 *
 * Copyright (c) 2004 Evgeniy Polyakov <zbr@ioremap.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 __W1_FAMILY_H
#define __W1_FAMILY_H

#include <linux/types.h>
#include <linux/device.h>
#include <linux/atomic.h>

#define W1_FAMILY_DEFAULT	0
#define W1_FAMILY_BQ27000	0x01
#define W1_FAMILY_SMEM_01	0x01
#define W1_FAMILY_SMEM_81	0x81
#define W1_THERM_DS18S20 	0x10
#define W1_FAMILY_DS28E04	0x1C
#define W1_COUNTER_DS2423	0x1D
#define W1_THERM_DS1822  	0x22
#define W1_EEPROM_DS2433  	0x23
#define W1_THERM_DS18B20 	0x28
#define W1_FAMILY_DS2408	0x29
#define W1_EEPROM_DS2431	0x2D
#define W1_FAMILY_DS2760	0x30
#define W1_FAMILY_DS2780	0x32
#define W1_FAMILY_DS2413	0x3A
#define W1_FAMILY_DS2406	0x12
#define W1_THERM_DS1825		0x3B
#define W1_FAMILY_DS2781	0x3D
#define W1_THERM_DS28EA00	0x42

#define MAXNAMELEN		32

struct w1_slave;

/**
 * struct w1_family_ops - operations for a family type
 * @add_slave: add_slave
 * @remove_slave: remove_slave
 * @groups: sysfs group
 */
struct w1_family_ops
{
	int  (* add_slave)(struct w1_slave *);
	void (* remove_slave)(struct w1_slave *);
	const struct attribute_group **groups;
};

/**
 * struct w1_family - reference counted family structure.
 * @family_entry:	family linked list
 * @fid:		8 bit family identifier
 * @fops:		operations for this family
 * @refcnt:		reference counter
 */
struct w1_family
{
	struct list_head	family_entry;
	u8			fid;

	struct w1_family_ops	*fops;

	atomic_t		refcnt;
};

extern spinlock_t w1_flock;

void w1_family_put(struct w1_family *);
void __w1_family_get(struct w1_family *);
struct w1_family * w1_family_registered(u8);
void w1_unregister_family(struct w1_family *);
int w1_register_family(struct w1_family *);

/**
 * module_w1_driver() - Helper macro for registering a 1-Wire families
 * @__w1_family: w1_family struct
 *
 * Helper macro for 1-Wire families which do not do anything special in module
 * init/exit. This eliminates a lot of boilerplate. Each module may only
 * use this macro once, and calling it replaces module_init() and module_exit()
 */
#define module_w1_family(__w1_family) \
	module_driver(__w1_family, w1_register_family, \
			w1_unregister_family)

#endif /* __W1_FAMILY_H */
Commit	Line	Data
1da177e4	1	/*
7785925d	2	* w1_family.h
1da177e4	3	*
a8018766	4	* Copyright (c) 2004 Evgeniy Polyakov <zbr@ioremap.net>
7785925d	5	*
1da177e4 LT	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
	19	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	20	*/
	21
	22	#ifndef __W1_FAMILY_H
	23	#define __W1_FAMILY_H
	24
	25	#include <linux/types.h>
	26	#include <linux/device.h>
60063497	27	#include <linux/atomic.h>
1da177e4 LT	28
1da177e4 LT	29	#define W1_FAMILY_DEFAULT 0
4b7e4f82	30	#define W1_FAMILY_BQ27000 0x01
85e941cc EP	31	#define W1_FAMILY_SMEM_01 0x01
85e941cc EP	32	#define W1_FAMILY_SMEM_81 0x81
718a538f	33	#define W1_THERM_DS18S20 0x10
fbf7f7b4	34	#define W1_FAMILY_DS28E04 0x1C
17fecb55	35	#define W1_COUNTER_DS2423 0x1D
718a538f	36	#define W1_THERM_DS1822 0x22
a3d65f25	37	#define W1_EEPROM_DS2433 0x23
718a538f	38	#define W1_THERM_DS18B20 0x28
89610274	39	#define W1_FAMILY_DS2408 0x29
d8273674	40	#define W1_EEPROM_DS2431 0x2D
d7ce6d1d	41	#define W1_FAMILY_DS2760 0x30
275ac746	42	#define W1_FAMILY_DS2780 0x32
31b4ca3e	43	#define W1_FAMILY_DS2413 0x3A
94859308	44	#define W1_FAMILY_DS2406 0x12
f3261dfb	45	#define W1_THERM_DS1825 0x3B
fef37e9a	46	#define W1_FAMILY_DS2781 0x3D
f7b1371e	47	#define W1_THERM_DS28EA00 0x42
1da177e4 LT	48
	49	#define MAXNAMELEN 32
	50
d2a4ef6a EP	51	struct w1_slave;
d2a4ef6a EP	52
b3be177a DF	53	/**
	54	* struct w1_family_ops - operations for a family type
	55	* @add_slave: add_slave
	56	* @remove_slave: remove_slave
	57	* @groups: sysfs group
	58	*/
1da177e4 LT	59	struct w1_family_ops
1da177e4 LT	60	{
d2a4ef6a EP	61	int (* add_slave)(struct w1_slave *);
d2a4ef6a EP	62	void (* remove_slave)(struct w1_slave *);
36c27a65	63	const struct attribute_group **groups;
1da177e4 LT	64	};
1da177e4 LT	65
b3be177a DF	66	/**
	67	* struct w1_family - reference counted family structure.
	68	* @family_entry: family linked list
	69	* @fid: 8 bit family identifier
	70	* @fops: operations for this family
	71	* @refcnt: reference counter
	72	*/
1da177e4 LT	73	struct w1_family
	74	{
	75	struct list_head family_entry;
	76	u8 fid;
7785925d	77
1da177e4	78	struct w1_family_ops *fops;
7785925d	79
1da177e4	80	atomic_t refcnt;
1da177e4 LT	81	};
	82
	83	extern spinlock_t w1_flock;
	84
1da177e4 LT	85	void w1_family_put(struct w1_family *);
1da177e4 LT	86	void __w1_family_get(struct w1_family *);
1da177e4 LT	87	struct w1_family * w1_family_registered(u8);
	88	void w1_unregister_family(struct w1_family *);
	89	int w1_register_family(struct w1_family *);
	90
939fc832 AD	91	/**
	92	* module_w1_driver() - Helper macro for registering a 1-Wire families
	93	* @__w1_family: w1_family struct
	94	*
	95	* Helper macro for 1-Wire families which do not do anything special in module
	96	* init/exit. This eliminates a lot of boilerplate. Each module may only
	97	* use this macro once, and calling it replaces module_init() and module_exit()
	98	*/
	99	#define module_w1_family(__w1_family) \
	100	module_driver(__w1_family, w1_register_family, \
	101	w1_unregister_family)
	102
1da177e4	103	#endif /* __W1_FAMILY_H */