w1.h 4.4 KB
Newer Older
L
Linus Torvalds 已提交
1
/*
E
Evgeniy Polyakov 已提交
2
 *	w1.h
L
Linus Torvalds 已提交
3 4
 *
 * Copyright (c) 2004 Evgeniy Polyakov <johnpol@2ka.mipt.ru>
E
Evgeniy Polyakov 已提交
5
 *
L
Linus Torvalds 已提交
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
 *
 * 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)
28 29 30
	__u64	family:8,
		id:48,
		crc:8;
L
Linus Torvalds 已提交
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76
#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;
E
Evgeniy Polyakov 已提交
77 78 79
	struct w1_family	*family;
	struct device		dev;
	struct completion	dev_released;
L
Linus Torvalds 已提交
80

E
Evgeniy Polyakov 已提交
81
	struct bin_attribute	attr_bin;
82
	struct device_attribute	attr_name;
L
Linus Torvalds 已提交
83 84 85 86
};

typedef void (* w1_slave_found_callback)(unsigned long, u64);

87 88 89 90 91 92 93 94

/**
 * 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.
 */
L
Linus Torvalds 已提交
95 96
struct w1_bus_master
{
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
	/** 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);
L
Linus Torvalds 已提交
152 153
};

154 155 156
#define W1_MASTER_NEED_EXIT		0
#define W1_MASTER_NEED_RECONNECT	1

L
Linus Torvalds 已提交
157 158 159 160 161 162 163 164 165 166 167
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;
168
	int			search_count;
L
Linus Torvalds 已提交
169 170 171 172 173 174

	atomic_t		refcnt;

	void			*priv;
	int			priv_size;

175 176
	long			flags;

L
Linus Torvalds 已提交
177
	pid_t			kpid;
E
Evgeniy Polyakov 已提交
178
	struct semaphore	mutex;
L
Linus Torvalds 已提交
179 180

	struct device_driver	*driver;
E
Evgeniy Polyakov 已提交
181 182 183
	struct device		dev;
	struct completion	dev_released;
	struct completion	dev_exited;
L
Linus Torvalds 已提交
184 185 186 187

	struct w1_bus_master	*bus_master;

	u32			seq, groups;
E
Evgeniy Polyakov 已提交
188
	struct sock		*nls;
L
Linus Torvalds 已提交
189 190 191
};

int w1_create_master_attributes(struct w1_master *);
192
void w1_search(struct w1_master *dev, w1_slave_found_callback cb);
L
Linus Torvalds 已提交
193 194 195 196

#endif /* __KERNEL__ */

#endif /* __W1_H */