[mirror_ubuntu-artful-kernel.git] / drivers / w1 / 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.
 */

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