xref: /freebsd/sys/dev/ichiic/ig4_var.h (revision 5f0216bd883edee71bf81051e3c20505e4820903)
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 _BUS_SMBUS_INTELGEN4_IG4_VAR_H_
39 #define _BUS_SMBUS_INTELGEN4_IG4_VAR_H_
40 
41 #include "bus_if.h"
42 #include "device_if.h"
43 #include "pci_if.h"
44 #include "smbus_if.h"
45 
46 #define IG4_RBUFSIZE	128
47 #define IG4_RBUFMASK	(IG4_RBUFSIZE - 1)
48 
49 enum ig4_op { IG4_IDLE, IG4_READ, IG4_WRITE };
50 
51 struct ig4iic_softc {
52 	device_t	dev;
53 	struct		intr_config_hook enum_hook;
54 	device_t	smb;
55 	struct resource	*regs_res;
56 	int		regs_rid;
57 	struct resource	*intr_res;
58 	int		intr_rid;
59 	void		*intr_handle;
60 	int		intr_type;
61 	enum ig4_op	op;
62 	int		cmd;
63 	int		rnext;
64 	int		rpos;
65 	char		rbuf[IG4_RBUFSIZE];
66 	int		error;
67 	uint8_t		last_slave;
68 	int		pci_attached : 1;
69 	int		use_10bit : 1;
70 	int		slave_valid : 1;
71 	int		read_started : 1;
72 	int		write_started : 1;
73 	struct mtx	mutex;
74 };
75 
76 typedef struct ig4iic_softc ig4iic_softc_t;
77 
78 /* Attach/Detach called from ig4iic_pci_*() */
79 int ig4iic_attach(ig4iic_softc_t *sc);
80 int ig4iic_detach(ig4iic_softc_t *sc);
81 
82 /* SMBus methods */
83 extern smbus_callback_t ig4iic_smb_callback;
84 extern smbus_quick_t    ig4iic_smb_quick;
85 extern smbus_sendb_t    ig4iic_smb_sendb;
86 extern smbus_recvb_t    ig4iic_smb_recvb;
87 extern smbus_writeb_t   ig4iic_smb_writeb;
88 extern smbus_writew_t   ig4iic_smb_writew;
89 extern smbus_readb_t    ig4iic_smb_readb;
90 extern smbus_readw_t    ig4iic_smb_readw;
91 extern smbus_pcall_t    ig4iic_smb_pcall;
92 extern smbus_bwrite_t   ig4iic_smb_bwrite;
93 extern smbus_bread_t    ig4iic_smb_bread;
94 extern smbus_trans_t    ig4iic_smb_trans;
95 
96 #endif
97