diff mbox series

[v2,1/2] hw/misc: Add Infineon DPS310 sensor model

Message ID 20210616073358.750472-2-joel@jms.id.au
State New
Headers show
Series hw/misc: DPS310 temp and pressure sensor model | expand

Commit Message

Joel Stanley June 16, 2021, 7:33 a.m. UTC 
This contains some hardcoded register values that were obtained from the
hardware after reading the temperature.

It does enough to test the Linux kernel driver. The FIFO mode, IRQs and
operation modes other than the default as used by Linux are not modelled.

Signed-off-by: Joel Stanley <joel@jms.id.au>

---
v2:
 - remove unused class
 - remove use of GENMASK
 - move reg reset state into an array
 - remove half implemented get/set callbacks
 - set NUM_REGISTERS to 0x33, avoid special casing undocumented register
 - use device_cold_reset
 - add buildtime assert for array size
---
 hw/misc/dps310.c    | 231 ++++++++++++++++++++++++++++++++++++++++++++
 hw/arm/Kconfig      |   1 +
 hw/misc/Kconfig     |   4 +
 hw/misc/meson.build |   1 +
 4 files changed, 237 insertions(+)
 create mode 100644 hw/misc/dps310.c

-- 
2.32.0

Comments

Cédric Le Goater June 16, 2021, 9:09 a.m. UTC | #1 
On 6/16/21 9:33 AM, Joel Stanley wrote:
> This contains some hardcoded register values that were obtained from the

> hardware after reading the temperature.

> 

> It does enough to test the Linux kernel driver. The FIFO mode, IRQs and

> operation modes other than the default as used by Linux are not modelled.

> 

> Signed-off-by: Joel Stanley <joel@jms.id.au>


Reviewed-by: Cédric Le Goater <clg@kaod.org>


Some minor comments,

> ---

> v2:

>  - remove unused class

>  - remove use of GENMASK

>  - move reg reset state into an array

>  - remove half implemented get/set callbacks

>  - set NUM_REGISTERS to 0x33, avoid special casing undocumented register

>  - use device_cold_reset

>  - add buildtime assert for array size

> ---

>  hw/misc/dps310.c    | 231 ++++++++++++++++++++++++++++++++++++++++++++

>  hw/arm/Kconfig      |   1 +

>  hw/misc/Kconfig     |   4 +

>  hw/misc/meson.build |   1 +

>  4 files changed, 237 insertions(+)

>  create mode 100644 hw/misc/dps310.c

> 

> diff --git a/hw/misc/dps310.c b/hw/misc/dps310.c

> new file mode 100644

> index 000000000000..82b727ab4287

> --- /dev/null

> +++ b/hw/misc/dps310.c

> @@ -0,0 +1,231 @@

> +// SPDX-License-Identifier: GPL-2.0-or-later

> +/*

> + * Copyright 2017 Joel Stanley <joel@jms.id.au>, IBM Corporation

> + *

> + * Infineon DPS310 temperature and himidity sensor

> + *

> + * https://www.infineon.com/cms/en/product/sensor/pressure-sensors/pressure-sensors-for-iot/dps310/

> + */

> +

> +#include "qemu/osdep.h"

> +#include "qemu/log.h"

> +#include "hw/hw.h"

> +#include "hw/i2c/i2c.h"

> +#include "qapi/error.h"

> +#include "qapi/visitor.h"

> +#include "migration/vmstate.h"

> +

> +#define NUM_REGISTERS   0x33

> +

> +typedef struct DPS310State {

> +    /*< private >*/

> +    I2CSlave i2c;

> +

> +    /*< public >*/

> +    uint8_t regs[NUM_REGISTERS];

> +

> +    int16_t pressure, temperature;



We don't need those fields anymore. I will remove them if you are ok
with that. 

Thanks,

C. 

> +

> +    uint8_t len;

> +    uint8_t buf[2];

> +    uint8_t pointer;

> +

> +} DPS310State;

> +

> +#define TYPE_DPS310 "dps310"

> +#define DPS310(obj) OBJECT_CHECK(DPS310State, (obj), TYPE_DPS310)

> +

> +#define DPS310_PRS_B2           0x00

> +#define DPS310_PRS_B1           0x01

> +#define DPS310_PRS_B0           0x02

> +#define DPS310_TMP_B2           0x03

> +#define DPS310_TMP_B1           0x04

> +#define DPS310_TMP_B0           0x05

> +#define DPS310_PRS_CFG          0x06

> +#define DPS310_TMP_CFG          0x07

> +#define  DPS310_TMP_RATE_BITS   (0x70)

> +#define DPS310_MEAS_CFG         0x08

> +#define  DPS310_MEAS_CTRL_BITS  (0x07)

> +#define   DPS310_PRESSURE_EN    BIT(0)

> +#define   DPS310_TEMP_EN        BIT(1)

> +#define   DPS310_BACKGROUND     BIT(2)

> +#define  DPS310_PRS_RDY         BIT(4)

> +#define  DPS310_TMP_RDY         BIT(5)

> +#define  DPS310_SENSOR_RDY      BIT(6)

> +#define  DPS310_COEF_RDY        BIT(7)

> +#define DPS310_CFG_REG          0x09

> +#define DPS310_RESET            0x0c

> +#define  DPS310_RESET_MAGIC     (BIT(0) | BIT(3))

> +#define DPS310_COEF_BASE        0x10

> +#define DPS310_COEF_LAST        0x21

> +#define DPS310_COEF_SRC         0x28

> +

> +static void dps310_reset(DeviceState *dev)

> +{

> +    DPS310State *s = DPS310(dev);

> +

> +    static const uint8_t regs_reset_state[] = {

> +        0xfe, 0x2f, 0xee, 0x02, 0x69, 0xa6, 0x00, 0x80, 0xc7, 0x00, 0x00, 0x00,

> +        0x00, 0x10, 0x00, 0x00, 0x0e, 0x1e, 0xdd, 0x13, 0xca, 0x5f, 0x21, 0x52,

> +        0xf9, 0xc6, 0x04, 0xd1, 0xdb, 0x47, 0x00, 0x5b, 0xfb, 0x3a, 0x00, 0x00,

> +        0x20, 0x49, 0x4e, 0xa5, 0x90, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,

> +        0x60, 0x15, 0x02

> +    };

> +

> +    QEMU_BUILD_BUG_ON(sizeof(regs_reset_state) != sizeof(s->regs));

> +

> +    memcpy(s->regs, regs_reset_state, sizeof(s->regs));

> +    s->pointer = 0;

> +

> +    /* TODO: assert these after some timeout ? */

> +    s->regs[DPS310_MEAS_CFG] = DPS310_COEF_RDY | DPS310_SENSOR_RDY

> +        | DPS310_TMP_RDY | DPS310_PRS_RDY;

> +}

> +

> +static void dps310_read(DPS310State *s)

> +{

> +    if (s->pointer >= sizeof(s->regs)) {

> +        qemu_log_mask(LOG_GUEST_ERROR, "%s: register 0x%02x out of bounds\n",

> +                      __func__, s->pointer);

> +        return;

> +    }

> +

> +    s->len = 0;

> +

> +    switch (s->pointer) {

> +    case DPS310_PRS_B2:

> +    case DPS310_PRS_B1:

> +    case DPS310_PRS_B0:

> +    case DPS310_TMP_B2:

> +    case DPS310_TMP_B1:

> +    case DPS310_TMP_B0:

> +    case DPS310_PRS_CFG:

> +    case DPS310_TMP_CFG:

> +    case DPS310_MEAS_CFG:

> +    case DPS310_CFG_REG:

> +    case DPS310_COEF_BASE...DPS310_COEF_LAST:

> +    case DPS310_COEF_SRC:

> +    case 0x32: /* Undocumented register to indicate workaround not required */

> +        s->buf[s->len++] = s->regs[s->pointer];

> +        break;

> +    default:

> +        qemu_log_mask(LOG_UNIMP, "%s: register 0x%02x unimplemented\n",

> +                      __func__, s->pointer);

> +        return;

> +    }

> +}

> +

> +static void dps310_write(DPS310State *s)

> +{

> +    if (s->pointer >= sizeof(s->regs)) {

> +        qemu_log_mask(LOG_GUEST_ERROR, "%s: register %d out of bounds\n",

> +                      __func__, s->pointer);

> +        return;

> +    }

> +

> +    switch (s->pointer) {

> +    case DPS310_RESET:

> +        if (s->buf[0] == DPS310_RESET_MAGIC) {

> +            device_cold_reset(DEVICE(s));

> +        }

> +        break;

> +    case DPS310_PRS_CFG:

> +    case DPS310_TMP_CFG:

> +    case DPS310_MEAS_CFG:

> +    case DPS310_CFG_REG:

> +        s->regs[s->pointer] = s->buf[0];

> +        break;

> +    default:

> +        qemu_log_mask(LOG_UNIMP, "%s: register 0x%02x unimplemented\n",

> +                      __func__, s->pointer);

> +        return;

> +    }

> +}

> +

> +static uint8_t dps310_rx(I2CSlave *i2c)

> +{

> +    DPS310State *s = DPS310(i2c);

> +

> +    if (s->len < 2) {

> +        return s->buf[s->len++];

> +    } else {

> +        return 0xff;

> +    }

> +}

> +

> +static int dps310_tx(I2CSlave *i2c, uint8_t data)

> +{

> +    DPS310State *s = DPS310(i2c);

> +

> +    if (s->len == 0) {

> +        /*

> +         * first byte is the register pointer for a read or write

> +         * operation

> +         */

> +        s->pointer = data;

> +        s->len++;

> +    } else if (s->len == 1) {

> +        /*

> +         * second byte is the data to write. The device only supports

> +         * one byte writes

> +         */

> +        s->buf[0] = data;

> +        dps310_write(s);

> +    }

> +

> +    return 0;

> +}

> +

> +static int dps310_event(I2CSlave *i2c, enum i2c_event event)

> +{

> +    DPS310State *s = DPS310(i2c);

> +

> +    if (event == I2C_START_RECV) {

> +        dps310_read(s);

> +    }

> +

> +    s->len = 0;

> +    return 0;

> +}

> +

> +static const VMStateDescription vmstate_dps310 = {

> +    .name = "DPS310",

> +    .version_id = 0,

> +    .minimum_version_id = 0,

> +    .fields = (VMStateField[]) {

> +        VMSTATE_UINT8(len, DPS310State),

> +        VMSTATE_UINT8_ARRAY(buf, DPS310State, 2),

> +        VMSTATE_UINT8_ARRAY(regs, DPS310State, NUM_REGISTERS),

> +        VMSTATE_UINT8(pointer, DPS310State),

> +        VMSTATE_INT16(temperature, DPS310State),

> +        VMSTATE_INT16(pressure, DPS310State),

> +        VMSTATE_I2C_SLAVE(i2c, DPS310State),

> +        VMSTATE_END_OF_LIST()

> +    }

> +};

> +

> +static void dps310_class_init(ObjectClass *klass, void *data)

> +{

> +    DeviceClass *dc = DEVICE_CLASS(klass);

> +    I2CSlaveClass *k = I2C_SLAVE_CLASS(klass);

> +

> +    k->event = dps310_event;

> +    k->recv = dps310_rx;

> +    k->send = dps310_tx;

> +    dc->reset = dps310_reset;

> +    dc->vmsd = &vmstate_dps310;

> +}

> +

> +static const TypeInfo dps310_info = {

> +    .name          = TYPE_DPS310,

> +    .parent        = TYPE_I2C_SLAVE,

> +    .instance_size = sizeof(DPS310State),

> +    .class_init    = dps310_class_init,

> +};

> +

> +static void dps310_register_types(void)

> +{

> +    type_register_static(&dps310_info);

> +}

> +

> +type_init(dps310_register_types)

> diff --git a/hw/arm/Kconfig b/hw/arm/Kconfig

> index 67723d9ea6a8..62925845ebc1 100644

> --- a/hw/arm/Kconfig

> +++ b/hw/arm/Kconfig

> @@ -410,6 +410,7 @@ config ASPEED_SOC

>      select DS1338

>      select FTGMAC100

>      select I2C

> +    select DPS310

>      select PCA9552

>      select SERIAL

>      select SMBUS_EEPROM

> diff --git a/hw/misc/Kconfig b/hw/misc/Kconfig

> index c71ed2582046..016e34790e4f 100644

> --- a/hw/misc/Kconfig

> +++ b/hw/misc/Kconfig

> @@ -49,6 +49,10 @@ config EDU

>      default y if TEST_DEVICES

>      depends on PCI && MSI_NONBROKEN

>  

> +config DPS310

> +    bool

> +    depends on I2C

> +

>  config PCA9552

>      bool

>      depends on I2C

> diff --git a/hw/misc/meson.build b/hw/misc/meson.build

> index 66e1648533e0..779d8b1582d3 100644

> --- a/hw/misc/meson.build

> +++ b/hw/misc/meson.build

> @@ -1,4 +1,5 @@

>  softmmu_ss.add(when: 'CONFIG_APPLESMC', if_true: files('applesmc.c'))

> +softmmu_ss.add(when: 'CONFIG_DPS310', if_true: files('dps310.c'))

>  softmmu_ss.add(when: 'CONFIG_EDU', if_true: files('edu.c'))

>  softmmu_ss.add(when: 'CONFIG_FW_CFG_DMA', if_true: files('vmcoreinfo.c'))

>  softmmu_ss.add(when: 'CONFIG_ISA_DEBUG', if_true: files('debugexit.c'))

>
Joel Stanley June 16, 2021, 9:26 a.m. UTC | #2 
On Wed, 16 Jun 2021 at 09:09, Cédric Le Goater <clg@kaod.org> wrote:
> On 6/16/21 9:33 AM, Joel Stanley wrote:

> > +typedef struct DPS310State {

> > +    /*< private >*/

> > +    I2CSlave i2c;

> > +

> > +    /*< public >*/

> > +    uint8_t regs[NUM_REGISTERS];

> > +

> > +    int16_t pressure, temperature;

>

>

> We don't need those fields anymore. I will remove them if you are ok

> with that.


Yes, go ahead.

Thanks!
diff mbox series

Patch

diff --git a/hw/misc/dps310.c b/hw/misc/dps310.c
new file mode 100644
index 000000000000..82b727ab4287
--- /dev/null
+++ b/hw/misc/dps310.c
@@ -0,0 +1,231 @@ 
+// SPDX-License-Identifier: GPL-2.0-or-later
+/*
+ * Copyright 2017 Joel Stanley <joel@jms.id.au>, IBM Corporation
+ *
+ * Infineon DPS310 temperature and himidity sensor
+ *
+ * https://www.infineon.com/cms/en/product/sensor/pressure-sensors/pressure-sensors-for-iot/dps310/
+ */
+
+#include "qemu/osdep.h"
+#include "qemu/log.h"
+#include "hw/hw.h"
+#include "hw/i2c/i2c.h"
+#include "qapi/error.h"
+#include "qapi/visitor.h"
+#include "migration/vmstate.h"
+
+#define NUM_REGISTERS   0x33
+
+typedef struct DPS310State {
+    /*< private >*/
+    I2CSlave i2c;
+
+    /*< public >*/
+    uint8_t regs[NUM_REGISTERS];
+
+    int16_t pressure, temperature;
+
+    uint8_t len;
+    uint8_t buf[2];
+    uint8_t pointer;
+
+} DPS310State;
+
+#define TYPE_DPS310 "dps310"
+#define DPS310(obj) OBJECT_CHECK(DPS310State, (obj), TYPE_DPS310)
+
+#define DPS310_PRS_B2           0x00
+#define DPS310_PRS_B1           0x01
+#define DPS310_PRS_B0           0x02
+#define DPS310_TMP_B2           0x03
+#define DPS310_TMP_B1           0x04
+#define DPS310_TMP_B0           0x05
+#define DPS310_PRS_CFG          0x06
+#define DPS310_TMP_CFG          0x07
+#define  DPS310_TMP_RATE_BITS   (0x70)
+#define DPS310_MEAS_CFG         0x08
+#define  DPS310_MEAS_CTRL_BITS  (0x07)
+#define   DPS310_PRESSURE_EN    BIT(0)
+#define   DPS310_TEMP_EN        BIT(1)
+#define   DPS310_BACKGROUND     BIT(2)
+#define  DPS310_PRS_RDY         BIT(4)
+#define  DPS310_TMP_RDY         BIT(5)
+#define  DPS310_SENSOR_RDY      BIT(6)
+#define  DPS310_COEF_RDY        BIT(7)
+#define DPS310_CFG_REG          0x09
+#define DPS310_RESET            0x0c
+#define  DPS310_RESET_MAGIC     (BIT(0) | BIT(3))
+#define DPS310_COEF_BASE        0x10
+#define DPS310_COEF_LAST        0x21
+#define DPS310_COEF_SRC         0x28
+
+static void dps310_reset(DeviceState *dev)
+{
+    DPS310State *s = DPS310(dev);
+
+    static const uint8_t regs_reset_state[] = {
+        0xfe, 0x2f, 0xee, 0x02, 0x69, 0xa6, 0x00, 0x80, 0xc7, 0x00, 0x00, 0x00,
+        0x00, 0x10, 0x00, 0x00, 0x0e, 0x1e, 0xdd, 0x13, 0xca, 0x5f, 0x21, 0x52,
+        0xf9, 0xc6, 0x04, 0xd1, 0xdb, 0x47, 0x00, 0x5b, 0xfb, 0x3a, 0x00, 0x00,
+        0x20, 0x49, 0x4e, 0xa5, 0x90, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+        0x60, 0x15, 0x02
+    };
+
+    QEMU_BUILD_BUG_ON(sizeof(regs_reset_state) != sizeof(s->regs));
+
+    memcpy(s->regs, regs_reset_state, sizeof(s->regs));
+    s->pointer = 0;
+
+    /* TODO: assert these after some timeout ? */
+    s->regs[DPS310_MEAS_CFG] = DPS310_COEF_RDY | DPS310_SENSOR_RDY
+        | DPS310_TMP_RDY | DPS310_PRS_RDY;
+}
+
+static void dps310_read(DPS310State *s)
+{
+    if (s->pointer >= sizeof(s->regs)) {
+        qemu_log_mask(LOG_GUEST_ERROR, "%s: register 0x%02x out of bounds\n",
+                      __func__, s->pointer);
+        return;
+    }
+
+    s->len = 0;
+
+    switch (s->pointer) {
+    case DPS310_PRS_B2:
+    case DPS310_PRS_B1:
+    case DPS310_PRS_B0:
+    case DPS310_TMP_B2:
+    case DPS310_TMP_B1:
+    case DPS310_TMP_B0:
+    case DPS310_PRS_CFG:
+    case DPS310_TMP_CFG:
+    case DPS310_MEAS_CFG:
+    case DPS310_CFG_REG:
+    case DPS310_COEF_BASE...DPS310_COEF_LAST:
+    case DPS310_COEF_SRC:
+    case 0x32: /* Undocumented register to indicate workaround not required */
+        s->buf[s->len++] = s->regs[s->pointer];
+        break;
+    default:
+        qemu_log_mask(LOG_UNIMP, "%s: register 0x%02x unimplemented\n",
+                      __func__, s->pointer);
+        return;
+    }
+}
+
+static void dps310_write(DPS310State *s)
+{
+    if (s->pointer >= sizeof(s->regs)) {
+        qemu_log_mask(LOG_GUEST_ERROR, "%s: register %d out of bounds\n",
+                      __func__, s->pointer);
+        return;
+    }
+
+    switch (s->pointer) {
+    case DPS310_RESET:
+        if (s->buf[0] == DPS310_RESET_MAGIC) {
+            device_cold_reset(DEVICE(s));
+        }
+        break;
+    case DPS310_PRS_CFG:
+    case DPS310_TMP_CFG:
+    case DPS310_MEAS_CFG:
+    case DPS310_CFG_REG:
+        s->regs[s->pointer] = s->buf[0];
+        break;
+    default:
+        qemu_log_mask(LOG_UNIMP, "%s: register 0x%02x unimplemented\n",
+                      __func__, s->pointer);
+        return;
+    }
+}
+
+static uint8_t dps310_rx(I2CSlave *i2c)
+{
+    DPS310State *s = DPS310(i2c);
+
+    if (s->len < 2) {
+        return s->buf[s->len++];
+    } else {
+        return 0xff;
+    }
+}
+
+static int dps310_tx(I2CSlave *i2c, uint8_t data)
+{
+    DPS310State *s = DPS310(i2c);
+
+    if (s->len == 0) {
+        /*
+         * first byte is the register pointer for a read or write
+         * operation
+         */
+        s->pointer = data;
+        s->len++;
+    } else if (s->len == 1) {
+        /*
+         * second byte is the data to write. The device only supports
+         * one byte writes
+         */
+        s->buf[0] = data;
+        dps310_write(s);
+    }
+
+    return 0;
+}
+
+static int dps310_event(I2CSlave *i2c, enum i2c_event event)
+{
+    DPS310State *s = DPS310(i2c);
+
+    if (event == I2C_START_RECV) {
+        dps310_read(s);
+    }
+
+    s->len = 0;
+    return 0;
+}
+
+static const VMStateDescription vmstate_dps310 = {
+    .name = "DPS310",
+    .version_id = 0,
+    .minimum_version_id = 0,
+    .fields = (VMStateField[]) {
+        VMSTATE_UINT8(len, DPS310State),
+        VMSTATE_UINT8_ARRAY(buf, DPS310State, 2),
+        VMSTATE_UINT8_ARRAY(regs, DPS310State, NUM_REGISTERS),
+        VMSTATE_UINT8(pointer, DPS310State),
+        VMSTATE_INT16(temperature, DPS310State),
+        VMSTATE_INT16(pressure, DPS310State),
+        VMSTATE_I2C_SLAVE(i2c, DPS310State),
+        VMSTATE_END_OF_LIST()
+    }
+};
+
+static void dps310_class_init(ObjectClass *klass, void *data)
+{
+    DeviceClass *dc = DEVICE_CLASS(klass);
+    I2CSlaveClass *k = I2C_SLAVE_CLASS(klass);
+
+    k->event = dps310_event;
+    k->recv = dps310_rx;
+    k->send = dps310_tx;
+    dc->reset = dps310_reset;
+    dc->vmsd = &vmstate_dps310;
+}
+
+static const TypeInfo dps310_info = {
+    .name          = TYPE_DPS310,
+    .parent        = TYPE_I2C_SLAVE,
+    .instance_size = sizeof(DPS310State),
+    .class_init    = dps310_class_init,
+};
+
+static void dps310_register_types(void)
+{
+    type_register_static(&dps310_info);
+}
+
+type_init(dps310_register_types)
diff --git a/hw/arm/Kconfig b/hw/arm/Kconfig
index 67723d9ea6a8..62925845ebc1 100644
--- a/hw/arm/Kconfig
+++ b/hw/arm/Kconfig
@@ -410,6 +410,7 @@  config ASPEED_SOC
     select DS1338
     select FTGMAC100
     select I2C
+    select DPS310
     select PCA9552
     select SERIAL
     select SMBUS_EEPROM
diff --git a/hw/misc/Kconfig b/hw/misc/Kconfig
index c71ed2582046..016e34790e4f 100644
--- a/hw/misc/Kconfig
+++ b/hw/misc/Kconfig
@@ -49,6 +49,10 @@  config EDU
     default y if TEST_DEVICES
     depends on PCI && MSI_NONBROKEN
 
+config DPS310
+    bool
+    depends on I2C
+
 config PCA9552
     bool
     depends on I2C
diff --git a/hw/misc/meson.build b/hw/misc/meson.build
index 66e1648533e0..779d8b1582d3 100644
--- a/hw/misc/meson.build
+++ b/hw/misc/meson.build
@@ -1,4 +1,5 @@ 
 softmmu_ss.add(when: 'CONFIG_APPLESMC', if_true: files('applesmc.c'))
+softmmu_ss.add(when: 'CONFIG_DPS310', if_true: files('dps310.c'))
 softmmu_ss.add(when: 'CONFIG_EDU', if_true: files('edu.c'))
 softmmu_ss.add(when: 'CONFIG_FW_CFG_DMA', if_true: files('vmcoreinfo.c'))
 softmmu_ss.add(when: 'CONFIG_ISA_DEBUG', if_true: files('debugexit.c'))