glxiic.c revision 275982
11590Srgrimes/*-
21590Srgrimes * Copyright (c) 2011 Henrik Brix Andersen <brix@FreeBSD.org>
31590Srgrimes * All rights reserved.
41590Srgrimes *
51590Srgrimes * Redistribution and use in source and binary forms, with or without
61590Srgrimes * modification, are permitted provided that the following conditions
71590Srgrimes * are met:
81590Srgrimes * 1. Redistributions of source code must retain the above copyright
91590Srgrimes *    notice, this list of conditions and the following disclaimer.
101590Srgrimes * 2. Redistributions in binary form must reproduce the above copyright
111590Srgrimes *    notice, this list of conditions and the following disclaimer in the
121590Srgrimes *    documentation and/or other materials provided with the distribution.
131590Srgrimes *
141590Srgrimes * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
151590Srgrimes * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
161590Srgrimes * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
171590Srgrimes * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
181590Srgrimes * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
191590Srgrimes * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
201590Srgrimes * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
211590Srgrimes * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
221590Srgrimes * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
231590Srgrimes * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
241590Srgrimes */
251590Srgrimes
261590Srgrimes#include <sys/cdefs.h>
271590Srgrimes__FBSDID("$FreeBSD: stable/10/sys/dev/glxiic/glxiic.c 275982 2014-12-21 03:06:11Z smh $");
281590Srgrimes/*
291590Srgrimes * AMD Geode LX CS5536 System Management Bus controller.
301590Srgrimes *
3141568Sarchie * Although AMD refers to this device as an SMBus controller, it
321590Srgrimes * really is an I2C controller (It lacks SMBus ALERT# and Alert
331590Srgrimes * Response support).
341590Srgrimes *
351590Srgrimes * The driver is implemented as an interrupt-driven state machine,
361590Srgrimes * supporting both master and slave mode.
3741568Sarchie */
381590Srgrimes#include <sys/param.h>
3999112Sobrien#include <sys/systm.h>
4099112Sobrien#include <sys/bus.h>
411590Srgrimes#include <sys/kernel.h>
4265508Sdes#include <sys/module.h>
4365414Sdes#include <sys/lock.h>
441590Srgrimes#include <sys/mutex.h>
4578717Sdd#include <sys/sysctl.h>
4623693Speter#ifdef GLXIIC_DEBUG
471590Srgrimes#include <sys/syslog.h>
4892920Simp#endif
491590Srgrimes
501590Srgrimes#include <dev/pci/pcireg.h>
51100822Sdwmalone#include <dev/pci/pcivar.h>
521590Srgrimes
5365508Sdes#include <machine/bus.h>
541590Srgrimes#include <sys/rman.h>
551590Srgrimes#include <machine/resource.h>
5624360Simp
571590Srgrimes#include <dev/iicbus/iiconf.h>
581590Srgrimes#include <dev/iicbus/iicbus.h>
591590Srgrimes
601590Srgrimes#include "iicbus_if.h"
611590Srgrimes
621590Srgrimes/* CS5536 PCI-ISA ID. */
631590Srgrimes#define	GLXIIC_CS5536_DEV_ID		0x20901022
641590Srgrimes
65188006Srwatson/* MSRs. */
661590Srgrimes#define	GLXIIC_MSR_PIC_YSEL_HIGH	0x51400021
671590Srgrimes
68188006Srwatson/* Bus speeds. */
69188006Srwatson#define	GLXIIC_SLOW	0x0258	/*  10 kHz. */
70188006Srwatson#define	GLXIIC_FAST	0x0078	/*  50 kHz. */
71188006Srwatson#define	GLXIIC_FASTEST	0x003c	/* 100 kHz. */
72188006Srwatson
73188006Srwatson/* Default bus activity timeout in milliseconds. */
741590Srgrimes#define GLXIIC_DEFAULT_TIMEOUT	35
751590Srgrimes
761590Srgrimes/* GPIO register offsets. */
771590Srgrimes#define	GLXIIC_GPIOL_OUT_AUX1_SEL	0x10
78100822Sdwmalone#define	GLXIIC_GPIOL_IN_AUX1_SEL	0x34
791590Srgrimes
801590Srgrimes/* GPIO 14 (SMB_CLK) and 15 (SMB_DATA) bitmasks. */
81188006Srwatson#define	GLXIIC_GPIO_14_15_ENABLE	0x0000c000
821590Srgrimes#define	GLXIIC_GPIO_14_15_DISABLE	0xc0000000
831590Srgrimes
84/* SMB register offsets. */
85#define	GLXIIC_SMB_SDA				0x00
86#define	GLXIIC_SMB_STS				0x01
87#define		GLXIIC_SMB_STS_SLVSTP_BIT	(1 << 7)
88#define		GLXIIC_SMB_STS_SDAST_BIT	(1 << 6)
89#define		GLXIIC_SMB_STS_BER_BIT		(1 << 5)
90#define		GLXIIC_SMB_STS_NEGACK_BIT	(1 << 4)
91#define		GLXIIC_SMB_STS_STASTR_BIT	(1 << 3)
92#define		GLXIIC_SMB_STS_NMATCH_BIT	(1 << 2)
93#define		GLXIIC_SMB_STS_MASTER_BIT	(1 << 1)
94#define		GLXIIC_SMB_STS_XMIT_BIT		(1 << 0)
95#define	GLXIIC_SMB_CTRL_STS			0x02
96#define		GLXIIC_SMB_CTRL_STS_TGSCL_BIT	(1 << 5)
97#define		GLXIIC_SMB_CTRL_STS_TSDA_BIT	(1 << 4)
98#define		GLXIIC_SMB_CTRL_STS_GCMTCH_BIT	(1 << 3)
99#define		GLXIIC_SMB_CTRL_STS_MATCH_BIT	(1 << 2)
100#define		GLXIIC_SMB_CTRL_STS_BB_BIT	(1 << 1)
101#define		GLXIIC_SMB_CTRL_STS_BUSY_BIT	(1 << 0)
102#define	GLXIIC_SMB_CTRL1			0x03
103#define		GLXIIC_SMB_CTRL1_STASTRE_BIT	(1 << 7)
104#define		GLXIIC_SMB_CTRL1_NMINTE_BIT	(1 << 6)
105#define		GLXIIC_SMB_CTRL1_GCMEN_BIT	(1 << 5)
106#define		GLXIIC_SMB_CTRL1_ACK_BIT	(1 << 4)
107#define		GLXIIC_SMB_CTRL1_INTEN_BIT	(1 << 2)
108#define		GLXIIC_SMB_CTRL1_STOP_BIT	(1 << 1)
109#define		GLXIIC_SMB_CTRL1_START_BIT	(1 << 0)
110#define	GLXIIC_SMB_ADDR				0x04
111#define		GLXIIC_SMB_ADDR_SAEN_BIT	(1 << 7)
112#define	GLXIIC_SMB_CTRL2			0x05
113#define		GLXIIC_SMB_CTRL2_EN_BIT		(1 << 0)
114#define	GLXIIC_SMB_CTRL3			0x06
115
116typedef enum {
117	GLXIIC_STATE_IDLE,
118	GLXIIC_STATE_SLAVE_TX,
119	GLXIIC_STATE_SLAVE_RX,
120	GLXIIC_STATE_MASTER_ADDR,
121	GLXIIC_STATE_MASTER_TX,
122	GLXIIC_STATE_MASTER_RX,
123	GLXIIC_STATE_MASTER_STOP,
124	GLXIIC_STATE_MAX,
125} glxiic_state_t;
126
127struct glxiic_softc {
128	device_t	 dev;		/* Myself. */
129	device_t	 iicbus;	/* IIC bus. */
130	struct mtx	 mtx;		/* Lock. */
131	glxiic_state_t	 state;		/* Driver state. */
132	struct callout	 callout;	/* Driver state timeout callout. */
133	int		 timeout;	/* Driver state timeout (ms). */
134
135	int		 smb_rid;	/* SMB controller resource ID. */
136	struct resource *smb_res;	/* SMB controller resource. */
137	int		 gpio_rid;	/* GPIO resource ID. */
138	struct resource *gpio_res;	/* GPIO resource. */
139
140	int		 irq_rid;	/* IRQ resource ID. */
141	struct resource *irq_res;	/* IRQ resource. */
142	void		*irq_handler;	/* IRQ handler cookie. */
143	int		 old_irq;	/* IRQ mapped by board firmware. */
144
145	struct iic_msg	*msg;		/* Current master mode message. */
146	uint32_t	 nmsgs;		/* Number of messages remaining. */
147	uint8_t		*data;		/* Current master mode data byte. */
148	uint16_t	 ndata;		/* Number of data bytes remaining. */
149	int		 error;		/* Last master mode error. */
150
151	uint8_t		 addr;		/* Own address. */
152	uint16_t	 sclfrq;	/* Bus frequency. */
153};
154
155#ifdef GLXIIC_DEBUG
156#define GLXIIC_DEBUG_LOG(fmt, args...)	\
157	log(LOG_DEBUG, "%s: " fmt "\n" , __func__ , ## args)
158#else
159#define GLXIIC_DEBUG_LOG(fmt, args...)
160#endif
161
162#define	GLXIIC_SCLFRQ(n)		((n << 1))
163#define	GLXIIC_SMBADDR(n)		((n >> 1))
164#define	GLXIIC_SMB_IRQ_TO_MAP(n)	((n << 16))
165#define	GLXIIC_MAP_TO_SMB_IRQ(n)	((n >> 16) & 0xf)
166
167#define	GLXIIC_LOCK(_sc)		mtx_lock(&_sc->mtx)
168#define	GLXIIC_UNLOCK(_sc)		mtx_unlock(&_sc->mtx)
169#define	GLXIIC_LOCK_INIT(_sc)		\
170	mtx_init(&_sc->mtx, device_get_nameunit(_sc->dev), "glxiic", MTX_DEF)
171#define	GLXIIC_SLEEP(_sc)		\
172	mtx_sleep(_sc, &_sc->mtx, IICPRI, "glxiic", 0)
173#define	GLXIIC_WAKEUP(_sc)		wakeup(_sc);
174#define	GLXIIC_LOCK_DESTROY(_sc)	mtx_destroy(&_sc->mtx);
175#define	GLXIIC_ASSERT_LOCKED(_sc)	mtx_assert(&_sc->mtx, MA_OWNED);
176
177typedef	int (glxiic_state_callback_t)(struct glxiic_softc *sc,
178    uint8_t status);
179
180static glxiic_state_callback_t	glxiic_state_idle_callback;
181static glxiic_state_callback_t	glxiic_state_slave_tx_callback;
182static glxiic_state_callback_t	glxiic_state_slave_rx_callback;
183static glxiic_state_callback_t	glxiic_state_master_addr_callback;
184static glxiic_state_callback_t	glxiic_state_master_tx_callback;
185static glxiic_state_callback_t	glxiic_state_master_rx_callback;
186static glxiic_state_callback_t	glxiic_state_master_stop_callback;
187
188struct glxiic_state_table_entry {
189	glxiic_state_callback_t *callback;
190	boolean_t master;
191};
192typedef struct glxiic_state_table_entry glxiic_state_table_entry_t;
193
194static glxiic_state_table_entry_t glxiic_state_table[GLXIIC_STATE_MAX] = {
195	[GLXIIC_STATE_IDLE] = {
196		.callback = &glxiic_state_idle_callback,
197		.master = FALSE,
198	},
199
200	[GLXIIC_STATE_SLAVE_TX] = {
201		.callback = &glxiic_state_slave_tx_callback,
202		.master = FALSE,
203	},
204
205	[GLXIIC_STATE_SLAVE_RX] = {
206		.callback = &glxiic_state_slave_rx_callback,
207		.master = FALSE,
208	},
209
210	[GLXIIC_STATE_MASTER_ADDR] = {
211		.callback = &glxiic_state_master_addr_callback,
212		.master = TRUE,
213	},
214
215	[GLXIIC_STATE_MASTER_TX] = {
216		.callback = &glxiic_state_master_tx_callback,
217		.master = TRUE,
218	},
219
220	[GLXIIC_STATE_MASTER_RX] = {
221		.callback = &glxiic_state_master_rx_callback,
222		.master = TRUE,
223	},
224
225	[GLXIIC_STATE_MASTER_STOP] = {
226		.callback = &glxiic_state_master_stop_callback,
227		.master = TRUE,
228	},
229};
230
231static void	glxiic_identify(driver_t *driver, device_t parent);
232static int	glxiic_probe(device_t dev);
233static int	glxiic_attach(device_t dev);
234static int	glxiic_detach(device_t dev);
235
236static uint8_t	glxiic_read_status_locked(struct glxiic_softc *sc);
237static void	glxiic_stop_locked(struct glxiic_softc *sc);
238static void	glxiic_timeout(void *arg);
239static void	glxiic_start_timeout_locked(struct glxiic_softc *sc);
240static void	glxiic_set_state_locked(struct glxiic_softc *sc,
241    glxiic_state_t state);
242static int	glxiic_handle_slave_match_locked(struct glxiic_softc *sc,
243    uint8_t status);
244static void	glxiic_intr(void *arg);
245
246static int	glxiic_reset(device_t dev, u_char speed, u_char addr,
247    u_char *oldaddr);
248static int	glxiic_transfer(device_t dev, struct iic_msg *msgs,
249    uint32_t nmsgs);
250
251static void	glxiic_smb_map_interrupt(int irq);
252static void 	glxiic_gpio_enable(struct glxiic_softc *sc);
253static void 	glxiic_gpio_disable(struct glxiic_softc *sc);
254static void	glxiic_smb_enable(struct glxiic_softc *sc, uint8_t speed,
255    uint8_t addr);
256static void	glxiic_smb_disable(struct glxiic_softc *sc);
257
258static device_method_t glxiic_methods[] = {
259	DEVMETHOD(device_identify,	glxiic_identify),
260	DEVMETHOD(device_probe,		glxiic_probe),
261	DEVMETHOD(device_attach,	glxiic_attach),
262	DEVMETHOD(device_detach,	glxiic_detach),
263
264	DEVMETHOD(iicbus_reset,		glxiic_reset),
265	DEVMETHOD(iicbus_transfer,	glxiic_transfer),
266	DEVMETHOD(iicbus_callback,	iicbus_null_callback),
267
268	{ 0, 0 }
269};
270
271static driver_t glxiic_driver = {
272	"glxiic",
273	glxiic_methods,
274	sizeof(struct glxiic_softc),
275};
276
277static devclass_t glxiic_devclass;
278
279DRIVER_MODULE(glxiic, isab, glxiic_driver, glxiic_devclass, 0, 0);
280DRIVER_MODULE(iicbus, glxiic, iicbus_driver, iicbus_devclass, 0, 0);
281MODULE_DEPEND(glxiic, iicbus, 1, 1, 1);
282
283static void
284glxiic_identify(driver_t *driver, device_t parent)
285{
286
287	/* Prevent child from being added more than once. */
288	if (device_find_child(parent, driver->name, -1) != NULL)
289		return;
290
291	if (pci_get_devid(parent) == GLXIIC_CS5536_DEV_ID) {
292		if (device_add_child(parent, driver->name, -1) == NULL)
293			device_printf(parent, "Could not add glxiic child\n");
294	}
295}
296
297static int
298glxiic_probe(device_t dev)
299{
300
301	if (resource_disabled("glxiic", device_get_unit(dev)))
302		return (ENXIO);
303
304	device_set_desc(dev, "AMD Geode CS5536 SMBus controller");
305
306	return (BUS_PROBE_DEFAULT);
307}
308
309static int
310glxiic_attach(device_t dev)
311{
312	struct glxiic_softc *sc;
313	struct sysctl_ctx_list *ctx;
314	struct sysctl_oid *tree;
315	int error, irq, unit;
316	uint32_t irq_map;
317	char tn[32];
318
319	sc = device_get_softc(dev);
320	sc->dev = dev;
321	sc->state = GLXIIC_STATE_IDLE;
322	error = 0;
323
324	GLXIIC_LOCK_INIT(sc);
325	callout_init_mtx(&sc->callout, &sc->mtx, 0);
326
327	sc->smb_rid = PCIR_BAR(0);
328	sc->smb_res = bus_alloc_resource_any(dev, SYS_RES_IOPORT, &sc->smb_rid,
329	    RF_ACTIVE);
330	if (sc->smb_res == NULL) {
331		device_printf(dev, "Could not allocate SMBus I/O port\n");
332		error = ENXIO;
333		goto out;
334	}
335
336	sc->gpio_rid = PCIR_BAR(1);
337	sc->gpio_res = bus_alloc_resource_any(dev, SYS_RES_IOPORT,
338	    &sc->gpio_rid, RF_SHAREABLE | RF_ACTIVE);
339	if (sc->gpio_res == NULL) {
340		device_printf(dev, "Could not allocate GPIO I/O port\n");
341		error = ENXIO;
342		goto out;
343	}
344
345	/* Ensure the controller is not enabled by firmware. */
346	glxiic_smb_disable(sc);
347
348	/* Read the existing IRQ map. */
349	irq_map = rdmsr(GLXIIC_MSR_PIC_YSEL_HIGH);
350	sc->old_irq = GLXIIC_MAP_TO_SMB_IRQ(irq_map);
351
352	unit = device_get_unit(dev);
353	if (resource_int_value("glxiic", unit, "irq", &irq) == 0) {
354		if (irq < 1 || irq > 15) {
355			device_printf(dev, "Bad value %d for glxiic.%d.irq\n",
356			    irq, unit);
357			error = ENXIO;
358			goto out;
359		}
360
361		if (bootverbose)
362			device_printf(dev, "Using irq %d set by hint\n", irq);
363	} else if (sc->old_irq != 0) {
364		if (bootverbose)
365			device_printf(dev, "Using irq %d set by firmware\n",
366			    irq);
367		irq = sc->old_irq;
368	} else {
369		device_printf(dev, "No irq mapped by firmware");
370		printf(" and no glxiic.%d.irq hint provided\n", unit);
371		error = ENXIO;
372		goto out;
373	}
374
375	/* Map the SMBus interrupt to the requested legacy IRQ. */
376	glxiic_smb_map_interrupt(irq);
377
378	sc->irq_rid = 0;
379	sc->irq_res = bus_alloc_resource(dev, SYS_RES_IRQ, &sc->irq_rid,
380	    irq, irq, 1, RF_SHAREABLE | RF_ACTIVE);
381	if (sc->irq_res == NULL) {
382		device_printf(dev, "Could not allocate IRQ %d\n", irq);
383		error = ENXIO;
384		goto out;
385	}
386
387	error = bus_setup_intr(dev, sc->irq_res, INTR_TYPE_MISC | INTR_MPSAFE,
388	    NULL, glxiic_intr, sc, &(sc->irq_handler));
389	if (error != 0) {
390		device_printf(dev, "Could not setup IRQ handler\n");
391		error = ENXIO;
392		goto out;
393	}
394
395	if ((sc->iicbus = device_add_child(dev, "iicbus", -1)) == NULL) {
396		device_printf(dev, "Could not allocate iicbus instance\n");
397		error = ENXIO;
398		goto out;
399	}
400
401	ctx = device_get_sysctl_ctx(dev);
402	tree = device_get_sysctl_tree(dev);
403
404	sc->timeout = GLXIIC_DEFAULT_TIMEOUT;
405	snprintf(tn, sizeof(tn), "dev.glxiic.%d.timeout", unit);
406	TUNABLE_INT_FETCH(tn, &sc->timeout);
407	SYSCTL_ADD_INT(ctx, SYSCTL_CHILDREN(tree), OID_AUTO,
408	    "timeout", CTLFLAG_RW | CTLFLAG_TUN, &sc->timeout, 0,
409	    "activity timeout in ms");
410
411	glxiic_gpio_enable(sc);
412	glxiic_smb_enable(sc, IIC_FASTEST, 0);
413
414	error = bus_generic_attach(dev);
415	if (error != 0) {
416		device_printf(dev, "Could not probe and attach children\n");
417		error = ENXIO;
418	}
419out:
420	if (error != 0) {
421		callout_drain(&sc->callout);
422
423		if (sc->iicbus != NULL)
424			device_delete_child(dev, sc->iicbus);
425		if (sc->smb_res != NULL) {
426			glxiic_smb_disable(sc);
427			bus_release_resource(dev, SYS_RES_IOPORT, sc->smb_rid,
428			    sc->smb_res);
429		}
430		if (sc->gpio_res != NULL) {
431			glxiic_gpio_disable(sc);
432			bus_release_resource(dev, SYS_RES_IOPORT, sc->gpio_rid,
433			    sc->gpio_res);
434		}
435		if (sc->irq_handler != NULL)
436			bus_teardown_intr(dev, sc->irq_res, sc->irq_handler);
437		if (sc->irq_res != NULL)
438			bus_release_resource(dev, SYS_RES_IRQ, sc->irq_rid,
439			    sc->irq_res);
440
441		/* Restore the old SMBus interrupt mapping. */
442		glxiic_smb_map_interrupt(sc->old_irq);
443
444		GLXIIC_LOCK_DESTROY(sc);
445	}
446
447	return (error);
448}
449
450static int
451glxiic_detach(device_t dev)
452{
453	struct glxiic_softc *sc;
454	int error;
455
456	sc = device_get_softc(dev);
457
458	error = bus_generic_detach(dev);
459	if (error != 0)
460		goto out;
461	if (sc->iicbus != NULL)
462		error = device_delete_child(dev, sc->iicbus);
463
464out:
465	callout_drain(&sc->callout);
466
467	if (sc->smb_res != NULL) {
468		glxiic_smb_disable(sc);
469		bus_release_resource(dev, SYS_RES_IOPORT, sc->smb_rid,
470		    sc->smb_res);
471	}
472	if (sc->gpio_res != NULL) {
473		glxiic_gpio_disable(sc);
474		bus_release_resource(dev, SYS_RES_IOPORT, sc->gpio_rid,
475		    sc->gpio_res);
476	}
477	if (sc->irq_handler != NULL)
478		bus_teardown_intr(dev, sc->irq_res, sc->irq_handler);
479	if (sc->irq_res != NULL)
480		bus_release_resource(dev, SYS_RES_IRQ, sc->irq_rid,
481		    sc->irq_res);
482
483	/* Restore the old SMBus interrupt mapping. */
484	glxiic_smb_map_interrupt(sc->old_irq);
485
486	GLXIIC_LOCK_DESTROY(sc);
487
488	return (error);
489}
490
491static uint8_t
492glxiic_read_status_locked(struct glxiic_softc *sc)
493{
494	uint8_t status;
495
496	GLXIIC_ASSERT_LOCKED(sc);
497
498	status = bus_read_1(sc->smb_res, GLXIIC_SMB_STS);
499
500	/* Clear all status flags except SDAST and STASTR after reading. */
501	bus_write_1(sc->smb_res, GLXIIC_SMB_STS, (GLXIIC_SMB_STS_SLVSTP_BIT |
502		GLXIIC_SMB_STS_BER_BIT | GLXIIC_SMB_STS_NEGACK_BIT |
503		GLXIIC_SMB_STS_NMATCH_BIT));
504
505	return (status);
506}
507
508static void
509glxiic_stop_locked(struct glxiic_softc *sc)
510{
511	uint8_t status, ctrl1;
512
513	GLXIIC_ASSERT_LOCKED(sc);
514
515	status = glxiic_read_status_locked(sc);
516
517	ctrl1 = bus_read_1(sc->smb_res, GLXIIC_SMB_CTRL1);
518	bus_write_1(sc->smb_res, GLXIIC_SMB_CTRL1,
519	    ctrl1 | GLXIIC_SMB_CTRL1_STOP_BIT);
520
521	/*
522	 * Perform a dummy read of SDA in master receive mode to clear
523	 * SDAST if set.
524	 */
525	if ((status & GLXIIC_SMB_STS_XMIT_BIT) == 0 &&
526	    (status & GLXIIC_SMB_STS_SDAST_BIT) != 0)
527	 	bus_read_1(sc->smb_res, GLXIIC_SMB_SDA);
528
529	/* Check stall after start bit and clear if needed */
530	if ((status & GLXIIC_SMB_STS_STASTR_BIT) != 0) {
531		bus_write_1(sc->smb_res, GLXIIC_SMB_STS,
532		    GLXIIC_SMB_STS_STASTR_BIT);
533	}
534}
535
536static void
537glxiic_timeout(void *arg)
538{
539	struct glxiic_softc *sc;
540	uint8_t error;
541
542	sc = (struct glxiic_softc *)arg;
543
544	GLXIIC_DEBUG_LOG("timeout in state %d", sc->state);
545
546	if (glxiic_state_table[sc->state].master) {
547		sc->error = IIC_ETIMEOUT;
548		GLXIIC_WAKEUP(sc);
549	} else {
550		error = IIC_ETIMEOUT;
551		iicbus_intr(sc->iicbus, INTR_ERROR, &error);
552	}
553
554	glxiic_smb_disable(sc);
555	glxiic_smb_enable(sc, IIC_UNKNOWN, sc->addr);
556	glxiic_set_state_locked(sc, GLXIIC_STATE_IDLE);
557}
558
559static void
560glxiic_start_timeout_locked(struct glxiic_softc *sc)
561{
562
563	GLXIIC_ASSERT_LOCKED(sc);
564
565	callout_reset_sbt(&sc->callout, SBT_1MS * sc->timeout, 0,
566	    glxiic_timeout, sc, 0);
567}
568
569static void
570glxiic_set_state_locked(struct glxiic_softc *sc, glxiic_state_t state)
571{
572
573	GLXIIC_ASSERT_LOCKED(sc);
574
575	if (state == GLXIIC_STATE_IDLE)
576		callout_stop(&sc->callout);
577	else if (sc->timeout > 0)
578		glxiic_start_timeout_locked(sc);
579
580	sc->state = state;
581}
582
583static int
584glxiic_handle_slave_match_locked(struct glxiic_softc *sc, uint8_t status)
585{
586	uint8_t ctrl_sts, addr;
587
588	GLXIIC_ASSERT_LOCKED(sc);
589
590	ctrl_sts = bus_read_1(sc->smb_res, GLXIIC_SMB_CTRL_STS);
591
592	if ((ctrl_sts & GLXIIC_SMB_CTRL_STS_MATCH_BIT) != 0) {
593		if ((status & GLXIIC_SMB_STS_XMIT_BIT) != 0) {
594			addr = sc->addr | LSB;
595			glxiic_set_state_locked(sc,
596			    GLXIIC_STATE_SLAVE_TX);
597		} else {
598			addr = sc->addr & ~LSB;
599			glxiic_set_state_locked(sc,
600			    GLXIIC_STATE_SLAVE_RX);
601		}
602		iicbus_intr(sc->iicbus, INTR_START, &addr);
603	} else if ((ctrl_sts & GLXIIC_SMB_CTRL_STS_GCMTCH_BIT) != 0) {
604		addr = 0;
605		glxiic_set_state_locked(sc, GLXIIC_STATE_SLAVE_RX);
606		iicbus_intr(sc->iicbus, INTR_GENERAL, &addr);
607	} else {
608		GLXIIC_DEBUG_LOG("unknown slave match");
609		return (IIC_ESTATUS);
610	}
611
612	return (IIC_NOERR);
613}
614
615static int
616glxiic_state_idle_callback(struct glxiic_softc *sc, uint8_t status)
617{
618
619	GLXIIC_ASSERT_LOCKED(sc);
620
621	if ((status & GLXIIC_SMB_STS_BER_BIT) != 0) {
622		GLXIIC_DEBUG_LOG("bus error in idle");
623		return (IIC_EBUSERR);
624	}
625
626	if ((status & GLXIIC_SMB_STS_NMATCH_BIT) != 0) {
627		return (glxiic_handle_slave_match_locked(sc, status));
628	}
629
630	return (IIC_NOERR);
631}
632
633static int
634glxiic_state_slave_tx_callback(struct glxiic_softc *sc, uint8_t status)
635{
636	uint8_t data;
637
638	GLXIIC_ASSERT_LOCKED(sc);
639
640	if ((status & GLXIIC_SMB_STS_BER_BIT) != 0) {
641		GLXIIC_DEBUG_LOG("bus error in slave tx");
642		return (IIC_EBUSERR);
643	}
644
645	if ((status & GLXIIC_SMB_STS_SLVSTP_BIT) != 0) {
646		iicbus_intr(sc->iicbus, INTR_STOP, NULL);
647		glxiic_set_state_locked(sc, GLXIIC_STATE_IDLE);
648		return (IIC_NOERR);
649	}
650
651	if ((status & GLXIIC_SMB_STS_NEGACK_BIT) != 0) {
652		iicbus_intr(sc->iicbus, INTR_NOACK, NULL);
653		return (IIC_NOERR);
654	}
655
656	if ((status & GLXIIC_SMB_STS_NMATCH_BIT) != 0) {
657		/* Handle repeated start in slave mode. */
658		return (glxiic_handle_slave_match_locked(sc, status));
659	}
660
661	if ((status & GLXIIC_SMB_STS_SDAST_BIT) == 0) {
662		GLXIIC_DEBUG_LOG("not awaiting data in slave tx");
663		return (IIC_ESTATUS);
664	}
665
666	iicbus_intr(sc->iicbus, INTR_TRANSMIT, &data);
667	bus_write_1(sc->smb_res, GLXIIC_SMB_SDA, data);
668
669	glxiic_start_timeout_locked(sc);
670
671	return (IIC_NOERR);
672}
673
674static int
675glxiic_state_slave_rx_callback(struct glxiic_softc *sc, uint8_t status)
676{
677	uint8_t data;
678
679	GLXIIC_ASSERT_LOCKED(sc);
680
681	if ((status & GLXIIC_SMB_STS_BER_BIT) != 0) {
682		GLXIIC_DEBUG_LOG("bus error in slave rx");
683		return (IIC_EBUSERR);
684	}
685
686	if ((status & GLXIIC_SMB_STS_SLVSTP_BIT) != 0) {
687		iicbus_intr(sc->iicbus, INTR_STOP, NULL);
688		glxiic_set_state_locked(sc, GLXIIC_STATE_IDLE);
689		return (IIC_NOERR);
690	}
691
692	if ((status & GLXIIC_SMB_STS_NMATCH_BIT) != 0) {
693		/* Handle repeated start in slave mode. */
694		return (glxiic_handle_slave_match_locked(sc, status));
695	}
696
697	if ((status & GLXIIC_SMB_STS_SDAST_BIT) == 0) {
698		GLXIIC_DEBUG_LOG("no pending data in slave rx");
699		return (IIC_ESTATUS);
700	}
701
702	data = bus_read_1(sc->smb_res, GLXIIC_SMB_SDA);
703	iicbus_intr(sc->iicbus, INTR_RECEIVE, &data);
704
705	glxiic_start_timeout_locked(sc);
706
707	return (IIC_NOERR);
708}
709
710static int
711glxiic_state_master_addr_callback(struct glxiic_softc *sc, uint8_t status)
712{
713	uint8_t slave;
714	uint8_t ctrl1;
715
716	GLXIIC_ASSERT_LOCKED(sc);
717
718	if ((status & GLXIIC_SMB_STS_BER_BIT) != 0) {
719		GLXIIC_DEBUG_LOG("bus error after master start");
720		return (IIC_EBUSERR);
721	}
722
723	if ((status & GLXIIC_SMB_STS_MASTER_BIT) == 0) {
724		GLXIIC_DEBUG_LOG("not bus master after master start");
725		return (IIC_ESTATUS);
726	}
727
728	if ((status & GLXIIC_SMB_STS_SDAST_BIT) == 0) {
729		GLXIIC_DEBUG_LOG("not awaiting address in master addr");
730		return (IIC_ESTATUS);
731	}
732
733	if ((sc->msg->flags & IIC_M_RD) != 0) {
734		slave = sc->msg->slave | LSB;
735		glxiic_set_state_locked(sc, GLXIIC_STATE_MASTER_RX);
736	} else {
737		slave = sc->msg->slave & ~LSB;
738		glxiic_set_state_locked(sc, GLXIIC_STATE_MASTER_TX);
739	}
740
741	sc->data = sc->msg->buf;
742	sc->ndata = sc->msg->len;
743
744	/* Handle address-only transfer. */
745	if (sc->ndata == 0)
746		glxiic_set_state_locked(sc, GLXIIC_STATE_MASTER_STOP);
747
748	bus_write_1(sc->smb_res, GLXIIC_SMB_SDA, slave);
749
750	if ((sc->msg->flags & IIC_M_RD) != 0 && sc->ndata == 1) {
751		/* Last byte from slave, set NACK. */
752		ctrl1 = bus_read_1(sc->smb_res, GLXIIC_SMB_CTRL1);
753		bus_write_1(sc->smb_res, GLXIIC_SMB_CTRL1,
754		    ctrl1 | GLXIIC_SMB_CTRL1_ACK_BIT);
755	}
756
757	return (IIC_NOERR);
758}
759
760static int
761glxiic_state_master_tx_callback(struct glxiic_softc *sc, uint8_t status)
762{
763
764	GLXIIC_ASSERT_LOCKED(sc);
765
766	if ((status & GLXIIC_SMB_STS_BER_BIT) != 0) {
767		GLXIIC_DEBUG_LOG("bus error in master tx");
768		return (IIC_EBUSERR);
769	}
770
771	if ((status & GLXIIC_SMB_STS_MASTER_BIT) == 0) {
772		GLXIIC_DEBUG_LOG("not bus master in master tx");
773		return (IIC_ESTATUS);
774	}
775
776	if ((status & GLXIIC_SMB_STS_NEGACK_BIT) != 0) {
777		GLXIIC_DEBUG_LOG("slave nack in master tx");
778		return (IIC_ENOACK);
779	}
780
781	if ((status & GLXIIC_SMB_STS_STASTR_BIT) != 0) {
782		bus_write_1(sc->smb_res, GLXIIC_SMB_STS,
783		    GLXIIC_SMB_STS_STASTR_BIT);
784	}
785
786	if ((status & GLXIIC_SMB_STS_SDAST_BIT) == 0) {
787		GLXIIC_DEBUG_LOG("not awaiting data in master tx");
788		return (IIC_ESTATUS);
789	}
790
791	bus_write_1(sc->smb_res, GLXIIC_SMB_SDA, *sc->data++);
792	if (--sc->ndata == 0)
793		glxiic_set_state_locked(sc, GLXIIC_STATE_MASTER_STOP);
794	else
795		glxiic_start_timeout_locked(sc);
796
797	return (IIC_NOERR);
798}
799
800static int
801glxiic_state_master_rx_callback(struct glxiic_softc *sc, uint8_t status)
802{
803	uint8_t ctrl1;
804
805	GLXIIC_ASSERT_LOCKED(sc);
806
807	if ((status & GLXIIC_SMB_STS_BER_BIT) != 0) {
808		GLXIIC_DEBUG_LOG("bus error in master rx");
809		return (IIC_EBUSERR);
810	}
811
812	if ((status & GLXIIC_SMB_STS_MASTER_BIT) == 0) {
813		GLXIIC_DEBUG_LOG("not bus master in master rx");
814		return (IIC_ESTATUS);
815	}
816
817	if ((status & GLXIIC_SMB_STS_NEGACK_BIT) != 0) {
818		GLXIIC_DEBUG_LOG("slave nack in rx");
819		return (IIC_ENOACK);
820	}
821
822	if ((status & GLXIIC_SMB_STS_STASTR_BIT) != 0) {
823		/* Bus is stalled, clear and wait for data. */
824		bus_write_1(sc->smb_res, GLXIIC_SMB_STS,
825		    GLXIIC_SMB_STS_STASTR_BIT);
826		return (IIC_NOERR);
827	}
828
829	if ((status & GLXIIC_SMB_STS_SDAST_BIT) == 0) {
830		GLXIIC_DEBUG_LOG("no pending data in master rx");
831		return (IIC_ESTATUS);
832	}
833
834	*sc->data++ = bus_read_1(sc->smb_res, GLXIIC_SMB_SDA);
835	if (--sc->ndata == 0) {
836		/* Proceed with stop on reading last byte. */
837		glxiic_set_state_locked(sc, GLXIIC_STATE_MASTER_STOP);
838		return (glxiic_state_table[sc->state].callback(sc, status));
839	}
840
841	if (sc->ndata == 1) {
842		/* Last byte from slave, set NACK. */
843		ctrl1 = bus_read_1(sc->smb_res, GLXIIC_SMB_CTRL1);
844		bus_write_1(sc->smb_res, GLXIIC_SMB_CTRL1,
845		    ctrl1 | GLXIIC_SMB_CTRL1_ACK_BIT);
846	}
847
848	glxiic_start_timeout_locked(sc);
849
850	return (IIC_NOERR);
851}
852
853static int
854glxiic_state_master_stop_callback(struct glxiic_softc *sc, uint8_t status)
855{
856	uint8_t ctrl1;
857
858	GLXIIC_ASSERT_LOCKED(sc);
859
860	if ((status & GLXIIC_SMB_STS_BER_BIT) != 0) {
861		GLXIIC_DEBUG_LOG("bus error in master stop");
862		return (IIC_EBUSERR);
863	}
864
865	if ((status & GLXIIC_SMB_STS_MASTER_BIT) == 0) {
866		GLXIIC_DEBUG_LOG("not bus master in master stop");
867		return (IIC_ESTATUS);
868	}
869
870	if ((status & GLXIIC_SMB_STS_NEGACK_BIT) != 0) {
871		GLXIIC_DEBUG_LOG("slave nack in master stop");
872		return (IIC_ENOACK);
873	}
874
875	if (--sc->nmsgs > 0) {
876		/* Start transfer of next message. */
877		if ((sc->msg->flags & IIC_M_NOSTOP) == 0) {
878			glxiic_stop_locked(sc);
879		}
880
881		ctrl1 = bus_read_1(sc->smb_res, GLXIIC_SMB_CTRL1);
882		bus_write_1(sc->smb_res, GLXIIC_SMB_CTRL1,
883		    ctrl1 | GLXIIC_SMB_CTRL1_START_BIT);
884
885		glxiic_set_state_locked(sc, GLXIIC_STATE_MASTER_ADDR);
886		sc->msg++;
887	} else {
888		/* Last message. */
889		glxiic_stop_locked(sc);
890		glxiic_set_state_locked(sc, GLXIIC_STATE_IDLE);
891		sc->error = IIC_NOERR;
892		GLXIIC_WAKEUP(sc);
893	}
894
895	return (IIC_NOERR);
896}
897
898static void
899glxiic_intr(void *arg)
900{
901	struct glxiic_softc *sc;
902	int error;
903	uint8_t status, data;
904
905	sc = (struct glxiic_softc *)arg;
906
907	GLXIIC_LOCK(sc);
908
909	status = glxiic_read_status_locked(sc);
910
911	/* Check if this interrupt originated from the SMBus. */
912	if ((status &
913		~(GLXIIC_SMB_STS_MASTER_BIT | GLXIIC_SMB_STS_XMIT_BIT)) != 0) {
914
915		error = glxiic_state_table[sc->state].callback(sc, status);
916
917		if (error != IIC_NOERR) {
918			if (glxiic_state_table[sc->state].master) {
919				glxiic_stop_locked(sc);
920				glxiic_set_state_locked(sc, GLXIIC_STATE_IDLE);
921				sc->error = error;
922				GLXIIC_WAKEUP(sc);
923			} else {
924				data = error & 0xff;
925				iicbus_intr(sc->iicbus, INTR_ERROR, &data);
926				glxiic_set_state_locked(sc, GLXIIC_STATE_IDLE);
927			}
928		}
929	}
930
931	GLXIIC_UNLOCK(sc);
932}
933
934static int
935glxiic_reset(device_t dev, u_char speed, u_char addr, u_char *oldaddr)
936{
937	struct glxiic_softc *sc;
938
939	sc = device_get_softc(dev);
940
941	GLXIIC_LOCK(sc);
942
943	if (oldaddr != NULL)
944		*oldaddr = sc->addr;
945	sc->addr = addr;
946
947	/* A disable/enable cycle resets the controller. */
948	glxiic_smb_disable(sc);
949	glxiic_smb_enable(sc, speed, addr);
950
951	if (glxiic_state_table[sc->state].master) {
952		sc->error = IIC_ESTATUS;
953		GLXIIC_WAKEUP(sc);
954	}
955	glxiic_set_state_locked(sc, GLXIIC_STATE_IDLE);
956
957	GLXIIC_UNLOCK(sc);
958
959	return (IIC_NOERR);
960}
961
962static int
963glxiic_transfer(device_t dev, struct iic_msg *msgs, uint32_t nmsgs)
964{
965	struct glxiic_softc *sc;
966	int error;
967	uint8_t ctrl1;
968
969	sc = device_get_softc(dev);
970
971	GLXIIC_LOCK(sc);
972
973	if (sc->state != GLXIIC_STATE_IDLE) {
974		error = IIC_EBUSBSY;
975		goto out;
976	}
977
978	sc->msg = msgs;
979	sc->nmsgs = nmsgs;
980	glxiic_set_state_locked(sc, GLXIIC_STATE_MASTER_ADDR);
981
982	/* Set start bit and let glxiic_intr() handle the transfer. */
983	ctrl1 = bus_read_1(sc->smb_res, GLXIIC_SMB_CTRL1);
984	bus_write_1(sc->smb_res, GLXIIC_SMB_CTRL1,
985	    ctrl1 | GLXIIC_SMB_CTRL1_START_BIT);
986
987	GLXIIC_SLEEP(sc);
988	error = sc->error;
989out:
990	GLXIIC_UNLOCK(sc);
991
992	return (error);
993}
994
995static void
996glxiic_smb_map_interrupt(int irq)
997{
998	uint32_t irq_map;
999	int old_irq;
1000
1001	/* Protect the read-modify-write operation. */
1002	critical_enter();
1003
1004	irq_map = rdmsr(GLXIIC_MSR_PIC_YSEL_HIGH);
1005	old_irq = GLXIIC_MAP_TO_SMB_IRQ(irq_map);
1006
1007	if (irq != old_irq) {
1008		irq_map &= ~GLXIIC_SMB_IRQ_TO_MAP(old_irq);
1009		irq_map |= GLXIIC_SMB_IRQ_TO_MAP(irq);
1010		wrmsr(GLXIIC_MSR_PIC_YSEL_HIGH, irq_map);
1011	}
1012
1013	critical_exit();
1014}
1015
1016static void
1017glxiic_gpio_enable(struct glxiic_softc *sc)
1018{
1019
1020	bus_write_4(sc->gpio_res, GLXIIC_GPIOL_IN_AUX1_SEL,
1021	    GLXIIC_GPIO_14_15_ENABLE);
1022	bus_write_4(sc->gpio_res, GLXIIC_GPIOL_OUT_AUX1_SEL,
1023	    GLXIIC_GPIO_14_15_ENABLE);
1024}
1025
1026static void
1027glxiic_gpio_disable(struct glxiic_softc *sc)
1028{
1029
1030	bus_write_4(sc->gpio_res, GLXIIC_GPIOL_OUT_AUX1_SEL,
1031	    GLXIIC_GPIO_14_15_DISABLE);
1032	bus_write_4(sc->gpio_res, GLXIIC_GPIOL_IN_AUX1_SEL,
1033	    GLXIIC_GPIO_14_15_DISABLE);
1034}
1035
1036static void
1037glxiic_smb_enable(struct glxiic_softc *sc, uint8_t speed, uint8_t addr)
1038{
1039	uint8_t ctrl1;
1040
1041	ctrl1 = 0;
1042
1043	switch (speed) {
1044	case IIC_SLOW:
1045		sc->sclfrq = GLXIIC_SLOW;
1046		break;
1047	case IIC_FAST:
1048		sc->sclfrq = GLXIIC_FAST;
1049		break;
1050	case IIC_FASTEST:
1051		sc->sclfrq = GLXIIC_FASTEST;
1052		break;
1053	case IIC_UNKNOWN:
1054	default:
1055		/* Reuse last frequency. */
1056		break;
1057	}
1058
1059	/* Set bus speed and enable controller. */
1060	bus_write_2(sc->smb_res, GLXIIC_SMB_CTRL2,
1061	    GLXIIC_SCLFRQ(sc->sclfrq) | GLXIIC_SMB_CTRL2_EN_BIT);
1062
1063	if (addr != 0) {
1064		/* Enable new match and global call match interrupts. */
1065		ctrl1 |= GLXIIC_SMB_CTRL1_NMINTE_BIT |
1066			GLXIIC_SMB_CTRL1_GCMEN_BIT;
1067		bus_write_1(sc->smb_res, GLXIIC_SMB_ADDR,
1068		    GLXIIC_SMB_ADDR_SAEN_BIT | GLXIIC_SMBADDR(addr));
1069	} else {
1070		bus_write_1(sc->smb_res, GLXIIC_SMB_ADDR, 0);
1071	}
1072
1073	/* Enable stall after start and interrupt. */
1074	bus_write_1(sc->smb_res, GLXIIC_SMB_CTRL1,
1075	    ctrl1 | GLXIIC_SMB_CTRL1_STASTRE_BIT | GLXIIC_SMB_CTRL1_INTEN_BIT);
1076}
1077
1078static void
1079glxiic_smb_disable(struct glxiic_softc *sc)
1080{
1081	uint16_t sclfrq;
1082
1083	sclfrq = bus_read_2(sc->smb_res, GLXIIC_SMB_CTRL2);
1084	bus_write_2(sc->smb_res, GLXIIC_SMB_CTRL2,
1085	    sclfrq & ~GLXIIC_SMB_CTRL2_EN_BIT);
1086}
1087