xref: /openbmc/linux/drivers/iio/pressure/zpa2326.h (revision 03b262f2)
103b262f2SGregor Boirie /*
203b262f2SGregor Boirie  * Murata ZPA2326 pressure and temperature sensor IIO driver
303b262f2SGregor Boirie  *
403b262f2SGregor Boirie  * Copyright (c) 2016 Parrot S.A.
503b262f2SGregor Boirie  *
603b262f2SGregor Boirie  * Author: Gregor Boirie <gregor.boirie@parrot.com>
703b262f2SGregor Boirie  *
803b262f2SGregor Boirie  * This program is free software; you can redistribute it and/or modify it
903b262f2SGregor Boirie  * under the terms of the GNU General Public License version 2 as published by
1003b262f2SGregor Boirie  * the Free Software Foundation.
1103b262f2SGregor Boirie  *
1203b262f2SGregor Boirie  * This program is distributed in the hope that it will be useful, but WITHOUT
1303b262f2SGregor Boirie  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
1403b262f2SGregor Boirie  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
1503b262f2SGregor Boirie  * more details.
1603b262f2SGregor Boirie  */
1703b262f2SGregor Boirie 
1803b262f2SGregor Boirie #ifndef _ZPA2326_H
1903b262f2SGregor Boirie #define _ZPA2326_H
2003b262f2SGregor Boirie 
2103b262f2SGregor Boirie /* Register map. */
2203b262f2SGregor Boirie #define ZPA2326_REF_P_XL_REG              (0x8)
2303b262f2SGregor Boirie #define ZPA2326_REF_P_L_REG               (0x9)
2403b262f2SGregor Boirie #define ZPA2326_REF_P_H_REG               (0xa)
2503b262f2SGregor Boirie #define ZPA2326_DEVICE_ID_REG             (0xf)
2603b262f2SGregor Boirie #define ZPA2326_DEVICE_ID                 (0xb9)
2703b262f2SGregor Boirie #define ZPA2326_RES_CONF_REG              (0x10)
2803b262f2SGregor Boirie #define ZPA2326_CTRL_REG0_REG             (0x20)
2903b262f2SGregor Boirie #define ZPA2326_CTRL_REG0_ONE_SHOT        BIT(0)
3003b262f2SGregor Boirie #define ZPA2326_CTRL_REG0_ENABLE          BIT(1)
3103b262f2SGregor Boirie #define ZPA2326_CTRL_REG1_REG             (0x21)
3203b262f2SGregor Boirie #define ZPA2326_CTRL_REG1_MASK_DATA_READY BIT(2)
3303b262f2SGregor Boirie #define ZPA2326_CTRL_REG2_REG             (0x22)
3403b262f2SGregor Boirie #define ZPA2326_CTRL_REG2_SWRESET         BIT(2)
3503b262f2SGregor Boirie #define ZPA2326_CTRL_REG3_REG             (0x23)
3603b262f2SGregor Boirie #define ZPA2326_CTRL_REG3_ODR_SHIFT       (4)
3703b262f2SGregor Boirie #define ZPA2326_CTRL_REG3_ENABLE_MEAS     BIT(7)
3803b262f2SGregor Boirie #define ZPA2326_INT_SOURCE_REG            (0x24)
3903b262f2SGregor Boirie #define ZPA2326_INT_SOURCE_DATA_READY     BIT(2)
4003b262f2SGregor Boirie #define ZPA2326_THS_P_LOW_REG             (0x25)
4103b262f2SGregor Boirie #define ZPA2326_THS_P_HIGH_REG            (0x26)
4203b262f2SGregor Boirie #define ZPA2326_STATUS_REG                (0x27)
4303b262f2SGregor Boirie #define ZPA2326_STATUS_P_DA               BIT(1)
4403b262f2SGregor Boirie #define ZPA2326_STATUS_FIFO_E             BIT(2)
4503b262f2SGregor Boirie #define ZPA2326_STATUS_P_OR               BIT(5)
4603b262f2SGregor Boirie #define ZPA2326_PRESS_OUT_XL_REG          (0x28)
4703b262f2SGregor Boirie #define ZPA2326_PRESS_OUT_L_REG           (0x29)
4803b262f2SGregor Boirie #define ZPA2326_PRESS_OUT_H_REG           (0x2a)
4903b262f2SGregor Boirie #define ZPA2326_TEMP_OUT_L_REG            (0x2b)
5003b262f2SGregor Boirie #define ZPA2326_TEMP_OUT_H_REG            (0x2c)
5103b262f2SGregor Boirie 
5203b262f2SGregor Boirie struct device;
5303b262f2SGregor Boirie struct regmap;
5403b262f2SGregor Boirie 
5503b262f2SGregor Boirie bool zpa2326_isreg_writeable(struct device *dev, unsigned int reg);
5603b262f2SGregor Boirie bool zpa2326_isreg_readable(struct device *dev, unsigned int reg);
5703b262f2SGregor Boirie bool zpa2326_isreg_precious(struct device *dev, unsigned int reg);
5803b262f2SGregor Boirie 
5903b262f2SGregor Boirie /**
6003b262f2SGregor Boirie  * zpa2326_probe() - Instantiate and register core ZPA2326 IIO device
6103b262f2SGregor Boirie  * @parent: Hardware sampling device the created IIO device will be a child of.
6203b262f2SGregor Boirie  * @name:   Arbitrary name to identify the device.
6303b262f2SGregor Boirie  * @irq:    Interrupt line, negative if none.
6403b262f2SGregor Boirie  * @hwid:   Expected device hardware id.
6503b262f2SGregor Boirie  * @regmap: Registers map used to abstract underlying bus accesses.
6603b262f2SGregor Boirie  *
6703b262f2SGregor Boirie  * Return: Zero when successful, a negative error code otherwise.
6803b262f2SGregor Boirie  */
6903b262f2SGregor Boirie int zpa2326_probe(struct device        *parent,
7003b262f2SGregor Boirie 		  const char           *name,
7103b262f2SGregor Boirie 		  int                   irq,
7203b262f2SGregor Boirie 		  unsigned int          hwid,
7303b262f2SGregor Boirie 		  struct regmap        *regmap);
7403b262f2SGregor Boirie 
7503b262f2SGregor Boirie /**
7603b262f2SGregor Boirie  * zpa2326_remove() - Unregister and destroy core ZPA2326 IIO device.
7703b262f2SGregor Boirie  * @parent: Hardware sampling device the IIO device to remove is a child of.
7803b262f2SGregor Boirie  */
7903b262f2SGregor Boirie void zpa2326_remove(const struct device *parent);
8003b262f2SGregor Boirie 
8103b262f2SGregor Boirie #ifdef CONFIG_PM
8203b262f2SGregor Boirie #include <linux/pm.h>
8303b262f2SGregor Boirie extern const struct dev_pm_ops zpa2326_pm_ops;
8403b262f2SGregor Boirie #define ZPA2326_PM_OPS (&zpa2326_pm_ops)
8503b262f2SGregor Boirie #else
8603b262f2SGregor Boirie #define ZPA2326_PM_OPS (NULL)
8703b262f2SGregor Boirie #endif
8803b262f2SGregor Boirie 
8903b262f2SGregor Boirie #endif
90