Re: [PATCH] eeprom: idt_89hpesx: Support both ACPI and OF probing

From: Serge Semin
Date: Tue Aug 08 2017 - 07:57:16 EST


Hello Huy,
Thanks for the vary useful patch. I've tested it on my hardware, and it works
at least for OF-based platforms. I'll definitely ack it after a bit of
alterations (see comments below).

On Thu, Jul 27, 2017 at 11:09:19AM +0000, Huy Duong <qhuyduong@xxxxxxxxxxx> wrote:
> From: Huy Duong <qhuyduong@xxxxxxxxxxx>
>
> Allow the idt_89hpesx driver to get information from child nodes from
> both OF and ACPI by using more generic fwnode_property_read*() functions.
>
> Below is an example of instantiating idt_89hpesx driver via ACPI Table:
>
> Device(IDT0) {
> Name(_HID, "PRP0001")
> Name(_CID, "PRP0001")
> Name(_CCA, ONE)
> Name(_STR, Unicode("IDT SW I2C Slave"))
> Name(_CRS, ResourceTemplate () {
> I2cSerialBus (0x74, ControllerInitiated, 1000,
> AddressingMode7Bit, "\\_SB.I2CS",
> 0x00, ResourceConsumer, ,
> )
> })
> Name (_DSD, Package () {
> ToUUID("daffd814-6eba-4d8c-8a91-bc9bbf4aa301"),
> Package () {
> Package () {"compatible", "idt,89hpes32nt8ag2"},
> },
> })
> Device (EPR0) {
> Name (_DSD, Package () {
> ToUUID("daffd814-6eba-4d8c-8a91-bc9bbf4aa301"),
> Package () {
> Package () {"compatible", "onsemi,24c64"},
> Package () {"reg", 0x50},
> }
> })
> }
> }
>
> Signed-off-by: Huy Duong <qhuyduong@xxxxxxxxxxx>
> ---
> drivers/misc/eeprom/idt_89hpesx.c | 124 +++++++++++++++++---------------------
> 1 file changed, 54 insertions(+), 70 deletions(-)
>
> diff --git a/drivers/misc/eeprom/idt_89hpesx.c b/drivers/misc/eeprom/idt_89hpesx.c
> index ab0df6a..8be64ac 100644
> --- a/drivers/misc/eeprom/idt_89hpesx.c
> +++ b/drivers/misc/eeprom/idt_89hpesx.c
> @@ -1089,101 +1089,85 @@ static void idt_set_defval(struct idt_89hpesx_dev *pdev)
> pdev->eeaddr = 0;
> }
>
> -#ifdef CONFIG_OF

Since we don't use OF API in the driver anymore could you either discard the
of.h include statement or replace it with proper one (is it property.h)?

> static const struct i2c_device_id ee_ids[];
> +
> /*
> * idt_ee_match_id() - check whether the node belongs to compatible EEPROMs
> */
> -static const struct i2c_device_id *idt_ee_match_id(struct device_node *node)
> +static const struct i2c_device_id *idt_ee_match_id(struct fwnode_handle *fwnode)
> {
> const struct i2c_device_id *id = ee_ids;
> + const char *compatible, *p;
> char devname[I2C_NAME_SIZE];
> + int ret;
>
> - /* Retrieve the device name without manufacturer name */
> - if (of_modalias_node(node, devname, sizeof(devname)))
> + ret = fwnode_property_read_string(fwnode, "compatible", &compatible);
> + if (ret)
> return NULL;
>
> + p = strchr(compatible, ',');
> + strlcpy(devname, p ? p + 1 : compatible, sizeof(devname));
> /* Search through the device name */
> - while (id->name[0]) {
> - if (strcmp(devname, id->name) == 0)
> - return id;
> - id++;
> - }
> - return NULL;
> + while (id->name[0]) {
> + if (strcmp(devname, id->name) == 0)
> + return id;
> + id++;
> + }
> + return NULL;
> }
>
> /*
> - * idt_get_ofdata() - get IDT i2c-device parameters from device tree
> + * idt_get_fw_data() - get IDT i2c-device parameters from device tree
> * @pdev: Pointer to the driver data
> */
> -static void idt_get_ofdata(struct idt_89hpesx_dev *pdev)
> +static void idt_get_fw_data(struct idt_89hpesx_dev *pdev)
> {
> - const struct device_node *node = pdev->client->dev.of_node;
> struct device *dev = &pdev->client->dev;
> + struct fwnode_handle *fwnode;
> + const struct i2c_device_id *ee_id = NULL;
> + int eeprom_addr;
> + int ret;
>
> - /* Read dts node parameters */
> - if (node) {
> - const struct i2c_device_id *ee_id = NULL;
> - struct device_node *child;
> - const __be32 *addr_be;
> - int len;
> -
> - /* Walk through all child nodes looking for compatible one */
> - for_each_available_child_of_node(node, child) {
> - ee_id = idt_ee_match_id(child);
> - if (IS_ERR_OR_NULL(ee_id)) {
> - dev_warn(dev, "Skip unsupported child node %s",
> - child->full_name);
> - continue;
> - } else
> - break;
> - }
> -
> - /* If there is no child EEPROM device, then set zero size */
> - if (!ee_id) {
> - idt_set_defval(pdev);
> - return;
> - }
> + device_for_each_child_node(dev, fwnode) {
> + ee_id = idt_ee_match_id(fwnode);
> + if (IS_ERR_OR_NULL(ee_id)) {
> + dev_warn(dev, "Skip unsupported EEPROM device");
> + continue;
> + } else
> + break;
> + }
>
> - /* Retrieve EEPROM size */
> - pdev->eesize = (u32)ee_id->driver_data;
> -
> - /* Get custom EEPROM address from 'reg' attribute */
> - addr_be = of_get_property(child, "reg", &len);
> - if (!addr_be || (len < sizeof(*addr_be))) {
> - dev_warn(dev, "No reg on %s, use default address %d",
> - child->full_name, EEPROM_DEF_ADDR);
> - pdev->inieecmd = 0;
> - pdev->eeaddr = EEPROM_DEF_ADDR << 1;
> - } else {
> - pdev->inieecmd = EEPROM_USA;
> - pdev->eeaddr = be32_to_cpup(addr_be) << 1;
> - }
> + /* If there is no fwnode EEPROM device, then set zero size */
> + if (!ee_id) {
> + dev_warn(dev, "No fwnode, EEPROM access disabled");
> + idt_set_defval(pdev);
> + return;
> + }
>
> - /* Check EEPROM 'read-only' flag */
> - if (of_get_property(child, "read-only", NULL))
> - pdev->eero = true;
> - else /* if (!of_get_property(node, "read-only", NULL)) */
> - pdev->eero = false;
> + /* Retrieve EEPROM size */
> + pdev->eesize = (u32)ee_id->driver_data;
>
> - dev_dbg(dev, "EEPROM of %u bytes found by %hhu",
> - pdev->eesize, pdev->eeaddr);
> + /* Get custom EEPROM address from 'reg' attribute */
> + ret = fwnode_property_read_u32(fwnode, "reg", (u32 *) &eeprom_addr);

fwnode_property_read_u32() accepts u32 * as the value argument. If you declared
"u32 eeprom_addr" you wouldn't have to use type cast here.

> + if (ret || (eeprom_addr == 0)) {
> + dev_warn(dev, "No EEPROM reg found, use default address 0x%x",
> + EEPROM_DEF_ADDR);
> + pdev->inieecmd = 0;
> + pdev->eeaddr = EEPROM_DEF_ADDR << 1;
> } else {
> - dev_warn(dev, "No dts node, EEPROM access disabled");
> - idt_set_defval(pdev);
> + pdev->inieecmd = EEPROM_USA;
> + pdev->eeaddr = eeprom_addr << 1;
> }
> -}
> -#else
> -static void idt_get_ofdata(struct idt_89hpesx_dev *pdev)
> -{
> - struct device *dev = &pdev->client->dev;
>
> - dev_warn(dev, "OF table is unsupported, EEPROM access disabled");
> + /* Check EEPROM 'read-only' flag */
> + if (fwnode_property_read_bool(fwnode, "read-only"))
> + pdev->eero = true;
> + else /* if (!fwnode_property_read_bool(node, "read-only")) */
> + pdev->eero = false;
>
> - /* Nothing we can do, just set the default values */
> - idt_set_defval(pdev);
> + dev_info(dev, "EEPROM of %d bytes found by 0x%x",
> + pdev->eesize, pdev->eeaddr);
> }
> -#endif /* CONFIG_OF */
>
> /*
> * idt_create_pdev() - create and init data structure of the driver
> @@ -1203,8 +1187,8 @@ static struct idt_89hpesx_dev *idt_create_pdev(struct i2c_client *client)
> pdev->client = client;
> i2c_set_clientdata(client, pdev);
>
> - /* Read OF nodes information */
> - idt_get_ofdata(pdev);
> + /* Read firmware nodes information */
> + idt_get_fw_data(pdev);
>
> /* Initialize basic CSR CMD field - use full DWORD-sized r/w ops */
> pdev->inicsrcmd = CSR_DWE;
> --
> 1.8.3.1
>

Regards
-Sergey