/* $NetBSD: tadpmureg.h,v 1.3 2020/05/16 07:16:14 jdc Exp $ */

/*-
* Copyright (c) 2018 Michael Lorenz <[email protected]>
* All rights reserved.
*
* 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.
*/

/* registers and commands for the PMU found in Tadpole SPARCle/Viper laptops */

#ifndef TADPMUREG_H
#define TADPMUREG_H

/* all values were found by looking at OF methods on the tadpmu node */

/* these registers live in the pckbc's address space */
#define TADPMU_CMD      0x6
#define TADPMU_STATUS   0x6
#define TADPMU_DATA     0x2

#define STATUS_HAVE_DATA        0x01    /* response from command */
#define STATUS_CMD_IN_PROGRESS  0x02
#define STATUS_INTR             0x04    /* interrupt happened, read data to ack */
#define STATUS_SEND_DATA        0x08    /* cmd waiting for data */

#define CMD_SET_OPMODE          0x41    /* not sure what exactly this does... */
#define         OPMODE_UNIX     0x75    /* other than toggling the UNIX mode  */
#define         OPMODE_OF       0x67    /* bit in the GENSTAT register        */
#define         OPMODE_DBG_ON   0x64    /* Debug ON */
#define         OPMODE_DBG_OFF  0x6E    /* Debug OFF */
#define         OPMODE_OBP      0x6F
#define CMD_CHRGCTL             0x42
#define CMD_SET_BACKLIGHT       0x43    /* apparently 0 - 1f */
#define CMD_SET_CPUSPEED        0x44    /* in 10MHz, so 120 == 1.2GHz */
#define CMD_SET_SPREADCLK       0x45
#define CMD_SET_FANSPEED        0x46
#define CMD_SET_VOLUME          0x48    /* beeper volume */
#define CMD_SET_DIR_CLK         0x80
#define CMD_WRITE               0xC0

#define CMD_READ_GENSTAT        0x10
#define CMD_READ_BACKLIGHT      0x11
#define CMD_READ_SYSTEMP        0x12    /* temperature */
#define CMD_READ_VOLUME         0x13
#define CMD_READ_VBATT          0x14    /* Voltage * 10 (e.g. 120 = 12.0v) */
#define CMD_READ_VERSION        0x15
#define CMD_READ_CPUSPEED       0x16
#define CMD_READ_KEYSTAT        0x17    /* Pause-A, D, N, O, R */
#define CMD_READ_FAN_EN         0x18    /* Fan(s): off=0x00, full=0x77 */
#define CMD_READ_GENSTAT2       0x19
#define READ_DIPSWITCH          0x1A

#define CMD_READ_FANSPEED       0x50    /* takes a parameter, returns nothing? */

#define CMD_SHUTDOWN            0x40
#define CMD_BEEP                0x47    /* Start/stop beep, param is freq */
#define CMD_READ_BMU            0x70
#define CMD_REFLASH             0x49
#define CMD_READ                0x89
#define CMD_WRITE               0xC0
#define CMD_WRITE_BMU           0xC1

/* these are according to the ROM methods
  #define GENSTAT_DC_PRESENT           0x01
  #define GENSTAT_DC_ENABLE            0x02
  #define GENSTAT_BATTERY_PRESENT      0x04
  #define GENSTAT_BATTERY_CHARGING     0x08
  #define GENSTAT_LID_CLOSED           0x10
  #define GENSTAT_UNIX_MODE            0x20
  #define GENSTAT_SPREADSPECTRUM       0x40

  Values of genstat (from observation)
  0b = on battery
  3b = battery charging
  1f = battery full
  1b = no battery
*/
#define GENSTAT_UNIX_MODE               0x01
#define GENSTAT_BATTERY_PRESENT         0x04    /* only valid if DC present? */
#define GENSTAT_BATTERY_CHARGED         0x08
#define GENSTAT_DC_PRESENT              0x10
#define GENSTAT_BATTERY_CHARGING        0x20
#define GENSTAT_LID_CLOSED              0x80

#define GENSTAT_STATE_BATTERY_FULL      0x1f
#define GENSTAT_STATE_BATTERY_DISCHARGE 0x0b
#define GENSTAT_STATE_BATTERY_CHARGE    0x3b

#define GENSTAT2_DEBUG          0x01            /* PMU debug enable? */
#define GENSTAT2_MUTE           0x02

/* messages from interrupts */
#define TADPMU_INTR_BATTERY_CHARGED     0x03
#define TADPMU_INTR_DCPOWER             0x04
#define TADPMU_INTR_LID                 0x05
#define TADPMU_INTR_POWERBUTTON         0x06
#define TADPMU_INTR_BATTERY_VOLT        0xcd    /* Voltage change */
#define TADPMU_INTR_BATTERY_STATE       0xd6    /* e.g. warn -> crit */
/* Other observed values:
   0xc9
   0xcb
   0xd2
*/

#endif /* TADPMUREG_H */