NetBSD/sys/arch/i386/pci/geode.c
dyoung f66403a698 Move my bit-twiddling macros to libkern.h from my drivers, where
I had duplicated them.  Improve the macros' names.  Simplify their
implementation.

A brief description of each macro is below.

        BIT(n): Return a bitmask with bit m set, where the least
                significant bit is bit 0.

        BITS(m, n): Return a bitmask with bits m through n, inclusive,
                    set.  It does not matter whether m>n or m<=n.
                    The least significant bit is bit 0.

        A "bitfield" is a span of consecutive bits defined by a
        bitmask, where 1s select the bits in the bitfield.  SHIFTIN,
        SHIFTOUT, and SHIFTOUT_MASK help read and write bitfields
        from device registers.

        SHIFTIN(v, mask): Left-shift bits `v' into the bitfield
                          defined by `mask', and return them.  No
                          side-effects.

        SHIFTOUT(v, mask): Extract and return the bitfield selected
                           by `mask' from `v', right-shifting the
                           bits so that the rightmost selected bit
                           is at bit 0.  No side-effects.

        SHIFTOUT_MASK(mask): Right-shift the bits in `mask' so that
                             the rightmost non-zero bit is at bit
                             0.  This is useful for finding the
                             greatest unsigned value that a bitfield
                             can hold.  No side-effects.  Note that
                             SHIFTOUT_MASK(m) = SHIFTOUT(m, m).

Examples:

/*
 * Register definitions taken from the RFMD RF3000 manual.
 */
#define RF3000_GAINCTL          0x11            /* TX variable gain control */
#define         RF3000_GAINCTL_TXVGC_MASK       BITS(7, 2)
#define         RF3000_GAINCTL_SCRAMBLER        BIT(1)

/*
 * Shift the transmit power into the transmit-power field of the
 * gain-control register and write it to the baseband processor.
 */
atw_rf3000_write(sc, RF3000_GAINCTL,
    SHIFTIN(txpower, RF3000_GAINCTL_TXVGC_MASK));


/*
 * Register definitions taken from the ADMtek ADM8211 manual.
 *
 */
#define ATW_RXSTAT_OWN          BIT(31)         /* 1: NIC may fill descriptor */
/* ... */
#define ATW_RXSTAT_DA1          BIT(17)         /* DA bit 1, admin'd address */
#define ATW_RXSTAT_DA0          BIT(16)         /* DA bit 0, group address */
#define ATW_RXSTAT_RXDR_MASK    BITS(15,12)     /* RX data rate */
#define ATW_RXSTAT_FL_MASK      BITS(11,0)      /* RX frame length, last
                                                 * descriptor only
                                                 */

/* Extract the frame length from the Rx descriptor's
 * status field.
 */
len = SHIFTOUT(rxstat, ATW_RXSTAT_FL_MASK);
2006-03-08 00:24:06 +00:00

289 lines
9.1 KiB
C

/* $NetBSD: geode.c,v 1.5 2006/03/08 00:24:06 dyoung Exp $ */
/*-
* Copyright (c) 2005 David Young. All rights reserved.
*
* This code was written by David Young.
*
* 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.
* 3. All advertising materials mentioning features or use of this software
* must display the following acknowledgement:
* This product includes software developed by David Young.
* 4. The name of David Young may not be used to endorse or promote
* products derived from this software without specific prior
* written permission.
*
* THIS SOFTWARE IS PROVIDED BY DAVID YOUNG ``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 DAVID
* YOUNG 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.
*/
/*-
* Copyright (c) 2002 The NetBSD Foundation, Inc.
* All rights reserved.
*
* This code is derived from software contributed to The NetBSD Foundation
* by Jason R. Thorpe.
*
* 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.
* 3. All advertising materials mentioning features or use of this software
* must display the following acknowledgement:
* This product includes software developed by the NetBSD
* Foundation, Inc. and its contributors.
* 4. Neither the name of The NetBSD Foundation nor the names of its
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* 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.
*/
/*
* Device driver for the watchdog timer built into the
* AMD Geode SC1100 processor.
*/
#include <sys/cdefs.h>
__KERNEL_RCSID(0, "$NetBSD: geode.c,v 1.5 2006/03/08 00:24:06 dyoung Exp $");
#include <sys/param.h>
#include <sys/systm.h>
#include <sys/device.h>
#include <sys/wdog.h>
#include <uvm/uvm_extern.h>
#include <machine/bus.h>
#include <dev/pci/pcivar.h>
#include <dev/pci/pcidevs.h>
#include <arch/i386/pci/geodereg.h>
#include <dev/sysmon/sysmonvar.h>
#ifdef GEODE_DEBUG
#define GEODE_DPRINTF(__x) printf __x
#else /* GEODE_DEBUG */
#define GEODE_DPRINTF(__x) /* nothing */
#endif
struct geode_wdog_softc {
struct device sc_dev;
bus_space_tag_t sc_iot;
bus_space_handle_t sc_ioh;
uint16_t sc_countdown;
uint8_t sc_prescale;
struct sysmon_wdog sc_smw;
};
static void
geode_wdog_disable(struct geode_wdog_softc *sc)
{
uint16_t wdcnfg;
/* cancel any pending countdown */
sc->sc_countdown = 0;
bus_space_write_2(sc->sc_iot, sc->sc_ioh, SC1100_GCB_WDTO, 0);
/* power-down clock */
wdcnfg = bus_space_read_2(sc->sc_iot, sc->sc_ioh,
SC1100_GCB_WDCNFG);
GEODE_DPRINTF(("%s: wdcnfg %#04" PRIx16 " -> ", __func__, wdcnfg));
wdcnfg |= SC1100_WDCNFG_WD32KPD;
wdcnfg &= ~(SC1100_WDCNFG_WDTYPE2_MASK | SC1100_WDCNFG_WDTYPE1_MASK);
/* This no-op is for the reader's benefit. */
wdcnfg |= SC1100_WDCNFG_WDTYPE1_NOACTION |
SC1100_WDCNFG_WDTYPE2_NOACTION;
bus_space_write_2(sc->sc_iot, sc->sc_ioh, SC1100_GCB_WDCNFG, wdcnfg);
GEODE_DPRINTF(("%#04" PRIx16 "\n", wdcnfg));
}
static void
geode_wdog_enable(struct geode_wdog_softc *sc)
{
uint16_t wdcnfg;
/* power-up clock and set prescale */
wdcnfg = bus_space_read_2(sc->sc_iot, sc->sc_ioh, SC1100_GCB_WDCNFG);
GEODE_DPRINTF(("%s: wdcnfg %#04" PRIx16 " -> ", __func__, wdcnfg));
wdcnfg &= ~(SC1100_WDCNFG_WD32KPD | SC1100_WDCNFG_WDPRES_MASK |
SC1100_WDCNFG_WDTYPE1_MASK | SC1100_WDCNFG_WDTYPE2_MASK);
wdcnfg |= SHIFTIN(sc->sc_prescale, SC1100_WDCNFG_WDPRES_MASK);
wdcnfg |= SC1100_WDCNFG_WDTYPE1_RESET | SC1100_WDCNFG_WDTYPE2_NOACTION;
bus_space_write_2(sc->sc_iot, sc->sc_ioh, SC1100_GCB_WDCNFG, wdcnfg);
GEODE_DPRINTF(("%#04" PRIx16 "\n", wdcnfg));
}
static void
geode_wdog_reset(struct geode_wdog_softc *sc)
{
/* set countdown */
bus_space_write_2(sc->sc_iot, sc->sc_ioh, SC1100_GCB_WDTO,
sc->sc_countdown);
}
static int
geode_wdog_tickle(struct sysmon_wdog *smw)
{
int s;
struct geode_wdog_softc *sc = smw->smw_cookie;
s = splhigh();
geode_wdog_reset(sc);
splx(s);
return 0;
}
static int
geode_wdog_setmode(struct sysmon_wdog *smw)
{
struct geode_wdog_softc *sc = smw->smw_cookie;
uint32_t ticks;
int prescale, s;
if ((smw->smw_mode & WDOG_MODE_MASK) == WDOG_MODE_DISARMED) {
s = splhigh();
geode_wdog_disable(sc);
splx(s);
return 0;
}
if (smw->smw_period == WDOG_PERIOD_DEFAULT)
smw->smw_period = 32;
else if (smw->smw_period > SC1100_WDIVL_MAX) /* too big? */
return EINVAL;
GEODE_DPRINTF(("%s: period %u\n", __func__, smw->smw_period));
ticks = smw->smw_period * SC1100_WDCLK_HZ;
GEODE_DPRINTF(("%s: ticks0 %" PRIu32 "\n", __func__, ticks));
for (prescale = 0; ticks > UINT16_MAX; prescale++)
ticks /= 2;
GEODE_DPRINTF(("%s: ticks %" PRIu32 "\n", __func__, ticks));
GEODE_DPRINTF(("%s: prescale %d\n", __func__, prescale));
KASSERT(prescale <= SC1100_WDCNFG_WDPRES_MAX);
KASSERT(ticks <= UINT16_MAX);
s = splhigh();
sc->sc_prescale = (uint8_t)prescale;
sc->sc_countdown = (uint16_t)ticks;
geode_wdog_enable(sc);
geode_wdog_reset(sc);
splx(s);
return 0;
}
static int
geode_wdog_match(struct device *parent, struct cfdata *match, void *aux)
{
struct pci_attach_args *pa = aux;
if (PCI_VENDOR(pa->pa_id) == PCI_VENDOR_NS &&
PCI_PRODUCT(pa->pa_id) == PCI_PRODUCT_NS_SC1100_XBUS)
return (10); /* XXX beat pchb? -dyoung */
return (0);
}
static void
geode_wdog_attach(struct device *parent, struct device *self, void *aux)
{
struct geode_wdog_softc *sc = (void *) self;
struct pci_attach_args *pa = aux;
uint32_t cba;
uint8_t wdsts;
aprint_naive(": Watchdog Timer\n");
aprint_normal(": AMD Geode SC1100 Watchdog Timer\n");
cba = pci_conf_read(pa->pa_pc, pa->pa_tag, SC1100_XBUS_CBA_SCRATCHPAD);
sc->sc_iot = pa->pa_iot;
if (bus_space_map(sc->sc_iot, (bus_addr_t)cba, SC1100_GCB_SIZE, 0,
&sc->sc_ioh) != 0) {
aprint_error("%s: unable to map registers\n",
sc->sc_dev.dv_xname);
return;
}
GEODE_DPRINTF(("%s: mapped %u bytes at %#08" PRIx32 "\n",
sc->sc_dev.dv_xname, SC1100_GCB_SIZE, cba));
/*
* Determine cause of the last reset, and issue a warning if it
* was due to watchdog expiry.
*/
wdsts = bus_space_read_1(sc->sc_iot, sc->sc_ioh, SC1100_GCB_WDSTS);
GEODE_DPRINTF(("%s: status %#02" PRIx8 "\n", sc->sc_dev.dv_xname,
wdsts));
if (wdsts & SC1100_WDSTS_WDRST)
aprint_error(
"%s: WARNING: LAST RESET DUE TO WATCHDOG EXPIRATION!\n",
sc->sc_dev.dv_xname);
/* reset WDOVF by writing 1 to it */
bus_space_write_1(sc->sc_iot, sc->sc_ioh, SC1100_GCB_WDSTS,
wdsts & SC1100_WDSTS_WDOVF);
/*
* Hook up the watchdog timer.
*/
sc->sc_smw.smw_name = sc->sc_dev.dv_xname;
sc->sc_smw.smw_cookie = sc;
sc->sc_smw.smw_setmode = geode_wdog_setmode;
sc->sc_smw.smw_tickle = geode_wdog_tickle;
sc->sc_smw.smw_period = 32;
if (sysmon_wdog_register(&sc->sc_smw) != 0)
aprint_error("%s: unable to register watchdog with sysmon\n",
sc->sc_dev.dv_xname);
/* cancel any pending countdown */
geode_wdog_disable(sc);
}
CFATTACH_DECL(geodewdog, sizeof(struct geode_wdog_softc),
geode_wdog_match, geode_wdog_attach, NULL, NULL);