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