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 * Originally based on Chapter 48, Vybrid Reference Manual, Rev. 5, 07/2013 32 * Currently based on Chapter 21, LX2160A Reference Manual, Rev. 1, 10/2021 33 * 34 * The current implementation is based on the original driver by Ruslan Bukin, 35 * later modified by Dawid Górecki, and split into FDT and ACPI drivers by Val 36 * Packett. 37 */ 38 39 #ifndef __VF_I2C_H__ 40 #define __VF_I2C_H__ 41 42 #include "opt_acpi.h" 43 #include "opt_platform.h" 44 45 #ifdef FDT 46 #include <dev/clk/clk.h> 47 #endif 48 49 #define VF_I2C_DEVSTR "Vybrid Family Inter-Integrated Circuit (I2C)" 50 51 #define HW_MVF600 0x01 52 #define HW_VF610 0x02 53 54 #define MVF600_DIV_REG 0x14 55 56 #define VF_I2C_DEFAULT_BUS_SPEED 100000 57 58 struct vf_i2c_softc { 59 struct resource *res[2]; 60 bus_space_tag_t bst; 61 bus_space_handle_t bsh; 62 uint32_t freq; 63 device_t dev; 64 device_t iicbus; 65 struct mtx mutex; 66 uintptr_t hwtype; 67 #ifdef FDT 68 clk_t clock; 69 #endif 70 }; 71 72 extern driver_t vf_i2c_driver; 73 74 device_attach_t vf_i2c_attach_common; 75 76 #endif /* !__VF_I2C_H__ */ 77