diff mbox series

[1/2] HISI LPC: Reference static MFD cells for ACPI support

Message ID 1525360119-102166-2-git-send-email-john.garry@huawei.com
State New
Headers show
Series HISI LPC ACPI UART support | expand

Commit Message

John Garry May 3, 2018, 3:08 p.m. UTC
Currently for ACPI support the driver models the host as
an MFD. For a device connected to the LPC bus, we dynamically
create an MFD cell for that device, configuring the cell
name and ACPI match parameters manually. This makes supporting
named devices and also special setup handling for certain devices
awkward, as we would need to introduce some special ACPI device
handling according to device HID.

To avoid this, create reference static MFD cells for known
child devices, so when adding an MFD cell we can fix the cell
platform data as required. For this, a setup callback function
is added.

For now, only the IPMI cell is added.

Signed-off-by: John Garry <john.garry@huawei.com>

---
 drivers/bus/hisi_lpc.c | 89 ++++++++++++++++++++++++++++++--------------------
 1 file changed, 53 insertions(+), 36 deletions(-)

-- 
1.9.1

Comments

Andy Shevchenko May 3, 2018, 4:54 p.m. UTC | #1
On Thu, 2018-05-03 at 23:08 +0800, John Garry wrote:
> Currently for ACPI support the driver models the host as

> an MFD. For a device connected to the LPC bus, we dynamically

> create an MFD cell for that device, configuring the cell

> name and ACPI match parameters manually. This makes supporting

> named devices and also special setup handling for certain devices

> awkward, as we would need to introduce some special ACPI device

> handling according to device HID.

> 

> To avoid this, create reference static MFD cells for known

> child devices, so when adding an MFD cell we can fix the cell

> platform data as required. For this, a setup callback function

> is added.

> 

> For now, only the IPMI cell is added.


> +static const struct mfd_cell *hisi_lpc_acpi_mfd_get_cell(const char

> *hid)

> +{

> +	const struct hisi_lpc_acpi_mfd_cell *cell =

> hisi_lpc_acpi_mfd_cells;

> +

> +	for (; cell && cell->mfd_cell.name; cell++) {

> +		const struct mfd_cell *mfd_cell = &cell->mfd_cell;

> +		const struct mfd_cell_acpi_match *acpi_match;

> +

> +		acpi_match = mfd_cell->acpi_match;

> +		if (!strcmp(acpi_match->pnpid, hid))

> +			return mfd_cell;

> +	}

> +

> +	return NULL;

> +}


I'm not sure I understand why MFD core can't do it (as seen in lines
drivers/mfd/core.c:105 and below).

> +	/* allocate the mfd cells, one per child */

> +	size = sizeof(*mfd_cells);

>  	mfd_cells = devm_kcalloc(hostdev, cell_num, size,

> GFP_KERNEL);

>  	if (!mfd_cells)

>  		return -ENOMEM;


And since you have structures already, I'm not sure why you need another
allocation for them. Only what you would need is to apply resources and
call devm_mfd_add_devices() per each found device.

> +		cell = container_of(mfd_cell_ref, typeof(*cell),

> mfd_cell);


Why we can't iterate over inherited type of objects directly?

-- 
Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Intel Finland Oy
Lee Jones May 4, 2018, 9:02 a.m. UTC | #2
On Thu, 03 May 2018, Andy Shevchenko wrote:

> On Thu, 2018-05-03 at 23:08 +0800, John Garry wrote:

> > Currently for ACPI support the driver models the host as

> > an MFD. For a device connected to the LPC bus, we dynamically

> > create an MFD cell for that device, configuring the cell

> > name and ACPI match parameters manually. This makes supporting

> > named devices and also special setup handling for certain devices

> > awkward, as we would need to introduce some special ACPI device

> > handling according to device HID.

> > 

> > To avoid this, create reference static MFD cells for known

> > child devices, so when adding an MFD cell we can fix the cell

> > platform data as required. For this, a setup callback function

> > is added.

> > 

> > For now, only the IPMI cell is added.

> 

> > +static const struct mfd_cell *hisi_lpc_acpi_mfd_get_cell(const char

> > *hid)

> > +{

> > +	const struct hisi_lpc_acpi_mfd_cell *cell =

> > hisi_lpc_acpi_mfd_cells;

> > +

> > +	for (; cell && cell->mfd_cell.name; cell++) {

> > +		const struct mfd_cell *mfd_cell = &cell->mfd_cell;

> > +		const struct mfd_cell_acpi_match *acpi_match;

> > +

> > +		acpi_match = mfd_cell->acpi_match;

> > +		if (!strcmp(acpi_match->pnpid, hid))

> > +			return mfd_cell;

> > +	}

> > +

> > +	return NULL;

> > +}

> 

> I'm not sure I understand why MFD core can't do it (as seen in lines

> drivers/mfd/core.c:105 and below).


You shouldn't be using the MFD API outside of MFD anyway.  Either it
is an MFD driver, or it isn't.  If it is, please move it. If it's not,
please don't use the API.

My current suspicion is that the driver needs splitting and only part
of it ends up in MFD.

-- 
Lee Jones [李琼斯]
Linaro Services Technical Lead
Linaro.org │ Open source software for ARM SoCs
Follow Linaro: Facebook | Twitter | Blog
John Garry May 4, 2018, 9:27 a.m. UTC | #3
On 04/05/2018 10:02, Lee Jones wrote:
> On Thu, 03 May 2018, Andy Shevchenko wrote:

>

>> On Thu, 2018-05-03 at 23:08 +0800, John Garry wrote:

>>> Currently for ACPI support the driver models the host as

>>> an MFD. For a device connected to the LPC bus, we dynamically

>>> create an MFD cell for that device, configuring the cell

>>> name and ACPI match parameters manually. This makes supporting

>>> named devices and also special setup handling for certain devices

>>> awkward, as we would need to introduce some special ACPI device

>>> handling according to device HID.

>>>

>>> To avoid this, create reference static MFD cells for known

>>> child devices, so when adding an MFD cell we can fix the cell

>>> platform data as required. For this, a setup callback function

>>> is added.

>>>

>>> For now, only the IPMI cell is added.

>>

>>> +static const struct mfd_cell *hisi_lpc_acpi_mfd_get_cell(const char

>>> *hid)

>>> +{

>>> +	const struct hisi_lpc_acpi_mfd_cell *cell =

>>> hisi_lpc_acpi_mfd_cells;

>>> +

>>> +	for (; cell && cell->mfd_cell.name; cell++) {

>>> +		const struct mfd_cell *mfd_cell = &cell->mfd_cell;

>>> +		const struct mfd_cell_acpi_match *acpi_match;

>>> +

>>> +		acpi_match = mfd_cell->acpi_match;

>>> +		if (!strcmp(acpi_match->pnpid, hid))

>>> +			return mfd_cell;

>>> +	}

>>> +

>>> +	return NULL;

>>> +}

>>

>> I'm not sure I understand why MFD core can't do it (as seen in lines

>> drivers/mfd/core.c:105 and below).

>


Hi Lee,

> You shouldn't be using the MFD API outside of MFD anyway.  Either it

> is an MFD driver, or it isn't.  If it is, please move it. If it's not,

> please don't use the API.


We're modelling as an MFD, but it's not an MFD in the classic sense. 
We're just using the MFD API for convenience (and to avoid code 
duplication), as the MFD API does what we require for this driver.

>

> My current suspicion is that the driver needs splitting and only part

> of it ends up in MFD.

>


How would you propose splitting the driver? By adding a lib function 
specific for this driver for the ACPI probe?

Cheers,
John
Lee Jones May 4, 2018, 10:03 a.m. UTC | #4
On Fri, 04 May 2018, John Garry wrote:

> On 04/05/2018 10:02, Lee Jones wrote:

> > On Thu, 03 May 2018, Andy Shevchenko wrote:

> > 

> > > On Thu, 2018-05-03 at 23:08 +0800, John Garry wrote:

> > > > Currently for ACPI support the driver models the host as

> > > > an MFD. For a device connected to the LPC bus, we dynamically

> > > > create an MFD cell for that device, configuring the cell

> > > > name and ACPI match parameters manually. This makes supporting

> > > > named devices and also special setup handling for certain devices

> > > > awkward, as we would need to introduce some special ACPI device

> > > > handling according to device HID.

> > > > 

> > > > To avoid this, create reference static MFD cells for known

> > > > child devices, so when adding an MFD cell we can fix the cell

> > > > platform data as required. For this, a setup callback function

> > > > is added.

> > > > 

> > > > For now, only the IPMI cell is added.

> > > 

> > > > +static const struct mfd_cell *hisi_lpc_acpi_mfd_get_cell(const char

> > > > *hid)

> > > > +{

> > > > +	const struct hisi_lpc_acpi_mfd_cell *cell =

> > > > hisi_lpc_acpi_mfd_cells;

> > > > +

> > > > +	for (; cell && cell->mfd_cell.name; cell++) {

> > > > +		const struct mfd_cell *mfd_cell = &cell->mfd_cell;

> > > > +		const struct mfd_cell_acpi_match *acpi_match;

> > > > +

> > > > +		acpi_match = mfd_cell->acpi_match;

> > > > +		if (!strcmp(acpi_match->pnpid, hid))

> > > > +			return mfd_cell;

> > > > +	}

> > > > +

> > > > +	return NULL;

> > > > +}

> > > 

> > > I'm not sure I understand why MFD core can't do it (as seen in lines

> > > drivers/mfd/core.c:105 and below).

> > 

> 

> Hi Lee,

> 

> > You shouldn't be using the MFD API outside of MFD anyway.  Either it

> > is an MFD driver, or it isn't.  If it is, please move it. If it's not,

> > please don't use the API.

> 

> We're modelling as an MFD, but it's not an MFD in the classic sense. We're

> just using the MFD API for convenience (and to avoid code duplication), as

> the MFD API does what we require for this driver.


I know what you're doing, and it's wrong. ;)

> > My current suspicion is that the driver needs splitting and only part

> > of it ends up in MFD.

> 

> How would you propose splitting the driver? By adding a lib function

> specific for this driver for the ACPI probe?


Look at:

  drivers/platform/chrome/cros_ec_lpc.c

and

  drivers/mfd/cros_ec.c

-- 
Lee Jones [李琼斯]
Linaro Services Technical Lead
Linaro.org │ Open source software for ARM SoCs
Follow Linaro: Facebook | Twitter | Blog
John Garry May 4, 2018, 10:21 a.m. UTC | #5
On 04/05/2018 11:03, Lee Jones wrote:
> On Fri, 04 May 2018, John Garry wrote:

>

>> On 04/05/2018 10:02, Lee Jones wrote:

>>> On Thu, 03 May 2018, Andy Shevchenko wrote:

>>>

>>>> On Thu, 2018-05-03 at 23:08 +0800, John Garry wrote:

>>>>> Currently for ACPI support the driver models the host as

>>>>> an MFD. For a device connected to the LPC bus, we dynamically

>>>>> create an MFD cell for that device, configuring the cell

>>>>> name and ACPI match parameters manually. This makes supporting

>>>>> named devices and also special setup handling for certain devices

>>>>> awkward, as we would need to introduce some special ACPI device

>>>>> handling according to device HID.

>>>>>

>>>>> To avoid this, create reference static MFD cells for known

>>>>> child devices, so when adding an MFD cell we can fix the cell

>>>>> platform data as required. For this, a setup callback function

>>>>> is added.

>>>>>

>>>>> For now, only the IPMI cell is added.

>>>>

>>>>> +static const struct mfd_cell *hisi_lpc_acpi_mfd_get_cell(const char

>>>>> *hid)

>>>>> +{

>>>>> +	const struct hisi_lpc_acpi_mfd_cell *cell =

>>>>> hisi_lpc_acpi_mfd_cells;

>>>>> +

>>>>> +	for (; cell && cell->mfd_cell.name; cell++) {

>>>>> +		const struct mfd_cell *mfd_cell = &cell->mfd_cell;

>>>>> +		const struct mfd_cell_acpi_match *acpi_match;

>>>>> +

>>>>> +		acpi_match = mfd_cell->acpi_match;

>>>>> +		if (!strcmp(acpi_match->pnpid, hid))

>>>>> +			return mfd_cell;

>>>>> +	}

>>>>> +

>>>>> +	return NULL;

>>>>> +}

>>>>

>>>> I'm not sure I understand why MFD core can't do it (as seen in lines

>>>> drivers/mfd/core.c:105 and below).

>>>

>>

>> Hi Lee,

>>

>>> You shouldn't be using the MFD API outside of MFD anyway.  Either it

>>> is an MFD driver, or it isn't.  If it is, please move it. If it's not,

>>> please don't use the API.

>>

>> We're modelling as an MFD, but it's not an MFD in the classic sense. We're

>> just using the MFD API for convenience (and to avoid code duplication), as

>> the MFD API does what we require for this driver.

>

> I know what you're doing, and it's wrong. ;)

>

>>> My current suspicion is that the driver needs splitting and only part

>>> of it ends up in MFD.

>>

>> How would you propose splitting the driver? By adding a lib function

>> specific for this driver for the ACPI probe?

>

> Look at:

>

>   drivers/platform/chrome/cros_ec_lpc.c

>

> and

>

>   drivers/mfd/cros_ec.c

>


Right, I see, something similar to what I suggested.

I don't really see a point in splitting the driver across drivers/mfd 
and drivers/bus, and introducing dependencies. This is more especially 
considering this is a legacy host controller with no potential future 
developments, and not worth the effort.

If you feel strongly enough about not using the MFD API outside 
drivers/mfd, then I'll look at other solutions, like using platform 
device APIs directly.

Cheers,
John
John Garry May 4, 2018, 12:29 p.m. UTC | #6
On 03/05/2018 17:54, Andy Shevchenko wrote:
> On Thu, 2018-05-03 at 23:08 +0800, John Garry wrote:

>> Currently for ACPI support the driver models the host as

>> an MFD. For a device connected to the LPC bus, we dynamically

>> create an MFD cell for that device, configuring the cell

>> name and ACPI match parameters manually. This makes supporting

>> named devices and also special setup handling for certain devices

>> awkward, as we would need to introduce some special ACPI device

>> handling according to device HID.

>>

>> To avoid this, create reference static MFD cells for known

>> child devices, so when adding an MFD cell we can fix the cell

>> platform data as required. For this, a setup callback function

>> is added.


Hi Andy,

>>

>> For now, only the IPMI cell is added.

>

>> +static const struct mfd_cell *hisi_lpc_acpi_mfd_get_cell(const char

>> *hid)

>> +{

>> +	const struct hisi_lpc_acpi_mfd_cell *cell =

>> hisi_lpc_acpi_mfd_cells;

>> +

>> +	for (; cell && cell->mfd_cell.name; cell++) {

>> +		const struct mfd_cell *mfd_cell = &cell->mfd_cell;

>> +		const struct mfd_cell_acpi_match *acpi_match;

>> +

>> +		acpi_match = mfd_cell->acpi_match;

>> +		if (!strcmp(acpi_match->pnpid, hid))

>> +			return mfd_cell;

>> +	}

>> +

>> +	return NULL;

>> +}

>

> I'm not sure I understand why MFD core can't do it (as seen in lines

> drivers/mfd/core.c:105 and below).

>


Right, I think MFD core does the same.

>> +	/* allocate the mfd cells, one per child */

>> +	size = sizeof(*mfd_cells);

>>  	mfd_cells = devm_kcalloc(hostdev, cell_num, size,

>> GFP_KERNEL);

>>  	if (!mfd_cells)

>>  		return -ENOMEM;

>

> And since you have structures already, I'm not sure why you need another

> allocation for them. Only what you would need is to apply resources and

> call devm_mfd_add_devices() per each found device.


I was creating a copy as the originals are in the hisi_lpc_acpi_mfd_cell 
struct type, while we would require an array of mfd_cells.

>

>> +		cell = container_of(mfd_cell_ref, typeof(*cell),

>> mfd_cell);

>

> Why we can't iterate over inherited type of objects directly?

>


We could do.

Thanks,
John
diff mbox series

Patch

diff --git a/drivers/bus/hisi_lpc.c b/drivers/bus/hisi_lpc.c
index 2d4611e..71693d77 100644
--- a/drivers/bus/hisi_lpc.c
+++ b/drivers/bus/hisi_lpc.c
@@ -341,15 +341,6 @@  static void hisi_lpc_comm_outs(void *hostdata, unsigned long pio,
 };
 
 #ifdef CONFIG_ACPI
-#define MFD_CHILD_NAME_PREFIX DRV_NAME"-"
-#define MFD_CHILD_NAME_LEN (ACPI_ID_LEN + sizeof(MFD_CHILD_NAME_PREFIX) - 1)
-
-struct hisi_lpc_mfd_cell {
-	struct mfd_cell_acpi_match acpi_match;
-	char name[MFD_CHILD_NAME_LEN];
-	char pnpid[ACPI_ID_LEN];
-};
-
 static int hisi_lpc_acpi_xlat_io_res(struct acpi_device *adev,
 				     struct acpi_device *host,
 				     struct resource *res)
@@ -367,6 +358,40 @@  static int hisi_lpc_acpi_xlat_io_res(struct acpi_device *adev,
 	return 0;
 }
 
+static const struct mfd_cell_acpi_match hisi_lpc_acpi_mfd_match_ipmi = {
+	.pnpid = "IPI0001",
+};
+
+struct hisi_lpc_acpi_mfd_cell {
+	struct mfd_cell mfd_cell;
+	int (*setup)(struct device *hostdev, struct mfd_cell *mfd_cell);
+} static const hisi_lpc_acpi_mfd_cells[] = {
+	/* ipmi */
+	{
+		.mfd_cell = {
+			.name = "hisi-lpc-ipmi",
+			.acpi_match = &hisi_lpc_acpi_mfd_match_ipmi,
+		},
+	},
+	{}
+};
+
+static const struct mfd_cell *hisi_lpc_acpi_mfd_get_cell(const char *hid)
+{
+	const struct hisi_lpc_acpi_mfd_cell *cell = hisi_lpc_acpi_mfd_cells;
+
+	for (; cell && cell->mfd_cell.name; cell++) {
+		const struct mfd_cell *mfd_cell = &cell->mfd_cell;
+		const struct mfd_cell_acpi_match *acpi_match;
+
+		acpi_match = mfd_cell->acpi_match;
+		if (!strcmp(acpi_match->pnpid, hid))
+			return mfd_cell;
+	}
+
+	return NULL;
+}
+
 /*
  * hisi_lpc_acpi_set_io_res - set the resources for a child's MFD
  * @child: the device node to be updated the I/O resource
@@ -464,7 +489,6 @@  static int hisi_lpc_acpi_set_io_res(struct device *child,
 static int hisi_lpc_acpi_probe(struct device *hostdev)
 {
 	struct acpi_device *adev = ACPI_COMPANION(hostdev);
-	struct hisi_lpc_mfd_cell *hisi_lpc_mfd_cells;
 	struct mfd_cell *mfd_cells;
 	struct acpi_device *child;
 	int size, ret, count = 0, cell_num = 0;
@@ -472,39 +496,24 @@  static int hisi_lpc_acpi_probe(struct device *hostdev)
 	list_for_each_entry(child, &adev->children, node)
 		cell_num++;
 
-	/* allocate the mfd cell and companion ACPI info, one per child */
-	size = sizeof(*mfd_cells) + sizeof(*hisi_lpc_mfd_cells);
+	/* allocate the mfd cells, one per child */
+	size = sizeof(*mfd_cells);
 	mfd_cells = devm_kcalloc(hostdev, cell_num, size, GFP_KERNEL);
 	if (!mfd_cells)
 		return -ENOMEM;
 
-	hisi_lpc_mfd_cells = (struct hisi_lpc_mfd_cell *)&mfd_cells[cell_num];
 	/* Only consider the children of the host */
 	list_for_each_entry(child, &adev->children, node) {
 		struct mfd_cell *mfd_cell = &mfd_cells[count];
-		struct hisi_lpc_mfd_cell *hisi_lpc_mfd_cell =
-					&hisi_lpc_mfd_cells[count];
-		struct mfd_cell_acpi_match *acpi_match =
-					&hisi_lpc_mfd_cell->acpi_match;
-		char *name = hisi_lpc_mfd_cell[count].name;
-		char *pnpid = hisi_lpc_mfd_cell[count].pnpid;
-		struct mfd_cell_acpi_match match = {
-			.pnpid = pnpid,
-		};
-
-		/*
-		 * For any instances of this host controller (Hip06 and Hip07
-		 * are the only chipsets), we would not have multiple slaves
-		 * with the same HID. And in any system we would have just one
-		 * controller active. So don't worrry about MFD name clashes.
-		 */
-		snprintf(name, MFD_CHILD_NAME_LEN, MFD_CHILD_NAME_PREFIX"%s",
-			 acpi_device_hid(child));
-		snprintf(pnpid, ACPI_ID_LEN, "%s", acpi_device_hid(child));
-
-		memcpy(acpi_match, &match, sizeof(*acpi_match));
-		mfd_cell->name = name;
-		mfd_cell->acpi_match = acpi_match;
+		const struct mfd_cell *mfd_cell_ref;
+		const char *hid = acpi_device_hid(child);
+		struct hisi_lpc_acpi_mfd_cell *cell;
+
+		mfd_cell_ref = hisi_lpc_acpi_mfd_get_cell(hid);
+		if (!mfd_cell_ref)
+			return -ENOENT;
+
+		memcpy(mfd_cell, mfd_cell_ref, sizeof(*mfd_cell));
 
 		ret = hisi_lpc_acpi_set_io_res(&child->dev, &adev->dev,
 					       &mfd_cell->resources,
@@ -513,6 +522,14 @@  static int hisi_lpc_acpi_probe(struct device *hostdev)
 			dev_warn(&child->dev, "set resource fail (%d)\n", ret);
 			return ret;
 		}
+
+		cell = container_of(mfd_cell_ref, typeof(*cell), mfd_cell);
+		if (cell->setup) {
+			ret = cell->setup(hostdev, mfd_cell);
+			if (ret)
+				return ret;
+		}
+
 		count++;
 	}