1/*
  2 *	w1_family.h
  3 *
  4 * Copyright (c) 2004 Evgeniy Polyakov <zbr@ioremap.net>
  5 *
  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>
 27#include <linux/atomic.h>
 28
 29#define W1_FAMILY_DEFAULT	0
 30#define W1_FAMILY_BQ27000	0x01
 31#define W1_FAMILY_SMEM_01	0x01
 32#define W1_FAMILY_SMEM_81	0x81
 33#define W1_THERM_DS18S20 	0x10
 34#define W1_FAMILY_DS28E04	0x1C
 35#define W1_COUNTER_DS2423	0x1D
 36#define W1_THERM_DS1822  	0x22
 37#define W1_EEPROM_DS2433  	0x23
 38#define W1_THERM_DS18B20 	0x28
 39#define W1_FAMILY_DS2408	0x29
 40#define W1_EEPROM_DS2431	0x2D
 41#define W1_FAMILY_DS2760	0x30
 42#define W1_FAMILY_DS2780	0x32
 43#define W1_FAMILY_DS2413	0x3A
 44#define W1_FAMILY_DS2406	0x12
 45#define W1_THERM_DS1825		0x3B
 46#define W1_FAMILY_DS2781	0x3D
 47#define W1_THERM_DS28EA00	0x42
 48
 49#define MAXNAMELEN		32
 50
 51struct w1_slave;
 52
 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 */
 59struct w1_family_ops
 60{
 61	int  (* add_slave)(struct w1_slave *);
 62	void (* remove_slave)(struct w1_slave *);
 63	const struct attribute_group **groups;
 64};
 65
 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 */
 73struct w1_family
 74{
 75	struct list_head	family_entry;
 76	u8			fid;
 77
 78	struct w1_family_ops	*fops;
 79
 80	atomic_t		refcnt;
 81};
 82
 83extern spinlock_t w1_flock;
 84
 85void w1_family_put(struct w1_family *);
 86void __w1_family_get(struct w1_family *);
 87struct w1_family * w1_family_registered(u8);
 88void w1_unregister_family(struct w1_family *);
 89int w1_register_family(struct w1_family *);
 90
 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
103#endif /* __W1_FAMILY_H */