1 /* 2 * Copyright (c) 2014 The DragonFly Project. All rights reserved. 3 * 4 * This code is derived from software contributed to The DragonFly Project 5 * by Matthew Dillon <dillon@backplane.com> and was subsequently ported 6 * to FreeBSD by Michael Gmelin <freebsd@grem.de> 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 12 * 1. Redistributions of source code must retain the above copyright 13 * notice, this list of conditions and the following disclaimer. 14 * 2. Redistributions in binary form must reproduce the above copyright 15 * notice, this list of conditions and the following disclaimer in 16 * the documentation and/or other materials provided with the 17 * distribution. 18 * 3. Neither the name of The DragonFly Project nor the names of its 19 * contributors may be used to endorse or promote products derived 20 * from this software without specific, prior written permission. 21 * 22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 23 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 24 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 25 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 26 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 27 * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, 28 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 29 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 30 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 31 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 32 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 33 * SUCH DAMAGE. 34 */ 35 36 #ifndef _ICHIIC_IG4_VAR_H_ 37 #define _ICHIIC_IG4_VAR_H_ 38 39 #include "bus_if.h" 40 #include "device_if.h" 41 #include "pci_if.h" 42 #include "iicbus_if.h" 43 44 enum ig4_vers { 45 IG4_HASWELL, 46 IG4_ATOM, 47 IG4_SKYLAKE, 48 IG4_APL, 49 IG4_CANNONLAKE, 50 IG4_TIGERLAKE, 51 IG4_GEMINILAKE 52 }; 53 54 /* Controller has additional registers */ 55 #define IG4_HAS_ADDREGS(vers) ((vers) >= IG4_SKYLAKE) 56 57 struct ig4_hw { 58 uint32_t ic_clock_rate; /* MHz */ 59 uint32_t sda_fall_time; /* nsec */ 60 uint32_t scl_fall_time; /* nsec */ 61 uint32_t sda_hold_time; /* nsec */ 62 int txfifo_depth; 63 int rxfifo_depth; 64 }; 65 66 struct ig4_cfg { 67 uint32_t version; 68 uint32_t bus_speed; 69 uint16_t ss_scl_hcnt; 70 uint16_t ss_scl_lcnt; 71 uint16_t ss_sda_hold; 72 uint16_t fs_scl_hcnt; 73 uint16_t fs_scl_lcnt; 74 uint16_t fs_sda_hold; 75 int txfifo_depth; 76 int rxfifo_depth; 77 }; 78 79 struct ig4iic_softc { 80 device_t dev; 81 device_t iicbus; 82 struct resource *regs_res; 83 int regs_rid; 84 struct resource *intr_res; 85 int intr_rid; 86 void *intr_handle; 87 int intr_type; 88 enum ig4_vers version; 89 struct ig4_cfg cfg; 90 uint32_t intr_mask; 91 uint8_t last_slave; 92 bool platform_attached : 1; 93 bool use_10bit : 1; 94 bool slave_valid : 1; 95 bool poll: 1; 96 97 /* 98 * Locking semantics: 99 * 100 * Functions implementing the icbus interface that interact 101 * with the controller acquire an exclusive lock on call_lock 102 * to prevent interleaving of calls to the interface. 103 * 104 * io_lock is used as condition variable to synchronize active process 105 * with the interrupt handler. It should not be used for tasks other 106 * than waiting for interrupt and passing parameters to and from 107 * it's handler. 108 */ 109 struct sx call_lock; 110 struct mtx io_lock; 111 }; 112 113 typedef struct ig4iic_softc ig4iic_softc_t; 114 115 /* Attach/Detach called from ig4iic_pci_*() */ 116 int ig4iic_attach(ig4iic_softc_t *sc); 117 int ig4iic_detach(ig4iic_softc_t *sc); 118 int ig4iic_suspend(ig4iic_softc_t *sc); 119 int ig4iic_resume(ig4iic_softc_t *sc); 120 121 /* iicbus methods */ 122 extern iicbus_transfer_t ig4iic_transfer; 123 extern iicbus_reset_t ig4iic_reset; 124 extern iicbus_callback_t ig4iic_callback; 125 126 #endif /* _ICHIIC_IG4_VAR_H_ */ 127