1 /*-
2  * Copyright (C) 2008 MARVELL INTERNATIONAL LTD.
3  * All rights reserved.
4  *
5  * Developed by Semihalf.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. Neither the name of MARVELL nor the names of contributors
16  *    may be used to endorse or promote products derived from this software
17  *    without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29  * SUCH DAMAGE.
30  *
31  * $FreeBSD: stable/12/sys/dev/iicbus/twsi/twsi.h 371132 2021-12-03 11:29:37Z avg $
32  */
33 
34 #ifndef _TWSI_H_
35 #define	_TWSI_H_
36 
37 #ifdef EXT_RESOURCES
38 #include <dev/extres/clk/clk.h>
39 #endif
40 
41 struct twsi_baud_rate {
42 	uint32_t	raw;
43 	int		param;
44 	int		m;
45 	int		n;
46 };
47 
48 struct twsi_softc {
49 	device_t	dev;
50 	struct resource	*res[2];
51 	struct mtx	mutex;
52 	device_t	iicbus;
53 	void *			intrhand;
54 	bool			have_intr;
55 #ifdef EXT_RESOURCES
56 	clk_t		clk_core;
57 	clk_t		clk_reg;
58 #endif
59 
60 	struct iic_msg		*msgs;
61 	uint32_t		nmsgs;
62 	uint32_t		msg_idx;
63 	uint16_t		sent_bytes;
64 	uint16_t		recv_bytes;
65 	int			transfer;
66 	int			error;
67 	int			debug;
68 	uint32_t		control_val;
69 	bool			iflag_w1c;
70 
71 	bus_size_t	reg_data;
72 	bus_size_t	reg_slave_addr;
73 	bus_size_t	reg_slave_ext_addr;
74 	bus_size_t	reg_control;
75 	bus_size_t	reg_status;
76 	bus_size_t	reg_baud_rate;
77 	bus_size_t	reg_soft_reset;
78 	struct twsi_baud_rate  baud_rate[IIC_FASTEST + 1];
79 };
80 
81 DECLARE_CLASS(twsi_driver);
82 
83 #define	TWSI_BAUD_RATE_PARAM(M,N)	((((M) << 3) | ((N) & 0x7)) & 0x7f)
84 
85 int twsi_attach(device_t);
86 int twsi_detach(device_t);
87 
88 #endif /* _TWSI_H_ */
89