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

/*
 *	w1.h
 *
 * Copyright (c) 2004 Evgeniy Polyakov <johnpol@2ka.mipt.ru>
 *
 *
 * 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 <net/sock.h>

#include <asm/semaphore.h>

#include "w1_family.h"

#define W1_MAXNAMELEN		32
#define W1_SLAVE_DATA_SIZE	128

#define W1_SEARCH		0xF0
#define W1_CONDITIONAL_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_SLAVE_ACTIVE		(1<<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];
	u32			flags;
	int			ttl;

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

typedef void (* w1_slave_found_callback)(unsigned long, 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 */
	unsigned long	data;

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

	/** Sets the line level */
	void		(*write_bit)(unsigned long, 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)(unsigned long, u8);

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

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

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

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

	/**
	 * Combines two reads and a smart write for ROM searches
	 * @return bit0=Id bit1=comp_id bit2=dir_taken
	 */
	u8		(*triplet)(unsigned long, 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)(unsigned long);

	/** Really nice hardware can handles the ROM searches */
	void		(*search)(unsigned long, w1_slave_found_callback);
};

#define W1_MASTER_NEED_EXIT		0
#define W1_MASTER_NEED_RECONNECT	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;

	atomic_t		refcnt;

	void			*priv;
	int			priv_size;

	long			flags;

	pid_t			kpid;
	struct semaphore	mutex;

	struct device_driver	*driver;
	struct device		dev;
	struct completion	dev_exited;

	struct w1_bus_master	*bus_master;

	u32			seq, groups;
	struct sock		*nls;
};

int w1_create_master_attributes(struct w1_master *);
void w1_search(struct w1_master *dev, w1_slave_found_callback cb);

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

#endif /* __KERNEL__ */

#endif /* __W1_H */
Commit	Line	Data
1da177e4	1	/*
7785925d	2	* w1.h
1da177e4 LT	3	*
1da177e4 LT	4	* Copyright (c) 2004 Evgeniy Polyakov <johnpol@2ka.mipt.ru>
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>
	44
	45	#include <net/sock.h>
	46
	47	#include <asm/semaphore.h>
	48
	49	#include "w1_family.h"
	50
	51	#define W1_MAXNAMELEN 32
	52	#define W1_SLAVE_DATA_SIZE 128
	53
	54	#define W1_SEARCH 0xF0
	55	#define W1_CONDITIONAL_SEARCH 0xEC
	56	#define W1_CONVERT_TEMP 0x44
	57	#define W1_SKIP_ROM 0xCC
	58	#define W1_READ_SCRATCHPAD 0xBE
	59	#define W1_READ_ROM 0x33
	60	#define W1_READ_PSUPPLY 0xB4
	61	#define W1_MATCH_ROM 0x55
	62
	63	#define W1_SLAVE_ACTIVE (1<<0)
	64
	65	struct w1_slave
	66	{
	67	struct module *owner;
	68	unsigned char name[W1_MAXNAMELEN];
	69	struct list_head w1_slave_entry;
	70	struct w1_reg_num reg_num;
	71	atomic_t refcnt;
	72	u8 rom[9];
	73	u32 flags;
	74	int ttl;
	75
	76	struct w1_master *master;
7785925d	77	struct w1_family *family;
a45f105a	78	void *family_data;
7785925d	79	struct device dev;
3aca692d	80	struct completion released;
1da177e4 LT	81	};
	82
	83	typedef void (* w1_slave_found_callback)(unsigned long, u64);
	84
6b729861 EP	85
	86	/**
	87	* Note: read_bit and write_bit are very low level functions and should only
	88	* be used with hardware that doesn't really support 1-wire operations,
	89	* like a parallel/serial port.
	90	* Either define read_bit and write_bit OR define, at minimum, touch_bit and
	91	* reset_bus.
	92	*/
1da177e4 LT	93	struct w1_bus_master
1da177e4 LT	94	{
6b729861 EP	95	/** the first parameter in all the functions below */
	96	unsigned long data;
	97
	98	/**
	99	* Sample the line level
	100	* @return the level read (0 or 1)
	101	*/
	102	u8 (*read_bit)(unsigned long);
	103
	104	/** Sets the line level */
	105	void (*write_bit)(unsigned long, u8);
	106
	107	/**
	108	* touch_bit is the lowest-level function for devices that really
	109	* support the 1-wire protocol.
	110	* touch_bit(0) = write-0 cycle
	111	* touch_bit(1) = write-1 / read cycle
	112	* @return the bit read (0 or 1)
	113	*/
	114	u8 (*touch_bit)(unsigned long, u8);
	115
	116	/**
	117	* Reads a bytes. Same as 8 touch_bit(1) calls.
	118	* @return the byte read
	119	*/
	120	u8 (*read_byte)(unsigned long);
	121
	122	/**
	123	* Writes a byte. Same as 8 touch_bit(x) calls.
	124	*/
	125	void (*write_byte)(unsigned long, u8);
	126
	127	/**
	128	* Same as a series of read_byte() calls
	129	* @return the number of bytes read
	130	*/
	131	u8 (read_block)(unsigned long, u8 , int);
	132
	133	/** Same as a series of write_byte() calls */
	134	void (write_block)(unsigned long, const u8 , int);
	135
	136	/**
	137	* Combines two reads and a smart write for ROM searches
	138	* @return bit0=Id bit1=comp_id bit2=dir_taken
	139	*/
	140	u8 (*triplet)(unsigned long, u8);
	141
	142	/**
	143	* long write-0 with a read for the presence pulse detection
	144	* @return -1=Error, 0=Device present, 1=No device present
	145	*/
	146	u8 (*reset_bus)(unsigned long);
	147
	148	/** Really nice hardware can handles the ROM searches */
	149	void (*search)(unsigned long, w1_slave_found_callback);
1da177e4 LT	150	};
1da177e4 LT	151
6adf87bd EP	152	#define W1_MASTER_NEED_EXIT 0
	153	#define W1_MASTER_NEED_RECONNECT 1
	154
1da177e4 LT	155	struct w1_master
	156	{
	157	struct list_head w1_master_entry;
	158	struct module *owner;
	159	unsigned char name[W1_MAXNAMELEN];
	160	struct list_head slist;
	161	int max_slave_count, slave_count;
	162	unsigned long attempts;
	163	int slave_ttl;
	164	int initialized;
	165	u32 id;
2a9d0c17	166	int search_count;
1da177e4 LT	167
	168	atomic_t refcnt;
	169
	170	void *priv;
	171	int priv_size;
	172
6adf87bd EP	173	long flags;
6adf87bd EP	174
1da177e4	175	pid_t kpid;
7785925d	176	struct semaphore mutex;
1da177e4 LT	177
1da177e4 LT	178	struct device_driver *driver;
7785925d	179	struct device dev;
7785925d	180	struct completion dev_exited;
1da177e4 LT	181
	182	struct w1_bus_master *bus_master;
	183
	184	u32 seq, groups;
7785925d	185	struct sock *nls;
1da177e4 LT	186	};
	187
	188	int w1_create_master_attributes(struct w1_master *);
6b729861	189	void w1_search(struct w1_master *dev, w1_slave_found_callback cb);
1da177e4	190
db2d0008 EP	191	static inline struct w1_slave* dev_to_w1_slave(struct device *dev)
	192	{
	193	return container_of(dev, struct w1_slave, dev);
	194	}
	195
	196	static inline struct w1_slave* kobj_to_w1_slave(struct kobject *kobj)
	197	{
	198	return dev_to_w1_slave(container_of(kobj, struct device, kobj));
	199	}
	200
	201	static inline struct w1_master* dev_to_w1_master(struct device *dev)
	202	{
	203	return container_of(dev, struct w1_master, dev);
	204	}
	205
1da177e4 LT	206	#endif /* __KERNEL__ */
	207
	208	#endif /* __W1_H */