xref: /freebsd/sys/dev/iicbus/controller/vybrid/vf_i2c.h (revision 5ca8e32633c4ffbbcd6762e5888b6a4ba0708c6c)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2014 Ruslan Bukin <br@bsdpad.com>
5  * Copyright (c) 2024 Pierre-Luc Drouin <pldrouin@pldrouin.net>
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  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 /*
30  * Vybrid Family Inter-Integrated Circuit (I2C)
31  * Chapter 48, Vybrid Reference Manual, Rev. 5, 07/2013
32  *
33  * The current implementation is based on the original driver by Ruslan Bukin,
34  * later modified by Dawid Górecki, and split into FDT and ACPI drivers by Val
35  * Packett.
36  */
37 
38 #ifndef __VF_I2C_H__
39 #define __VF_I2C_H__
40 
41 #include "opt_acpi.h"
42 #include "opt_platform.h"
43 
44 #ifdef FDT
45 #include <dev/clk/clk.h>
46 #endif
47 
48 #define VF_I2C_DEVSTR "Vybrid Family Inter-Integrated Circuit (I2C)"
49 
50 #define HW_MVF600       0x01
51 #define HW_VF610        0x02
52 
53 #define MVF600_DIV_REG	0x14
54 
55 #define VF_I2C_DEFAULT_BUS_SPEED	100000
56 
57 struct vf_i2c_softc {
58 	struct resource         *res[2];
59 	bus_space_tag_t         bst;
60 	bus_space_handle_t      bsh;
61 	uint32_t                freq;
62 	device_t                dev;
63 	device_t                iicbus;
64 	struct mtx              mutex;
65 	uintptr_t               hwtype;
66 #ifdef FDT
67 	clk_t                   clock;
68 #endif
69 };
70 
71 extern driver_t vf_i2c_driver;
72 
73 device_attach_t vf_i2c_attach_common;
74 
75 #endif /* !__VF_I2C_H__ */
76