xref: /freebsd/sys/dev/iicbus/controller/twsi/twsi.h (revision e5b786625f7f82a1fa91e41823332459ea5550f9)
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 
32 #ifndef _TWSI_H_
33 #define	_TWSI_H_
34 
35 #include <dev/extres/clk/clk.h>
36 
37 struct twsi_baud_rate {
38 	uint32_t	raw;
39 	int		param;
40 	int		m;
41 	int		n;
42 };
43 
44 struct twsi_softc {
45 	device_t	dev;
46 	struct resource	*res[2];
47 	struct mtx	mutex;
48 	device_t	iicbus;
49 	clk_t		clk_core;
50 	clk_t		clk_reg;
51 	void *			intrhand;
52 	bool			have_intr;
53 
54 	struct iic_msg		*msgs;
55 	uint32_t		nmsgs;
56 	uint32_t		msg_idx;
57 	uint16_t		sent_bytes;
58 	uint16_t		recv_bytes;
59 	int			transfer;
60 	int			error;
61 	int			debug;
62 	uint32_t		control_val;
63 	bool			iflag_w1c;
64 
65 	bus_size_t	reg_data;
66 	bus_size_t	reg_slave_addr;
67 	bus_size_t	reg_slave_ext_addr;
68 	bus_size_t	reg_control;
69 	bus_size_t	reg_status;
70 	bus_size_t	reg_baud_rate;
71 	bus_size_t	reg_soft_reset;
72 	struct twsi_baud_rate  baud_rate[IIC_FASTEST + 1];
73 };
74 
75 DECLARE_CLASS(twsi_driver);
76 
77 #define	TWSI_BAUD_RATE_PARAM(M,N)	((((M) << 3) | ((N) & 0x7)) & 0x7f)
78 
79 int twsi_attach(device_t);
80 int twsi_detach(device_t);
81 
82 #endif /* _TWSI_H_ */
83