onewirevar.h revision 1.1 
1/*	$OpenBSD: onewirevar.h,v 1.1 2006/03/04 16:27:03 grange Exp $	*/
2
3/*
4 * Copyright (c) 2006 Alexander Yurchenko <grange@openbsd.org>
5 *
6 * Permission to use, copy, modify, and distribute this software for any
7 * purpose with or without fee is hereby granted, provided that the above
8 * copyright notice and this permission notice appear in all copies.
9 *
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 */
18
19#ifndef _DEV_ONEWIRE_ONEWIREVAR_H_
20#define _DEV_ONEWIRE_ONEWIREVAR_H_
21
22/*
23 * 1-Wire bus interface.
24 */
25
26/* Bus master interface */
27struct onewire_bus {
28	void *	bus_cookie;
29
30	int	(*bus_reset)(void *);
31	int	(*bus_bit)(void *, int);
32	int	(*bus_read_byte)(void *);
33	void	(*bus_write_byte)(void *, int);
34	int	(*bus_triplet)(void *, int);
35};
36
37/* Bus methods */
38int		onewire_lock(void *, int);
39void		onewire_unlock(void *);
40int		onewire_reset(void *);
41int		onewire_bit(void *, int);
42int		onewire_read_byte(void *);
43void		onewire_write_byte(void *, int);
44int		onewire_triplet(void *, int);
45void		onewire_read_block(void *, void *, int);
46void		onewire_write_block(void *, const void *, int);
47void		onewire_matchrom(void *, u_int64_t);
48
49#define ONEWIRE_NOWAIT		0x0001
50
51/* Bus attachment */
52struct onewirebus_attach_args {
53	struct onewire_bus *	oba_bus;
54};
55
56int	onewirebus_print(void *, const char *);
57
58/* Device attachment */
59struct onewire_attach_args {
60	void *			oa_onewire;
61	u_int64_t		oa_rom;
62};
63
64/* Family matching */
65struct onewire_matchfam {
66	int om_type;
67};
68
69/* Miscellaneous routines */
70int		onewire_crc(const void *, int);
71const char *	onewire_famname(int);
72int		onewire_matchbyfam(struct onewire_attach_args *,
73		    const struct onewire_matchfam *, int);
74
75/* Bus bit-banging */
76struct onewire_bbops {
77	void	(*bb_rx)(void *);
78	void	(*bb_tx)(void *);
79	int	(*bb_get)(void *);
80	void	(*bb_set)(void *, int);
81};
82
83int		onewire_bb_reset(const struct onewire_bbops *, void *);
84int		onewire_bb_bit(const struct onewire_bbops *, void *, int);
85
86#endif	/* !_DEV_ONEWIRE_ONEWIREVAR_H_ */
87