xref: /src/sys/arch/x86/pci/dwiic_pci.c

/* $NetBSD: dwiic_pci.c,v 1.11 2024/11/11 17:28:38 martin Exp $ */

/*-
 * Copyright (c) 2017 The NetBSD Foundation, Inc.
 * All rights reserved.
 *
 * This code is derived from software contributed to The NetBSD Foundation
 * by Manuel Bouyer.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
/*
 * Synopsys DesignWare I2C controller, PCI front-end
 */

#include <sys/cdefs.h>
__KERNEL_RCSID(0, "$NetBSD: dwiic_pci.c,v 1.11 2024/11/11 17:28:38 martin Exp $");

#include <sys/param.h>
#include <sys/systm.h>

#include <dev/pci/pcireg.h>
#include <dev/pci/pcivar.h>
#include <dev/pci/pcidevs.h>

#include <dev/acpi/acpivar.h>
#include <dev/acpi/acpi_pci.h>
#include <dev/acpi/acpi_util.h>
#include <dev/acpi/acpi_i2c.h>

#include <dev/ic/dwiic_var.h>
#include <arch/x86/pci/lpssreg.h>

#include "acpica.h"

//#define DWIIC_DEBUG

#ifdef DWIIC_DEBUG
#define DPRINTF(x) printf x
#else
#define DPRINTF(x)
#endif

#if NACPICA > 0
#define	I2C_USE_ACPI
#endif /* NACPICA > 0 */

struct pci_dwiic_softc {
	struct dwiic_softc	sc_dwiic;
	pci_chipset_tag_t	sc_pc;
	pcitag_t		sc_ptag;
	struct acpi_devnode	*sc_acpinode;
};

#define VIDDID(a, b) PCI_ID_CODE(PCI_VENDOR_ ## a, PCI_PRODUCT_ ## a ## _ ## b)

static const struct device_compatible_entry compat_data[] = {
	{ .id = VIDDID(INTEL, CORE4G_M_S_I2C_0) },
	{ .id = VIDDID(INTEL, CORE4G_M_S_I2C_1) },
	{ .id = VIDDID(INTEL, 100SERIES_I2C_0) },
	{ .id = VIDDID(INTEL, 100SERIES_I2C_1) },
	{ .id = VIDDID(INTEL, 100SERIES_I2C_2) },
	{ .id = VIDDID(INTEL, 100SERIES_I2C_3) },
	{ .id = VIDDID(INTEL, 100SERIES_LP_I2C_0) },
	{ .id = VIDDID(INTEL, 100SERIES_LP_I2C_1) },
	{ .id = VIDDID(INTEL, 100SERIES_LP_I2C_2) },
	{ .id = VIDDID(INTEL, 100SERIES_LP_I2C_3) },
	{ .id = VIDDID(INTEL, 100SERIES_LP_I2C_4) },
	{ .id = VIDDID(INTEL, 100SERIES_LP_I2C_5) },
	{ .id = VIDDID(INTEL, 2HS_I2C_0) },
	{ .id = VIDDID(INTEL, 2HS_I2C_1) },
	{ .id = VIDDID(INTEL, 2HS_I2C_2) },
	{ .id = VIDDID(INTEL, 2HS_I2C_3) },
	{ .id = VIDDID(INTEL, 3HS_I2C_0) },
	{ .id = VIDDID(INTEL, 3HS_I2C_1) },
	{ .id = VIDDID(INTEL, 3HS_I2C_2) },
	{ .id = VIDDID(INTEL, 3HS_I2C_3) },
	{ .id = VIDDID(INTEL, 3HS_U_I2C_0) },
	{ .id = VIDDID(INTEL, 3HS_U_I2C_1) },
	{ .id = VIDDID(INTEL, 3HS_U_I2C_2) },
	{ .id = VIDDID(INTEL, 3HS_U_I2C_3) },
	{ .id = VIDDID(INTEL, 3HS_U_I2C_4) },
	{ .id = VIDDID(INTEL, 3HS_U_I2C_5) },
	{ .id = VIDDID(INTEL, 4HS_H_I2C_0) },
	{ .id = VIDDID(INTEL, 4HS_H_I2C_1) },
	{ .id = VIDDID(INTEL, 4HS_H_I2C_2) },
	{ .id = VIDDID(INTEL, 4HS_H_I2C_3) },
	{ .id = VIDDID(INTEL, 4HS_V_I2C_0) },
	{ .id = VIDDID(INTEL, 4HS_V_I2C_1) },
	{ .id = VIDDID(INTEL, 4HS_V_I2C_2) },
	{ .id = VIDDID(INTEL, 4HS_V_I2C_3) },
	{ .id = VIDDID(INTEL, CMTLK_I2C_0) }, /* 4HS LP */
	{ .id = VIDDID(INTEL, CMTLK_I2C_1) },
	{ .id = VIDDID(INTEL, CMTLK_I2C_2) },
	{ .id = VIDDID(INTEL, CMTLK_I2C_3) },
	{ .id = VIDDID(INTEL, CMTLK_I2C_4) },
	{ .id = VIDDID(INTEL, CMTLK_I2C_5) },
	{ .id = VIDDID(INTEL, 495_YU_I2C_0) },
	{ .id = VIDDID(INTEL, 495_YU_I2C_1) },
	{ .id = VIDDID(INTEL, 495_YU_I2C_2) },
	{ .id = VIDDID(INTEL, 495_YU_I2C_3) },
	{ .id = VIDDID(INTEL, 495_YU_I2C_4) },
	{ .id = VIDDID(INTEL, 495_YU_I2C_5) },
	{ .id = VIDDID(INTEL, 5HS_H_I2C_0) },
	{ .id = VIDDID(INTEL, 5HS_H_I2C_1) },
	{ .id = VIDDID(INTEL, 5HS_H_I2C_2) },
	{ .id = VIDDID(INTEL, 5HS_H_I2C_3) },
	{ .id = VIDDID(INTEL, 5HS_H_I2C_4) },
	{ .id = VIDDID(INTEL, 5HS_H_I2C_5) },
	{ .id = VIDDID(INTEL, 5HS_H_I2C_6) },
	{ .id = VIDDID(INTEL, 5HS_LP_I2C_0) },
	{ .id = VIDDID(INTEL, 5HS_LP_I2C_1) },
	{ .id = VIDDID(INTEL, 5HS_LP_I2C_2) },
	{ .id = VIDDID(INTEL, 5HS_LP_I2C_3) },
	{ .id = VIDDID(INTEL, 5HS_LP_I2C_4) },
	{ .id = VIDDID(INTEL, 5HS_LP_I2C_5) },
	{ .id = VIDDID(INTEL, BAYTRAIL_SIO_I2C1) },
	{ .id = VIDDID(INTEL, BAYTRAIL_SIO_I2C2) },
	{ .id = VIDDID(INTEL, BAYTRAIL_SIO_I2C3) },
	{ .id = VIDDID(INTEL, BAYTRAIL_SIO_I2C4) },
	{ .id = VIDDID(INTEL, BAYTRAIL_SIO_I2C5) },
	{ .id = VIDDID(INTEL, BAYTRAIL_SIO_I2C6) },
	{ .id = VIDDID(INTEL, BAYTRAIL_SIO_I2C7) },
	{ .id = VIDDID(INTEL, BSW_SIO_I2C_1) },
	{ .id = VIDDID(INTEL, BSW_SIO_I2C_2) },
	{ .id = VIDDID(INTEL, BSW_SIO_I2C_3) },
	{ .id = VIDDID(INTEL, BSW_SIO_I2C_4) },
	{ .id = VIDDID(INTEL, BSW_SIO_I2C_5) },
	{ .id = VIDDID(INTEL, BSW_SIO_I2C_6) },
	{ .id = VIDDID(INTEL, BSW_SIO_I2C_7) },
	{ .id = VIDDID(INTEL, APL_I2C_0) },
	{ .id = VIDDID(INTEL, APL_I2C_1) },
	{ .id = VIDDID(INTEL, APL_I2C_2) },
	{ .id = VIDDID(INTEL, APL_I2C_3) },
	{ .id = VIDDID(INTEL, APL_I2C_4) },
	{ .id = VIDDID(INTEL, APL_I2C_5) },
	{ .id = VIDDID(INTEL, APL_I2C_6) },
	{ .id = VIDDID(INTEL, APL_I2C_7) },
	{ .id = VIDDID(INTEL, GLK_I2C_0) },
	{ .id = VIDDID(INTEL, GLK_I2C_1) },
	{ .id = VIDDID(INTEL, GLK_I2C_2) },
	{ .id = VIDDID(INTEL, GLK_I2C_3) },
	{ .id = VIDDID(INTEL, GLK_I2C_4) },
	{ .id = VIDDID(INTEL, GLK_I2C_5) },
	{ .id = VIDDID(INTEL, GLK_I2C_6) },
	{ .id = VIDDID(INTEL, GLK_I2C_7) },
	{ .id = VIDDID(INTEL, EHL_SIO_I2C_0) },
	{ .id = VIDDID(INTEL, EHL_SIO_I2C_1) },
	{ .id = VIDDID(INTEL, EHL_SIO_I2C_2) },
	{ .id = VIDDID(INTEL, EHL_SIO_I2C_3) },
	{ .id = VIDDID(INTEL, EHL_SIO_I2C_4) },
	{ .id = VIDDID(INTEL, EHL_SIO_I2C_5) },
	{ .id = VIDDID(INTEL, EHL_SIO_I2C_6) },
	{ .id = VIDDID(INTEL, EHL_SIO_I2C_7) },
	{ .id = VIDDID(INTEL, JSL_LPSS_I2C_0) },
	{ .id = VIDDID(INTEL, JSL_LPSS_I2C_1) },
	{ .id = VIDDID(INTEL, JSL_LPSS_I2C_2) },
	{ .id = VIDDID(INTEL, JSL_LPSS_I2C_3) },
	{ .id = VIDDID(INTEL, JSL_LPSS_I2C_4) },
	{ .id = VIDDID(INTEL, JSL_LPSS_I2C_5) },

	PCI_COMPAT_EOL
};

static uint32_t
lpss_read(struct pci_dwiic_softc *sc, int offset)
{
	return bus_space_read_4(sc->sc_dwiic.sc_iot, sc->sc_dwiic.sc_ioh,
	    offset);
}

static void
lpss_write(struct pci_dwiic_softc *sc, int offset, uint32_t val)
{
	bus_space_write_4(sc->sc_dwiic.sc_iot, sc->sc_dwiic.sc_ioh,
	    offset, val);
}

static int	pci_dwiic_match(device_t, cfdata_t, void *);
static void	pci_dwiic_attach(device_t, device_t, void *);
static bool	dwiic_pci_power(struct dwiic_softc *, bool);

CFATTACH_DECL_NEW(pcidwiic, sizeof(struct pci_dwiic_softc),
    pci_dwiic_match, pci_dwiic_attach, dwiic_detach, NULL);


int
pci_dwiic_match(device_t parent, cfdata_t match, void *aux)
{
	struct pci_attach_args *pa = aux;

	return pci_compatible_match(pa, compat_data);
}

void
pci_dwiic_attach(device_t parent, device_t self, void *aux)
{
	struct pci_dwiic_softc *sc = device_private(self);
	struct pci_attach_args *pa = aux;
	const char *intrstr;
	pci_intr_handle_t intrhandle;
	char intrbuf[PCI_INTRSTR_LEN];
	pcireg_t memtype;
	pcireg_t csr;
	uint32_t caps;

	sc->sc_dwiic.sc_dev = self;
	sc->sc_dwiic.sc_power = dwiic_pci_power;
	sc->sc_dwiic.sc_type = dwiic_type_sunrisepoint;

	sc->sc_pc = pa->pa_pc;
	sc->sc_ptag = pa->pa_tag;

	/* register access not enabled by BIOS */
	csr = pci_conf_read(pa->pa_pc, pa->pa_tag, PCI_COMMAND_STATUS_REG);
	pci_conf_write(pa->pa_pc, pa->pa_tag, PCI_COMMAND_STATUS_REG,
	    csr | PCI_COMMAND_MEM_ENABLE);

	memtype = pci_mapreg_type(pa->pa_pc, pa->pa_tag, PCI_BAR0);
	if (pci_mapreg_map(pa, PCI_BAR0, memtype, 0, &sc->sc_dwiic.sc_iot,
	    &sc->sc_dwiic.sc_ioh, NULL, NULL) != 0) {
		aprint_error(": can't map register space\n");
		goto out;
	}
	dwiic_pci_power(&sc->sc_dwiic, 1);

	caps = lpss_read(sc, LPSS_CAP);

	aprint_naive(": I2C controller\n");
	aprint_normal(": I2C controller instance %d\n",
	    (int)(caps & LPSS_CAP_INSTANCE));

	if (pci_intr_map(pa, &intrhandle)) {
		aprint_error_dev(self, "can't map interrupt\n");
		goto out;
	}
	intrstr = pci_intr_string(pa->pa_pc, intrhandle,
	    intrbuf, sizeof(intrbuf));

	sc->sc_dwiic.sc_ih = pci_intr_establish(pa->pa_pc, intrhandle,
	    IPL_VM, dwiic_intr, sc);
	if (sc->sc_dwiic.sc_ih == NULL) {
		aprint_error_dev(self, "couldn't establish interrupt");
		if (intrstr != NULL)
			aprint_error(" at %s", intrstr);
		aprint_error("\n");
		goto out;
	}
	aprint_normal_dev(self, "interrupting at %s\n", intrstr);

	lpss_write(sc, LPSS_RESET, LPSS_RESET_CTRL_REL);
	lpss_write(sc, LPSS_REMAP_LO,
	    pci_conf_read(sc->sc_pc, sc->sc_ptag, PCI_BAR0));
	lpss_write(sc, LPSS_REMAP_HI,
	    pci_conf_read(sc->sc_pc, sc->sc_ptag, PCI_BAR0 + 0x4));

#ifdef I2C_USE_ACPI
	sc->sc_acpinode = acpi_pcidev_find(0 /*XXX segment*/,
	    pa->pa_bus, pa->pa_device, pa->pa_function);
#else
	sc->sc_acpinode = NULL;
#endif

	if (sc->sc_acpinode) {
#ifdef I2C_USE_ACPI
		sc->sc_dwiic.sc_iba.iba_child_devices =
		    acpi_enter_i2c_devs(NULL, sc->sc_acpinode);
#endif
	} else {
		aprint_verbose_dev(self, "no matching ACPI node\n");
	}

	if (!dwiic_attach(&sc->sc_dwiic))
		goto out;

	config_found(self, &sc->sc_dwiic.sc_iba, iicbus_print, CFARGS_NONE);

	pmf_device_register(self, dwiic_suspend, dwiic_resume);

out:
	return;
}

static bool
dwiic_pci_power(struct dwiic_softc *dwsc, bool power)
{
	struct pci_dwiic_softc *sc = container_of(dwsc, struct pci_dwiic_softc,
	    sc_dwiic);
	pcireg_t pmreg, csr;
	uint32_t reset, rlo, rhi;

	csr = pci_conf_read(sc->sc_pc, sc->sc_ptag, PCI_COMMAND_STATUS_REG);
	reset = lpss_read(sc, LPSS_RESET);
	rlo = lpss_read(sc, LPSS_REMAP_LO);
	rhi = lpss_read(sc, LPSS_REMAP_HI);
	aprint_debug_dev(dwsc->sc_dev,
	    "status 0x%x reset 0x%x rlo 0x%x rhi 0x%x\n",
	    csr, reset, rlo, rhi);

	if (!power)
		lpss_write(sc, LPSS_CLKGATE, LPSS_CLKGATE_CTRL_OFF);
	if (pci_get_capability(sc->sc_pc, sc->sc_ptag, PCI_CAP_PWRMGMT,
	    &pmreg, NULL)) {
		DPRINTF(("%s: power status 0x%x", device_xname(dwsc->sc_dev),
		    pci_conf_read(sc->sc_pc, sc->sc_ptag, pmreg + PCI_PMCSR)));
		pci_conf_write(sc->sc_pc, sc->sc_ptag, pmreg + PCI_PMCSR,
		    power ? PCI_PMCSR_STATE_D0 : PCI_PMCSR_STATE_D3);
		DELAY(10000); /* 10 milliseconds */
		DPRINTF((" -> 0x%x\n",
		    pci_conf_read(sc->sc_pc, sc->sc_ptag, pmreg + PCI_PMCSR)));
	}
	if (power) {
		lpss_write(sc, LPSS_CLKGATE, LPSS_CLKGATE_CTRL_ON);
	}
	return true;
}