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

/*
 *	w1.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_H
#define __W1_H

struct w1_reg_num
{
#if defined(__LITTLE_ENDIAN_BITFIELD)
	__u64	family:8,
		id:48,
		crc:8;
#elif defined(__BIG_ENDIAN_BITFIELD)
	__u64	crc:8,
		id:48,
		family:8;
#else
#error "Please fix <asm/byteorder.h>"
#endif
};

#ifdef __KERNEL__

#include <linux/completion.h>
#include <linux/device.h>
#include <linux/mutex.h>

#include "w1_family.h"

#define W1_MAXNAMELEN		32

#define W1_SEARCH		0xF0
#define W1_ALARM_SEARCH		0xEC
#define W1_CONVERT_TEMP		0x44
#define W1_SKIP_ROM		0xCC
#define W1_READ_SCRATCHPAD	0xBE
#define W1_READ_ROM		0x33
#define W1_READ_PSUPPLY		0xB4
#define W1_MATCH_ROM		0x55
#define W1_RESUME_CMD		0xA5

#define W1_SLAVE_ACTIVE		0

struct w1_slave
{
	struct module		*owner;
	unsigned char		name[W1_MAXNAMELEN];
	struct list_head	w1_slave_entry;
	struct w1_reg_num	reg_num;
	atomic_t		refcnt;
	u8			rom[9];
	int			ttl;
	unsigned long		flags;

	struct w1_master	*master;
	struct w1_family	*family;
	void			*family_data;
	struct device		dev;
	struct completion	released;
};

typedef void (*w1_slave_found_callback)(struct w1_master *, u64);


/**
 * Note: read_bit and write_bit are very low level functions and should only
 * be used with hardware that doesn't really support 1-wire operations,
 * like a parallel/serial port.
 * Either define read_bit and write_bit OR define, at minimum, touch_bit and
 * reset_bus.
 */
struct w1_bus_master
{
	/** the first parameter in all the functions below */
	void		*data;

	/**
	 * Sample the line level
	 * @return the level read (0 or 1)
	 */
	u8		(*read_bit)(void *);

	/** Sets the line level */
	void		(*write_bit)(void *, u8);

	/**
	 * touch_bit is the lowest-level function for devices that really
	 * support the 1-wire protocol.
	 * touch_bit(0) = write-0 cycle
	 * touch_bit(1) = write-1 / read cycle
	 * @return the bit read (0 or 1)
	 */
	u8		(*touch_bit)(void *, u8);

	/**
	 * Reads a bytes. Same as 8 touch_bit(1) calls.
	 * @return the byte read
	 */
	u8		(*read_byte)(void *);

	/**
	 * Writes a byte. Same as 8 touch_bit(x) calls.
	 */
	void		(*write_byte)(void *, u8);

	/**
	 * Same as a series of read_byte() calls
	 * @return the number of bytes read
	 */
	u8		(*read_block)(void *, u8 *, int);

	/** Same as a series of write_byte() calls */
	void		(*write_block)(void *, const u8 *, int);

	/**
	 * Combines two reads and a smart write for ROM searches
	 * @return bit0=Id bit1=comp_id bit2=dir_taken
	 */
	u8		(*triplet)(void *, u8);

	/**
	 * long write-0 with a read for the presence pulse detection
	 * @return -1=Error, 0=Device present, 1=No device present
	 */
	u8		(*reset_bus)(void *);

	/**
	 * Put out a strong pull-up pulse of the specified duration.
	 * @return -1=Error, 0=completed
	 */
	u8		(*set_pullup)(void *, int);

	/** Really nice hardware can handles the different types of ROM search
	 *  w1_master* is passed to the slave found callback.
	 *  u8 is search_type, W1_SEARCH or W1_ALARM_SEARCH
	 */
	void		(*search)(void *, struct w1_master *,
		u8, w1_slave_found_callback);
};

/**
 * enum w1_master_flags - bitfields used in w1_master.flags
 * @W1_ABORT_SEARCH: abort searching early on shutdown
 * @W1_WARN_MAX_COUNT: limit warning when the maximum count is reached
 */
enum w1_master_flags {
	W1_ABORT_SEARCH = 0,
	W1_WARN_MAX_COUNT = 1,
};

struct w1_master
{
	struct list_head	w1_master_entry;
	struct module		*owner;
	unsigned char		name[W1_MAXNAMELEN];
	struct list_head	slist;
	int			max_slave_count, slave_count;
	unsigned long		attempts;
	int			slave_ttl;
	int			initialized;
	u32			id;
	int			search_count;
	/* id to start searching on, to continue a search or 0 to restart */
	u64			search_id;

	atomic_t		refcnt;

	void			*priv;
	int			priv_size;

	/** 5V strong pullup enabled flag, 1 enabled, zero disabled. */
	int			enable_pullup;
	/** 5V strong pullup duration in milliseconds, zero disabled. */
	int			pullup_duration;

	long			flags;

	struct task_struct	*thread;
	struct mutex		mutex;
	struct mutex		bus_mutex;

	struct device_driver	*driver;
	struct device		dev;

	struct w1_bus_master	*bus_master;

	u32			seq;
};

int w1_create_master_attributes(struct w1_master *);
void w1_destroy_master_attributes(struct w1_master *master);
void w1_search(struct w1_master *dev, u8 search_type, w1_slave_found_callback cb);
void w1_search_devices(struct w1_master *dev, u8 search_type, w1_slave_found_callback cb);
struct w1_slave *w1_search_slave(struct w1_reg_num *id);
void w1_slave_found(struct w1_master *dev, u64 rn);
void w1_search_process_cb(struct w1_master *dev, u8 search_type,
	w1_slave_found_callback cb);
struct w1_master *w1_search_master_id(u32 id);

/* Disconnect and reconnect devices in the given family.  Used for finding
 * unclaimed devices after a family has been registered or releasing devices
 * after a family has been unregistered.  Set attach to 1 when a new family
 * has just been registered, to 0 when it has been unregistered.
 */
void w1_reconnect_slaves(struct w1_family *f, int attach);
void w1_slave_detach(struct w1_slave *sl);

u8 w1_triplet(struct w1_master *dev, int bdir);
void w1_write_8(struct w1_master *, u8);
u8 w1_read_8(struct w1_master *);
int w1_reset_bus(struct w1_master *);
u8 w1_calc_crc8(u8 *, int);
void w1_write_block(struct w1_master *, const u8 *, int);
void w1_touch_block(struct w1_master *, u8 *, int);
u8 w1_read_block(struct w1_master *, u8 *, int);
int w1_reset_select_slave(struct w1_slave *sl);
int w1_reset_resume_command(struct w1_master *);
void w1_next_pullup(struct w1_master *, int);

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

static inline struct w1_slave* kobj_to_w1_slave(struct kobject *kobj)
{
	return dev_to_w1_slave(container_of(kobj, struct device, kobj));
}

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

extern struct device_driver w1_master_driver;
extern struct device w1_master_device;
extern int w1_max_slave_count;
extern int w1_max_slave_ttl;
extern struct list_head w1_masters;
extern struct mutex w1_mlock;

extern int w1_process(void *);

#endif /* __KERNEL__ */

#endif /* __W1_H */
Commit	Line	Data
1da177e4	1	/*
7785925d	2	* w1.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_H
	23	#define __W1_H
	24
	25	struct w1_reg_num
	26	{
	27	#if defined(__LITTLE_ENDIAN_BITFIELD)
6b729861 EP	28	__u64 family:8,
	29	id:48,
	30	crc:8;
1da177e4 LT	31	#elif defined(__BIG_ENDIAN_BITFIELD)
	32	__u64 crc:8,
	33	id:48,
	34	family:8;
	35	#else
	36	#error "Please fix <asm/byteorder.h>"
	37	#endif
	38	};
	39
	40	#ifdef __KERNEL__
	41
	42	#include <linux/completion.h>
	43	#include <linux/device.h>
abd52a13	44	#include <linux/mutex.h>
1da177e4 LT	45
	46	#include "w1_family.h"
	47
	48	#define W1_MAXNAMELEN 32
1da177e4 LT	49
1da177e4 LT	50	#define W1_SEARCH 0xF0
12003375	51	#define W1_ALARM_SEARCH 0xEC
1da177e4 LT	52	#define W1_CONVERT_TEMP 0x44
	53	#define W1_SKIP_ROM 0xCC
	54	#define W1_READ_SCRATCHPAD 0xBE
	55	#define W1_READ_ROM 0x33
	56	#define W1_READ_PSUPPLY 0xB4
	57	#define W1_MATCH_ROM 0x55
67dfd54c	58	#define W1_RESUME_CMD 0xA5
1da177e4	59
f522d239	60	#define W1_SLAVE_ACTIVE 0
1da177e4 LT	61
	62	struct w1_slave
	63	{
	64	struct module *owner;
	65	unsigned char name[W1_MAXNAMELEN];
	66	struct list_head w1_slave_entry;
	67	struct w1_reg_num reg_num;
	68	atomic_t refcnt;
	69	u8 rom[9];
1da177e4	70	int ttl;
bb670937	71	unsigned long flags;
1da177e4 LT	72
1da177e4 LT	73	struct w1_master *master;
7785925d	74	struct w1_family *family;
a45f105a	75	void *family_data;
7785925d	76	struct device dev;
3aca692d	77	struct completion released;
1da177e4 LT	78	};
1da177e4 LT	79
c30c9b15	80	typedef void (w1_slave_found_callback)(struct w1_master , u64);
1da177e4	81
6b729861 EP	82
	83	/**
	84	* Note: read_bit and write_bit are very low level functions and should only
	85	* be used with hardware that doesn't really support 1-wire operations,
	86	* like a parallel/serial port.
	87	* Either define read_bit and write_bit OR define, at minimum, touch_bit and
	88	* reset_bus.
	89	*/
1da177e4 LT	90	struct w1_bus_master
1da177e4 LT	91	{
6b729861	92	/** the first parameter in all the functions below */
ccd69940	93	void *data;
6b729861 EP	94
	95	/**
	96	* Sample the line level
	97	* @return the level read (0 or 1)
	98	*/
ccd69940	99	u8 (read_bit)(void );
6b729861 EP	100
6b729861 EP	101	/** Sets the line level */
ccd69940	102	void (write_bit)(void , u8);
6b729861 EP	103
	104	/**
	105	* touch_bit is the lowest-level function for devices that really
	106	* support the 1-wire protocol.
	107	* touch_bit(0) = write-0 cycle
	108	* touch_bit(1) = write-1 / read cycle
	109	* @return the bit read (0 or 1)
	110	*/
ccd69940	111	u8 (touch_bit)(void , u8);
6b729861 EP	112
	113	/**
	114	* Reads a bytes. Same as 8 touch_bit(1) calls.
	115	* @return the byte read
	116	*/
ccd69940	117	u8 (read_byte)(void );
6b729861 EP	118
	119	/**
	120	* Writes a byte. Same as 8 touch_bit(x) calls.
	121	*/
ccd69940	122	void (write_byte)(void , u8);
6b729861 EP	123
	124	/**
	125	* Same as a series of read_byte() calls
	126	* @return the number of bytes read
	127	*/
ccd69940	128	u8 (read_block)(void , u8 *, int);
6b729861 EP	129
6b729861 EP	130	/** Same as a series of write_byte() calls */
ccd69940	131	void (write_block)(void , const u8 *, int);
6b729861 EP	132
	133	/**
	134	* Combines two reads and a smart write for ROM searches
	135	* @return bit0=Id bit1=comp_id bit2=dir_taken
	136	*/
ccd69940	137	u8 (triplet)(void , u8);
6b729861 EP	138
	139	/**
	140	* long write-0 with a read for the presence pulse detection
	141	* @return -1=Error, 0=Device present, 1=No device present
	142	*/
ccd69940	143	u8 (reset_bus)(void );
6b729861	144
6a158c0d DF	145	/**
	146	* Put out a strong pull-up pulse of the specified duration.
	147	* @return -1=Error, 0=completed
	148	*/
	149	u8 (set_pullup)(void , int);
	150
c30c9b15 DF	151	/** Really nice hardware can handles the different types of ROM search
c30c9b15 DF	152	* w1_master* is passed to the slave found callback.
3c6955e5	153	* u8 is search_type, W1_SEARCH or W1_ALARM_SEARCH
c30c9b15 DF	154	*/
	155	void (search)(void , struct w1_master *,
	156	u8, w1_slave_found_callback);
1da177e4 LT	157	};
1da177e4 LT	158
42105698 DF	159	/**
	160	* enum w1_master_flags - bitfields used in w1_master.flags
	161	* @W1_ABORT_SEARCH: abort searching early on shutdown
a1613056	162	* @W1_WARN_MAX_COUNT: limit warning when the maximum count is reached
42105698 DF	163	*/
	164	enum w1_master_flags {
	165	W1_ABORT_SEARCH = 0,
a1613056	166	W1_WARN_MAX_COUNT = 1,
42105698 DF	167	};
42105698 DF	168
1da177e4 LT	169	struct w1_master
	170	{
	171	struct list_head w1_master_entry;
	172	struct module *owner;
	173	unsigned char name[W1_MAXNAMELEN];
	174	struct list_head slist;
	175	int max_slave_count, slave_count;
	176	unsigned long attempts;
	177	int slave_ttl;
	178	int initialized;
	179	u32 id;
2a9d0c17	180	int search_count;
3c6955e5 DF	181	/* id to start searching on, to continue a search or 0 to restart */
3c6955e5 DF	182	u64 search_id;
1da177e4 LT	183
	184	atomic_t refcnt;
	185
	186	void *priv;
	187	int priv_size;
	188
6a158c0d DF	189	/** 5V strong pullup enabled flag, 1 enabled, zero disabled. */
	190	int enable_pullup;
	191	/** 5V strong pullup duration in milliseconds, zero disabled. */
	192	int pullup_duration;
	193
42105698 DF	194	long flags;
42105698 DF	195
674a396c	196	struct task_struct *thread;
abd52a13	197	struct mutex mutex;
b02f8bed	198	struct mutex bus_mutex;
1da177e4 LT	199
1da177e4 LT	200	struct device_driver *driver;
7785925d	201	struct device dev;
1da177e4 LT	202
	203	struct w1_bus_master *bus_master;
	204
12003375	205	u32 seq;
1da177e4 LT	206	};
	207
	208	int w1_create_master_attributes(struct w1_master *);
c30c9b15	209	void w1_destroy_master_attributes(struct w1_master *master);
12003375 EP	210	void w1_search(struct w1_master *dev, u8 search_type, w1_slave_found_callback cb);
	211	void w1_search_devices(struct w1_master *dev, u8 search_type, w1_slave_found_callback cb);
	212	struct w1_slave w1_search_slave(struct w1_reg_num id);
963bb101 DF	213	void w1_slave_found(struct w1_master *dev, u64 rn);
	214	void w1_search_process_cb(struct w1_master *dev, u8 search_type,
	215	w1_slave_found_callback cb);
12003375 EP	216	struct w1_master *w1_search_master_id(u32 id);
12003375 EP	217
c30c9b15 DF	218	/* Disconnect and reconnect devices in the given family. Used for finding
	219	* unclaimed devices after a family has been registered or releasing devices
	220	* after a family has been unregistered. Set attach to 1 when a new family
	221	* has just been registered, to 0 when it has been unregistered.
	222	*/
	223	void w1_reconnect_slaves(struct w1_family *f, int attach);
	224	void w1_slave_detach(struct w1_slave *sl);
	225
12003375 EP	226	u8 w1_triplet(struct w1_master *dev, int bdir);
12003375 EP	227	void w1_write_8(struct w1_master *, u8);
34e453d4	228	u8 w1_read_8(struct w1_master *);
12003375 EP	229	int w1_reset_bus(struct w1_master *);
	230	u8 w1_calc_crc8(u8 *, int);
	231	void w1_write_block(struct w1_master , const u8 , int);
9be62e0b	232	void w1_touch_block(struct w1_master , u8 , int);
12003375 EP	233	u8 w1_read_block(struct w1_master , u8 , int);
12003375 EP	234	int w1_reset_select_slave(struct w1_slave *sl);
67dfd54c	235	int w1_reset_resume_command(struct w1_master *);
6a158c0d	236	void w1_next_pullup(struct w1_master *, int);
1da177e4	237
db2d0008 EP	238	static inline struct w1_slave* dev_to_w1_slave(struct device *dev)
	239	{
	240	return container_of(dev, struct w1_slave, dev);
	241	}
	242
	243	static inline struct w1_slave* kobj_to_w1_slave(struct kobject *kobj)
	244	{
	245	return dev_to_w1_slave(container_of(kobj, struct device, kobj));
	246	}
	247
	248	static inline struct w1_master* dev_to_w1_master(struct device *dev)
	249	{
	250	return container_of(dev, struct w1_master, dev);
	251	}
	252
2c5bfdac	253	extern struct device_driver w1_master_driver;
2c5bfdac EP	254	extern struct device w1_master_device;
	255	extern int w1_max_slave_count;
	256	extern int w1_max_slave_ttl;
	257	extern struct list_head w1_masters;
	258	extern struct mutex w1_mlock;
	259
	260	extern int w1_process(void *);
	261
1da177e4 LT	262	#endif /* __KERNEL__ */
	263
	264	#endif /* __W1_H */