onewirevar.h revision 1.3 
1/*	$OpenBSD: onewirevar.h,v 1.3 2006/09/30 15:52:21 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	void	(*bus_read_block)(void *, void *, int);
35	void	(*bus_write_block)(void *, const void *, int);
36	int	(*bus_triplet)(void *, int);
37	void	(*bus_matchrom)(void *, u_int64_t);
38};
39
40/* Bus methods */
41int		onewire_lock(void *, int);
42void		onewire_unlock(void *);
43
44int		onewire_reset(void *);
45int		onewire_bit(void *, int);
46int		onewire_read_byte(void *);
47void		onewire_write_byte(void *, int);
48void		onewire_read_block(void *, void *, int);
49void		onewire_write_block(void *, const void *, int);
50int		onewire_triplet(void *, int);
51void		onewire_matchrom(void *, u_int64_t);
52
53#define ONEWIRE_NOWAIT		0x0001
54
55/* Bus attachment */
56struct onewirebus_attach_args {
57	struct onewire_bus *	oba_bus;
58};
59
60int	onewirebus_print(void *, const char *);
61
62/* Device attachment */
63struct onewire_attach_args {
64	void *			oa_onewire;
65	u_int64_t		oa_rom;
66};
67
68/* Family matching */
69struct onewire_matchfam {
70	int om_type;
71};
72
73/* Miscellaneous routines */
74int		onewire_crc(const void *, int);
75const char *	onewire_famname(int);
76int		onewire_matchbyfam(struct onewire_attach_args *,
77		    const struct onewire_matchfam *, int);
78
79/* Bus bit-banging */
80struct onewire_bbops {
81	void	(*bb_rx)(void *);
82	void	(*bb_tx)(void *);
83	int	(*bb_get)(void *);
84	void	(*bb_set)(void *, int);
85};
86
87int		onewire_bb_reset(const struct onewire_bbops *, void *);
88int		onewire_bb_bit(const struct onewire_bbops *, void *, int);
89
90#endif	/* !_DEV_ONEWIRE_ONEWIREVAR_H_ */
91