sys/dev/superio/superio.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause
   3  *
   4  * Copyright (c) 2019 Andriy Gapon
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25  * SUCH DAMAGE.
  26  *
  27  * $FreeBSD$
  28  */
  29
  30 #ifndef SUPERIO_H
  31 #define SUPERIO_H
  32
  33 typedef enum superio_vendor {
  34         SUPERIO_VENDOR_NONE,
  35         SUPERIO_VENDOR_ITE,
  36         SUPERIO_VENDOR_NUVOTON,
  37         SUPERIO_VENDOR_FINTEK,
  38         SUPERIO_VENDOR_MAX
  39 } superio_vendor_t;
  40
  41 typedef enum superio_dev_type {
  42         SUPERIO_DEV_NONE,
  43         SUPERIO_DEV_HWM,
  44         SUPERIO_DEV_WDT,
  45         SUPERIO_DEV_GPIO,
  46         SUPERIO_DEV_MAX
  47 } superio_dev_type_t;
  48
  49 superio_vendor_t superio_vendor(device_t dev);
  50 uint16_t superio_devid(device_t dev);
  51 uint8_t superio_revid(device_t dev);
  52 uint8_t superio_read(device_t dev, uint8_t reg);
  53 void superio_write(device_t dev, uint8_t reg, uint8_t val);
  54 bool superio_dev_enabled(device_t dev, uint8_t mask);
  55 void superio_dev_enable(device_t dev, uint8_t mask);
  56 void superio_dev_disable(device_t dev, uint8_t mask);
  57
  58 device_t superio_find_dev(device_t superio, superio_dev_type_t type,
  59     int ldn);
  60
  61 enum superio_ivars {
  62         SUPERIO_IVAR_LDN =      10600,
  63         SUPERIO_IVAR_TYPE,
  64         SUPERIO_IVAR_IOBASE,
  65         SUPERIO_IVAR_IOBASE2,
  66         SUPERIO_IVAR_IRQ,
  67         SUPERIO_IVAR_DMA
  68 };
  69
  70 #define SUPERIO_ACCESSOR(var, ivar, type)                               \
  71         __BUS_ACCESSOR(superio, var, SUPERIO, ivar, type)
  72
  73 SUPERIO_ACCESSOR(ldn,           LDN,            uint8_t)
  74 SUPERIO_ACCESSOR(type,          TYPE,           superio_dev_type_t)
  75 SUPERIO_ACCESSOR(iobase,        IOBASE,         uint16_t)
  76 SUPERIO_ACCESSOR(iobase2,       IOBASE2,        uint16_t)
  77 SUPERIO_ACCESSOR(irq,           IRQ,            uint8_t)
  78 SUPERIO_ACCESSOR(dma,           DMA,            uint8_t)
  79
  80 #undef SUPERIO_ACCESSOR
  81
  82 #endif /*SUPERIO_H*/