xref: /freebsd/sys/dev/ow/owll.h (revision ae1f3df43466466a21c7da0df93ecb58a3e53d74)
1*ae1f3df4SWarner Losh /*-
2*ae1f3df4SWarner Losh  * Copyright (c) 2015 M. Warner Losh <imp@freebsd.org>
3*ae1f3df4SWarner Losh  * All rights reserved.
4*ae1f3df4SWarner Losh  *
5*ae1f3df4SWarner Losh  * Redistribution and use in source and binary forms, with or without
6*ae1f3df4SWarner Losh  * modification, are permitted provided that the following conditions
7*ae1f3df4SWarner Losh  * are met:
8*ae1f3df4SWarner Losh  * 1. Redistributions of source code must retain the above copyright
9*ae1f3df4SWarner Losh  *    notice unmodified, this list of conditions, and the following
10*ae1f3df4SWarner Losh  *    disclaimer.
11*ae1f3df4SWarner Losh  * 2. Redistributions in binary form must reproduce the above copyright
12*ae1f3df4SWarner Losh  *    notice, this list of conditions and the following disclaimer in the
13*ae1f3df4SWarner Losh  *    documentation and/or other materials provided with the distribution.
14*ae1f3df4SWarner Losh  *
15*ae1f3df4SWarner Losh  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16*ae1f3df4SWarner Losh  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17*ae1f3df4SWarner Losh  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18*ae1f3df4SWarner Losh  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19*ae1f3df4SWarner Losh  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20*ae1f3df4SWarner Losh  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21*ae1f3df4SWarner Losh  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22*ae1f3df4SWarner Losh  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23*ae1f3df4SWarner Losh  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24*ae1f3df4SWarner Losh  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25*ae1f3df4SWarner Losh  *
26*ae1f3df4SWarner Losh  * $FreeBSD$
27*ae1f3df4SWarner Losh  */
28*ae1f3df4SWarner Losh 
29*ae1f3df4SWarner Losh #ifndef DEV_OW_OWLL_H
30*ae1f3df4SWarner Losh #define DEV_OW_OWLL_H 1
31*ae1f3df4SWarner Losh 
32*ae1f3df4SWarner Losh /*
33*ae1f3df4SWarner Losh  * Generalized parameters for the mode of operation in the bus. All units
34*ae1f3df4SWarner Losh  * are in nanoseconds, and assume that all timings are < 4s.
35*ae1f3df4SWarner Losh  * See owll_if.m for timings, and refer to AN937 for details.
36*ae1f3df4SWarner Losh  */
37*ae1f3df4SWarner Losh struct ow_timing
38*ae1f3df4SWarner Losh {
39*ae1f3df4SWarner Losh 	uint32_t	t_slot;		/* Slot time */
40*ae1f3df4SWarner Losh 	uint32_t	t_low0;		/* Time low for a 0 bit. */
41*ae1f3df4SWarner Losh 	uint32_t	t_low1;		/* Time low for a 1 bit. */
42*ae1f3df4SWarner Losh 	uint32_t	t_lowr;		/* Time slave holds line down per bit */
43*ae1f3df4SWarner Losh 	uint32_t	t_release;	/* Time after t_rdv to float high */
44*ae1f3df4SWarner Losh 	uint32_t	t_rec;		/* After sample before M low */
45*ae1f3df4SWarner Losh 	uint32_t	t_rdv;		/* Time to poll the bit after M low */
46*ae1f3df4SWarner Losh 	uint32_t	t_rstl;		/* Time M low on reset */
47*ae1f3df4SWarner Losh 	uint32_t	t_rsth;		/* Time M high on reset */
48*ae1f3df4SWarner Losh 	uint32_t	t_pdl;		/* Time S low on reset */
49*ae1f3df4SWarner Losh 	uint32_t	t_pdh;		/* Time R high after M low on reset */
50*ae1f3df4SWarner Losh };
51*ae1f3df4SWarner Losh 
52*ae1f3df4SWarner Losh #include "owll_if.h"
53*ae1f3df4SWarner Losh 
54*ae1f3df4SWarner Losh #endif /* DEV_OW_OWLL_H */
55