root/sys/dev/i2c/tsl256xreg.h
/* $NetBSD: tsl256xreg.h,v 1.2 2021/01/04 21:59:48 thorpej Exp $ */

/*-
 * Copyright (c) 2018 Jason R. Thorpe
 * 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.
 */

#ifndef tsl256xreg_h_included
#define tsl256xreg_h_included

/*
 * Hardware definitions for the TAOS TSL2560 (SMBus) and TSL2561 (I2C).
 *
 * These devices combine a broadband photodiode (visible light + infrared)
 * and an additional ifrared phtodiode onto a single CMOS integrated circuit.
 * The devices include programmable thresholds that can trigger SMB-Alert
 * type interrupts (TSL2560) or a traditional level-triggered interrupt
 * (TSL2561) that remains asserted until cleared.
 */

/*
 * Valid I2C addresses for the TSL2561.  The address is selected based
 * on how the ADDR_SEL pin is connected.
 */
#define TSL256x_SLAVEADDR_GND   0x29    /* ADDR SEL tied to ground */
#define TSL256x_SLAVEADDR_FLOAT 0x39    /* ADDR SEL left floating */
#define TSL256x_SLAVEADDR_VDD   0x49    /* ADDR SEL tied to Vdd */
#define TSL256x_SMB_ALERT_ADDR  0x0c    /* SMB Alert address (all configs) */

/*
 * TSL256x register definitions.
 */

/* COMMAND - Specifies register address and other parameters */
#define COMMAND6x_REGMASK               0x0f    /* register address mask */
#define COMMAND6x_BLOCK         0x10    /* transaction uses block read/write */
#define COMMAND6x_WORD          0x20    /* transaction uses word read/write */
#define COMMAND6x_CLEAR         0x40    /* clear pending interrupt */
#define COMMAND6x_CMD           0x80    /* Select command register; MBO */


/* CONTROL - Control of basic functions */
#define TSL256x_REG_CONTROL     0x0
#define CONTROL6x_POWER_OFF     0x00
#define CONTROL6x_POWER_ON      0x03


/* TIMING - Integration time / gain control */
#define TSL256x_REG_TIMING      0x1
#define TIMING6x_INTEG_13_7ms   0x00    /* 13.7ms integration time */
#define TIMING6x_INTEG_101ms    0x01    /* 101ms integration time */
#define TIMING6x_INTEG_402ms    0x02    /* 402ms integration time */
#define TIMING6x_INTEG_MANUAL   0x03    /* use manual timing */
#define TIMING6x_MANUAL         0x08    /* manual timing; 1 starts, 0 stops */
#define TIMING6x_GAIN_1X        0x00
#define TIMING6x_GAIN_16X       0x10


/* THRESHLOWLOW - Low byte of low interrupt threshold */
#define TSL256x_REG_LOWLOW      0x2


/* THRESHLOWHIGH - High byte of low interrupt threshold */
#define TSL256x_REG_LOWHIGH     0x3


/* THRESHHIGHLOW - Low byte of high interrupt threshold */
#define TSL256x_REG_HIGHLOW     0x4


/* THRESHHIGHHIGH - High byte of high interrupt threshold */
#define TSL256x_REG_HIGHHIGH    0x5


/* INTERRUPT - Interrupt control */
#define TSL256x_REG_INTERRUPT   0x6
#define INTERRUPT6x_LEVEL       0x01    /* Level-triggered interrupt */
#define INTERRUPT6x_SMB_ALERT   0x02    /* SMB Alert compliant interrupt */
#define INTERRUPT6x_TEST        0x03    /* interrupt test */
#define INTERRUPT6x_PERSIST(x)  ((x) << 4)
                /*
                 * Interrupt persist settings:
                 * 0 - Every ADC cycle generates an interrupt
                 * 1..15 - # integration periods outside threshold range
                 */


/* 0x7 - Reserved */


/* CRC - Factory test -- not a user register */
#define TSL256x_REG_CRC         0x8


/* 0x9 - Reserved */


/* ID - Part number / Rev ID */
#define TSL256x_REG_ID          0xa
#define ID6x_GET_PARTNO(x)      (((x) & 0xf0) >> 4)
#define         ID6x_PARTNO_TSL2560     0x0
#define         ID6x_PARTNO_TSL2561     0x1
#define ID6x_GET_REVNO(x)       ((x) & 0x0f)


/* 0xb - Reserved */


/* DATA0LOW - Low byte of ADC channel 0 */
#define TSL256x_REG_DATA0LOW    0xc


/* DATA0HIGH - High byte of ADC channel 0 */
#define TSL256x_REG_DATA0HIGH   0xd


/* DATA1LOW - Low byte of ADC channel 1 */
#define TSL256x_REG_DATA1LOW    0xe


/* DATA1HIGH - High byte of ADC channel 1 */
#define TSL256x_REG_DATA1HIGH   0xf

#endif /* tsl256xreg_h_included */