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 * $FreeBSD$ 36 */ 37 38 #ifndef _ICHIIC_IG4_VAR_H_ 39 #define _ICHIIC_IG4_VAR_H_ 40 41 #include "bus_if.h" 42 #include "device_if.h" 43 #include "pci_if.h" 44 #include "iicbus_if.h" 45 46 enum ig4_op { IG4_IDLE, IG4_READ, IG4_WRITE }; 47 enum ig4_vers { IG4_HASWELL, IG4_ATOM, IG4_SKYLAKE, IG4_APL }; 48 49 struct ig4_hw { 50 uint32_t ic_clock_rate; /* MHz */ 51 uint32_t sda_fall_time; /* nsec */ 52 uint32_t scl_fall_time; /* nsec */ 53 uint32_t sda_hold_time; /* nsec */ 54 int txfifo_depth; 55 int rxfifo_depth; 56 }; 57 58 struct ig4_cfg { 59 uint32_t version; 60 uint32_t bus_speed; 61 uint16_t ss_scl_hcnt; 62 uint16_t ss_scl_lcnt; 63 uint16_t ss_sda_hold; 64 uint16_t fs_scl_hcnt; 65 uint16_t fs_scl_lcnt; 66 uint16_t fs_sda_hold; 67 int txfifo_depth; 68 int rxfifo_depth; 69 }; 70 71 struct ig4iic_softc { 72 device_t dev; 73 device_t iicbus; 74 struct resource *regs_res; 75 int regs_rid; 76 struct resource *intr_res; 77 int intr_rid; 78 void *intr_handle; 79 int intr_type; 80 enum ig4_vers version; 81 enum ig4_op op; 82 struct ig4_cfg cfg; 83 int cmd; 84 uint32_t intr_mask; 85 int error; 86 uint8_t last_slave; 87 int platform_attached : 1; 88 int use_10bit : 1; 89 int slave_valid : 1; 90 int read_started : 1; 91 int write_started : 1; 92 int poll: 1; 93 94 /* 95 * Locking semantics: 96 * 97 * Functions implementing the icbus interface that interact 98 * with the controller acquire an exclusive lock on call_lock 99 * to prevent interleaving of calls to the interface. 100 * 101 * io_lock is used as condition variable to synchronize active process 102 * with the interrupt handler. It should not be used for tasks other 103 * than waiting for interrupt and passing parameters to and from 104 * it's handler. 105 */ 106 struct sx call_lock; 107 struct mtx io_lock; 108 }; 109 110 typedef struct ig4iic_softc ig4iic_softc_t; 111 112 extern devclass_t ig4iic_devclass; 113 114 /* Attach/Detach called from ig4iic_pci_*() */ 115 int ig4iic_attach(ig4iic_softc_t *sc); 116 int ig4iic_detach(ig4iic_softc_t *sc); 117 int ig4iic_suspend(ig4iic_softc_t *sc); 118 int ig4iic_resume(ig4iic_softc_t *sc); 119 120 /* iicbus methods */ 121 extern iicbus_transfer_t ig4iic_transfer; 122 extern iicbus_reset_t ig4iic_reset; 123 extern iicbus_callback_t ig4iic_callback; 124 125 #endif /* _ICHIIC_IG4_VAR_H_ */ 126