| Message ID | 20230116235604.55099-2-peter@pjd.dev |
|---|---|
| State | New |
| Headers | show |
| Series | hw/nvram/eeprom_at24c: Cleanup + FRUID EEPROM init example | expand |
On 1/17/23 00:56, Peter Delevoryas wrote: > This helper is useful in board initialization because lets users initialize and > realize an EEPROM on an I2C bus with a single function call. > > Signed-off-by: Peter Delevoryas <peter@pjd.dev> Reviewed-by: Cédric Le Goater <clg@kaod.org> Thanks, C. > --- > hw/arm/aspeed.c | 10 +--------- > hw/arm/npcm7xx_boards.c | 20 +++++--------------- > hw/nvram/eeprom_at24c.c | 12 ++++++++++++ > include/hw/nvram/eeprom_at24c.h | 10 ++++++++++ > 4 files changed, 28 insertions(+), 24 deletions(-) > create mode 100644 include/hw/nvram/eeprom_at24c.h > > diff --git a/hw/arm/aspeed.c b/hw/arm/aspeed.c > index 55f114ef729f..1f9799d4321e 100644 > --- a/hw/arm/aspeed.c > +++ b/hw/arm/aspeed.c > @@ -17,6 +17,7 @@ > #include "hw/i2c/i2c_mux_pca954x.h" > #include "hw/i2c/smbus_eeprom.h" > #include "hw/misc/pca9552.h" > +#include "hw/nvram/eeprom_at24c.h" > #include "hw/sensor/tmp105.h" > #include "hw/misc/led.h" > #include "hw/qdev-properties.h" > @@ -429,15 +430,6 @@ static void aspeed_machine_init(MachineState *machine) > arm_load_kernel(ARM_CPU(first_cpu), machine, &aspeed_board_binfo); > } > > -static void at24c_eeprom_init(I2CBus *bus, uint8_t addr, uint32_t rsize) > -{ > - I2CSlave *i2c_dev = i2c_slave_new("at24c-eeprom", addr); > - DeviceState *dev = DEVICE(i2c_dev); > - > - qdev_prop_set_uint32(dev, "rom-size", rsize); > - i2c_slave_realize_and_unref(i2c_dev, bus, &error_abort); > -} > - > static void palmetto_bmc_i2c_init(AspeedMachineState *bmc) > { > AspeedSoCState *soc = &bmc->soc; > diff --git a/hw/arm/npcm7xx_boards.c b/hw/arm/npcm7xx_boards.c > index 6bc6f5d2fe29..9b31207a06e9 100644 > --- a/hw/arm/npcm7xx_boards.c > +++ b/hw/arm/npcm7xx_boards.c > @@ -21,6 +21,7 @@ > #include "hw/i2c/i2c_mux_pca954x.h" > #include "hw/i2c/smbus_eeprom.h" > #include "hw/loader.h" > +#include "hw/nvram/eeprom_at24c.h" > #include "hw/qdev-core.h" > #include "hw/qdev-properties.h" > #include "qapi/error.h" > @@ -140,17 +141,6 @@ static I2CBus *npcm7xx_i2c_get_bus(NPCM7xxState *soc, uint32_t num) > return I2C_BUS(qdev_get_child_bus(DEVICE(&soc->smbus[num]), "i2c-bus")); > } > > -static void at24c_eeprom_init(NPCM7xxState *soc, int bus, uint8_t addr, > - uint32_t rsize) > -{ > - I2CBus *i2c_bus = npcm7xx_i2c_get_bus(soc, bus); > - I2CSlave *i2c_dev = i2c_slave_new("at24c-eeprom", addr); > - DeviceState *dev = DEVICE(i2c_dev); > - > - qdev_prop_set_uint32(dev, "rom-size", rsize); > - i2c_slave_realize_and_unref(i2c_dev, i2c_bus, &error_abort); > -} > - > static void npcm7xx_init_pwm_splitter(NPCM7xxMachine *machine, > NPCM7xxState *soc, const int *fan_counts) > { > @@ -253,8 +243,8 @@ static void quanta_gsj_i2c_init(NPCM7xxState *soc) > i2c_slave_create_simple(npcm7xx_i2c_get_bus(soc, 3), "tmp105", 0x5c); > i2c_slave_create_simple(npcm7xx_i2c_get_bus(soc, 4), "tmp105", 0x5c); > > - at24c_eeprom_init(soc, 9, 0x55, 8192); > - at24c_eeprom_init(soc, 10, 0x55, 8192); > + at24c_eeprom_init(npcm7xx_i2c_get_bus(soc, 9), 0x55, 8192); > + at24c_eeprom_init(npcm7xx_i2c_get_bus(soc, 10), 0x55, 8192); > > /* > * i2c-11: > @@ -360,7 +350,7 @@ static void kudo_bmc_i2c_init(NPCM7xxState *soc) > > i2c_slave_create_simple(npcm7xx_i2c_get_bus(soc, 4), TYPE_PCA9548, 0x77); > > - at24c_eeprom_init(soc, 4, 0x50, 8192); /* mbfru */ > + at24c_eeprom_init(npcm7xx_i2c_get_bus(soc, 4), 0x50, 8192); /* mbfru */ > > i2c_mux = i2c_slave_create_simple(npcm7xx_i2c_get_bus(soc, 13), > TYPE_PCA9548, 0x77); > @@ -371,7 +361,7 @@ static void kudo_bmc_i2c_init(NPCM7xxState *soc) > i2c_slave_create_simple(pca954x_i2c_get_bus(i2c_mux, 4), "tmp105", 0x48); > i2c_slave_create_simple(pca954x_i2c_get_bus(i2c_mux, 5), "tmp105", 0x49); > > - at24c_eeprom_init(soc, 14, 0x55, 8192); /* bmcfru */ > + at24c_eeprom_init(npcm7xx_i2c_get_bus(soc, 14), 0x55, 8192); /* bmcfru */ > > /* TODO: Add remaining i2c devices. */ > } > diff --git a/hw/nvram/eeprom_at24c.c b/hw/nvram/eeprom_at24c.c > index 2d4d8b952f38..98857e3626b9 100644 > --- a/hw/nvram/eeprom_at24c.c > +++ b/hw/nvram/eeprom_at24c.c > @@ -12,6 +12,7 @@ > #include "qapi/error.h" > #include "qemu/module.h" > #include "hw/i2c/i2c.h" > +#include "hw/nvram/eeprom_at24c.h" > #include "hw/qdev-properties.h" > #include "hw/qdev-properties-system.h" > #include "sysemu/block-backend.h" > @@ -128,6 +129,17 @@ int at24c_eeprom_send(I2CSlave *s, uint8_t data) > return 0; > } > > +I2CSlave *at24c_eeprom_init(I2CBus *bus, uint8_t address, uint32_t rom_size) > +{ > + I2CSlave *i2c_dev = i2c_slave_new(TYPE_AT24C_EE, address); > + DeviceState *dev = DEVICE(i2c_dev); > + > + qdev_prop_set_uint32(dev, "rom-size", rom_size); > + i2c_slave_realize_and_unref(i2c_dev, bus, &error_abort); > + > + return i2c_dev; > +} > + > static void at24c_eeprom_realize(DeviceState *dev, Error **errp) > { > EEPROMState *ee = AT24C_EE(dev); > diff --git a/include/hw/nvram/eeprom_at24c.h b/include/hw/nvram/eeprom_at24c.h > new file mode 100644 > index 000000000000..79a36b53ca87 > --- /dev/null > +++ b/include/hw/nvram/eeprom_at24c.h > @@ -0,0 +1,10 @@ > +/* Copyright (c) Meta Platforms, Inc. and affiliates. */ > + > +#ifndef EEPROM_AT24C_H > +#define EEPROM_AT24C_H > + > +#include "hw/i2c/i2c.h" > + > +I2CSlave *at24c_eeprom_init(I2CBus *bus, uint8_t address, uint32_t rom_size); > + > +#endif
On 17/1/23 00:56, Peter Delevoryas wrote: > This helper is useful in board initialization because lets users initialize and > realize an EEPROM on an I2C bus with a single function call. > > Signed-off-by: Peter Delevoryas <peter@pjd.dev> > --- > hw/arm/aspeed.c | 10 +--------- > hw/arm/npcm7xx_boards.c | 20 +++++--------------- > hw/nvram/eeprom_at24c.c | 12 ++++++++++++ > include/hw/nvram/eeprom_at24c.h | 10 ++++++++++ > 4 files changed, 28 insertions(+), 24 deletions(-) > create mode 100644 include/hw/nvram/eeprom_at24c.h > diff --git a/include/hw/nvram/eeprom_at24c.h b/include/hw/nvram/eeprom_at24c.h > new file mode 100644 > index 000000000000..79a36b53ca87 > --- /dev/null > +++ b/include/hw/nvram/eeprom_at24c.h > @@ -0,0 +1,10 @@ > +/* Copyright (c) Meta Platforms, Inc. and affiliates. */ What license for this copyright? > +#ifndef EEPROM_AT24C_H > +#define EEPROM_AT24C_H > + > +#include "hw/i2c/i2c.h" /** * Create and realize an AT24C EEPROM device on the heap. * @bus: I2C bus to put it on * @addr: I2C address of the EEPROM slave when put on a bus * @rom_size: size of the EEPROM * * Create the device state structure, initialize it, put it on * the specified @bus, and drop the reference to it (the device * is realized). */ I2CSlave *at24c_eeprom_create_simple(I2CBus *bus, uint8_t addr, size_t rom_size); > +I2CSlave *at24c_eeprom_init(I2CBus *bus, uint8_t address, uint32_t rom_size); > + > +#endif
On Tue, Jan 17, 2023 at 09:00:34AM +0100, Philippe Mathieu-Daudé wrote: > On 17/1/23 00:56, Peter Delevoryas wrote: > > This helper is useful in board initialization because lets users initialize and > > realize an EEPROM on an I2C bus with a single function call. > > > > Signed-off-by: Peter Delevoryas <peter@pjd.dev> > > --- > > hw/arm/aspeed.c | 10 +--------- > > hw/arm/npcm7xx_boards.c | 20 +++++--------------- > > hw/nvram/eeprom_at24c.c | 12 ++++++++++++ > > include/hw/nvram/eeprom_at24c.h | 10 ++++++++++ > > 4 files changed, 28 insertions(+), 24 deletions(-) > > create mode 100644 include/hw/nvram/eeprom_at24c.h > > > diff --git a/include/hw/nvram/eeprom_at24c.h b/include/hw/nvram/eeprom_at24c.h > > new file mode 100644 > > index 000000000000..79a36b53ca87 > > --- /dev/null > > +++ b/include/hw/nvram/eeprom_at24c.h > > @@ -0,0 +1,10 @@ > > +/* Copyright (c) Meta Platforms, Inc. and affiliates. */ > > What license for this copyright? Erg, yeah, thanks for calling this out, I did this wrong. Meta has some new licensing guidelines and I misinterpreted them. Contributors are just supposed to use whatever license the open-source project has, so I'll just change this to say it's under GPL2, like the one I used in hw/arm/fby35.c > > > +#ifndef EEPROM_AT24C_H > > +#define EEPROM_AT24C_H > > + > > +#include "hw/i2c/i2c.h" > > /** > * Create and realize an AT24C EEPROM device on the heap. > * @bus: I2C bus to put it on > * @addr: I2C address of the EEPROM slave when put on a bus > * @rom_size: size of the EEPROM > * > * Create the device state structure, initialize it, put it on > * the specified @bus, and drop the reference to it (the device > * is realized). > */ > I2CSlave *at24c_eeprom_create_simple(I2CBus *bus, uint8_t addr, > size_t rom_size); +1, I'll include this comment > > > +I2CSlave *at24c_eeprom_init(I2CBus *bus, uint8_t address, uint32_t rom_size); > > + > > +#endif >
On Tue, Jan 17, 2023 at 10:32:15AM -0800, Peter Delevoryas wrote: > On Tue, Jan 17, 2023 at 09:00:34AM +0100, Philippe Mathieu-Daudé wrote: > > On 17/1/23 00:56, Peter Delevoryas wrote: > > > This helper is useful in board initialization because lets users initialize and > > > realize an EEPROM on an I2C bus with a single function call. > > > > > > Signed-off-by: Peter Delevoryas <peter@pjd.dev> > > > --- > > > hw/arm/aspeed.c | 10 +--------- > > > hw/arm/npcm7xx_boards.c | 20 +++++--------------- > > > hw/nvram/eeprom_at24c.c | 12 ++++++++++++ > > > include/hw/nvram/eeprom_at24c.h | 10 ++++++++++ > > > 4 files changed, 28 insertions(+), 24 deletions(-) > > > create mode 100644 include/hw/nvram/eeprom_at24c.h > > > > > diff --git a/include/hw/nvram/eeprom_at24c.h b/include/hw/nvram/eeprom_at24c.h > > > new file mode 100644 > > > index 000000000000..79a36b53ca87 > > > --- /dev/null > > > +++ b/include/hw/nvram/eeprom_at24c.h > > > @@ -0,0 +1,10 @@ > > > +/* Copyright (c) Meta Platforms, Inc. and affiliates. */ > > > > What license for this copyright? > > Erg, yeah, thanks for calling this out, I did this wrong. Meta has some new > licensing guidelines and I misinterpreted them. Contributors are just supposed > to use whatever license the open-source project has, so I'll just change this > to say it's under GPL2, like the one I used in hw/arm/fby35.c > > > > > > +#ifndef EEPROM_AT24C_H > > > +#define EEPROM_AT24C_H > > > + > > > +#include "hw/i2c/i2c.h" > > > > /** > > * Create and realize an AT24C EEPROM device on the heap. > > * @bus: I2C bus to put it on > > * @addr: I2C address of the EEPROM slave when put on a bus > > * @rom_size: size of the EEPROM > > * > > * Create the device state structure, initialize it, put it on > > * the specified @bus, and drop the reference to it (the device > > * is realized). > > */ > > I2CSlave *at24c_eeprom_create_simple(I2CBus *bus, uint8_t addr, > > size_t rom_size); > > +1, I'll include this comment Oh, to clarify though: I'm not going to include the rename to the function, maybe we could do that separately? I kinda want to avoid touching all the at24c_eeprom_init calls unless I really need to. I know it's just a simple sed, but also, smbus_eeprom_init is using the "init" suffix, so I'm not sure it's consistent, although "create_simple" probably _is_ more consistent with devices in general in QEMU. But anyways, main point, I just want to avoid making any unnecessary refactoring here, and renaming it completely seems unnecessary. > > > > > > +I2CSlave *at24c_eeprom_init(I2CBus *bus, uint8_t address, uint32_t rom_size); > > > + > > > +#endif > > >
diff --git a/hw/arm/aspeed.c b/hw/arm/aspeed.c index 55f114ef729f..1f9799d4321e 100644 --- a/hw/arm/aspeed.c +++ b/hw/arm/aspeed.c @@ -17,6 +17,7 @@ #include "hw/i2c/i2c_mux_pca954x.h" #include "hw/i2c/smbus_eeprom.h" #include "hw/misc/pca9552.h" +#include "hw/nvram/eeprom_at24c.h" #include "hw/sensor/tmp105.h" #include "hw/misc/led.h" #include "hw/qdev-properties.h" @@ -429,15 +430,6 @@ static void aspeed_machine_init(MachineState *machine) arm_load_kernel(ARM_CPU(first_cpu), machine, &aspeed_board_binfo); } -static void at24c_eeprom_init(I2CBus *bus, uint8_t addr, uint32_t rsize) -{ - I2CSlave *i2c_dev = i2c_slave_new("at24c-eeprom", addr); - DeviceState *dev = DEVICE(i2c_dev); - - qdev_prop_set_uint32(dev, "rom-size", rsize); - i2c_slave_realize_and_unref(i2c_dev, bus, &error_abort); -} - static void palmetto_bmc_i2c_init(AspeedMachineState *bmc) { AspeedSoCState *soc = &bmc->soc; diff --git a/hw/arm/npcm7xx_boards.c b/hw/arm/npcm7xx_boards.c index 6bc6f5d2fe29..9b31207a06e9 100644 --- a/hw/arm/npcm7xx_boards.c +++ b/hw/arm/npcm7xx_boards.c @@ -21,6 +21,7 @@ #include "hw/i2c/i2c_mux_pca954x.h" #include "hw/i2c/smbus_eeprom.h" #include "hw/loader.h" +#include "hw/nvram/eeprom_at24c.h" #include "hw/qdev-core.h" #include "hw/qdev-properties.h" #include "qapi/error.h" @@ -140,17 +141,6 @@ static I2CBus *npcm7xx_i2c_get_bus(NPCM7xxState *soc, uint32_t num) return I2C_BUS(qdev_get_child_bus(DEVICE(&soc->smbus[num]), "i2c-bus")); } -static void at24c_eeprom_init(NPCM7xxState *soc, int bus, uint8_t addr, - uint32_t rsize) -{ - I2CBus *i2c_bus = npcm7xx_i2c_get_bus(soc, bus); - I2CSlave *i2c_dev = i2c_slave_new("at24c-eeprom", addr); - DeviceState *dev = DEVICE(i2c_dev); - - qdev_prop_set_uint32(dev, "rom-size", rsize); - i2c_slave_realize_and_unref(i2c_dev, i2c_bus, &error_abort); -} - static void npcm7xx_init_pwm_splitter(NPCM7xxMachine *machine, NPCM7xxState *soc, const int *fan_counts) { @@ -253,8 +243,8 @@ static void quanta_gsj_i2c_init(NPCM7xxState *soc) i2c_slave_create_simple(npcm7xx_i2c_get_bus(soc, 3), "tmp105", 0x5c); i2c_slave_create_simple(npcm7xx_i2c_get_bus(soc, 4), "tmp105", 0x5c); - at24c_eeprom_init(soc, 9, 0x55, 8192); - at24c_eeprom_init(soc, 10, 0x55, 8192); + at24c_eeprom_init(npcm7xx_i2c_get_bus(soc, 9), 0x55, 8192); + at24c_eeprom_init(npcm7xx_i2c_get_bus(soc, 10), 0x55, 8192); /* * i2c-11: @@ -360,7 +350,7 @@ static void kudo_bmc_i2c_init(NPCM7xxState *soc) i2c_slave_create_simple(npcm7xx_i2c_get_bus(soc, 4), TYPE_PCA9548, 0x77); - at24c_eeprom_init(soc, 4, 0x50, 8192); /* mbfru */ + at24c_eeprom_init(npcm7xx_i2c_get_bus(soc, 4), 0x50, 8192); /* mbfru */ i2c_mux = i2c_slave_create_simple(npcm7xx_i2c_get_bus(soc, 13), TYPE_PCA9548, 0x77); @@ -371,7 +361,7 @@ static void kudo_bmc_i2c_init(NPCM7xxState *soc) i2c_slave_create_simple(pca954x_i2c_get_bus(i2c_mux, 4), "tmp105", 0x48); i2c_slave_create_simple(pca954x_i2c_get_bus(i2c_mux, 5), "tmp105", 0x49); - at24c_eeprom_init(soc, 14, 0x55, 8192); /* bmcfru */ + at24c_eeprom_init(npcm7xx_i2c_get_bus(soc, 14), 0x55, 8192); /* bmcfru */ /* TODO: Add remaining i2c devices. */ } diff --git a/hw/nvram/eeprom_at24c.c b/hw/nvram/eeprom_at24c.c index 2d4d8b952f38..98857e3626b9 100644 --- a/hw/nvram/eeprom_at24c.c +++ b/hw/nvram/eeprom_at24c.c @@ -12,6 +12,7 @@ #include "qapi/error.h" #include "qemu/module.h" #include "hw/i2c/i2c.h" +#include "hw/nvram/eeprom_at24c.h" #include "hw/qdev-properties.h" #include "hw/qdev-properties-system.h" #include "sysemu/block-backend.h" @@ -128,6 +129,17 @@ int at24c_eeprom_send(I2CSlave *s, uint8_t data) return 0; } +I2CSlave *at24c_eeprom_init(I2CBus *bus, uint8_t address, uint32_t rom_size) +{ + I2CSlave *i2c_dev = i2c_slave_new(TYPE_AT24C_EE, address); + DeviceState *dev = DEVICE(i2c_dev); + + qdev_prop_set_uint32(dev, "rom-size", rom_size); + i2c_slave_realize_and_unref(i2c_dev, bus, &error_abort); + + return i2c_dev; +} + static void at24c_eeprom_realize(DeviceState *dev, Error **errp) { EEPROMState *ee = AT24C_EE(dev); diff --git a/include/hw/nvram/eeprom_at24c.h b/include/hw/nvram/eeprom_at24c.h new file mode 100644 index 000000000000..79a36b53ca87 --- /dev/null +++ b/include/hw/nvram/eeprom_at24c.h @@ -0,0 +1,10 @@ +/* Copyright (c) Meta Platforms, Inc. and affiliates. */ + +#ifndef EEPROM_AT24C_H +#define EEPROM_AT24C_H + +#include "hw/i2c/i2c.h" + +I2CSlave *at24c_eeprom_init(I2CBus *bus, uint8_t address, uint32_t rom_size); + +#endif
This helper is useful in board initialization because lets users initialize and realize an EEPROM on an I2C bus with a single function call. Signed-off-by: Peter Delevoryas <peter@pjd.dev> --- hw/arm/aspeed.c | 10 +--------- hw/arm/npcm7xx_boards.c | 20 +++++--------------- hw/nvram/eeprom_at24c.c | 12 ++++++++++++ include/hw/nvram/eeprom_at24c.h | 10 ++++++++++ 4 files changed, 28 insertions(+), 24 deletions(-) create mode 100644 include/hw/nvram/eeprom_at24c.h