[PATCH] ACPI: implement UUID-labelled vendor-defined resources

[PATCH] ACPI: implement UUID-labelled vendor-defined resources

[Bjorn Helgaas]

ACPI 3.0 includes UUID-labelled vendor-defined resources (section 6.4.3.2),
so move the code that supports this from arch/ia64 into ACPI proper.

When the code was under arch/ia64, we used EFI GUID stuff, but this time I
defined acpi_uuid equivalents to avoid the need to depend on EFI.

Len, Tony, this touches both acpi and ia64.  Let me know if this is
a problem.

This patch may be used under either the GPL or the BSD license.

Signed-off-by: Bjorn Helgaas <bjorn.helgaas@hp.com>

=== arch/ia64/kernel/acpi-ext.c 1.5 vs edited ==--- 1.5/arch/ia64/kernel/acpi-ext.c	2004-10-05 12:19:50 -06:00
+++ edited/arch/ia64/kernel/acpi-ext.c	2005-03-18 11:29:18 -07:00
@@ -12,89 +12,35 @@
 #include <linux/module.h>
 #include <linux/types.h>
 #include <linux/acpi.h>
-#include <linux/efi.h>
 
 #include <asm/acpi-ext.h>
 
-struct acpi_vendor_descriptor {
-	u8				guid_id;
-	efi_guid_t			guid;
-};
-
-struct acpi_vendor_info {
-	struct acpi_vendor_descriptor	*descriptor;
-	u8				*data;
-	u32				length;
-};
-
-acpi_status
-acpi_vendor_resource_match(struct acpi_resource *resource, void *context)
-{
-	struct acpi_vendor_info *info = (struct acpi_vendor_info *) context;
-	struct acpi_resource_vendor *vendor;
-	struct acpi_vendor_descriptor *descriptor;
-	u32 length;
-
-	if (resource->id != ACPI_RSTYPE_VENDOR)
-		return AE_OK;
-
-	vendor = (struct acpi_resource_vendor *) &resource->data;
-	descriptor = (struct acpi_vendor_descriptor *) vendor->reserved;
-	if (vendor->length <= sizeof(*info->descriptor) ||
-	    descriptor->guid_id != info->descriptor->guid_id ||
-	    efi_guidcmp(descriptor->guid, info->descriptor->guid))
-		return AE_OK;
-
-	length = vendor->length - sizeof(struct acpi_vendor_descriptor);
-	info->data = acpi_os_allocate(length);
-	if (!info->data)
-		return AE_NO_MEMORY;
-
-	memcpy(info->data, vendor->reserved + sizeof(struct acpi_vendor_descriptor), length);
-	info->length = length;
-	return AE_CTRL_TERMINATE;
-}
-
-acpi_status
-acpi_find_vendor_resource(acpi_handle obj, struct acpi_vendor_descriptor *id,
-		u8 **data, u32 *length)
-{
-	struct acpi_vendor_info info;
-
-	info.descriptor = id;
-	info.data = NULL;
-
-	acpi_walk_resources(obj, METHOD_NAME__CRS, acpi_vendor_resource_match, &info);
-	if (!info.data)
-		return AE_NOT_FOUND;
-
-	*data = info.data;
-	*length = info.length;
-	return AE_OK;
-}
-
 struct acpi_vendor_descriptor hp_ccsr_descriptor = {
-	.guid_id = 2,
-	.guid    = EFI_GUID(0x69e9adf9, 0x924f, 0xab5f, 0xf6, 0x4a, 0x24, 0xd2, 0x01, 0x37, 0x0e, 0xad)
+	.uuid_subtype = 2,
+	.uuid    = ACPI_UUID(0x69e9adf9, 0x924f, 0xab5f, 0xf6, 0x4a, 0x24, 0xd2, 0x01, 0x37, 0x0e, 0xad)
 };
 
 acpi_status
 hp_acpi_csr_space(acpi_handle obj, u64 *csr_base, u64 *csr_length)
 {
-	acpi_status status;
-	u8 *data;
+	acpi_status status = AE_OK;
+	u8 *data = NULL;
 	u32 length;
 
-	status = acpi_find_vendor_resource(obj, &hp_ccsr_descriptor, &data, &length);
+	status = acpi_find_vendor_resource(obj, &hp_ccsr_descriptor, &data,
+		&length);
 
-	if (ACPI_FAILURE(status) || length != 16)
-		return AE_NOT_FOUND;
+	if (ACPI_FAILURE(status) || length != 16) {
+		status = AE_NOT_FOUND;
+		goto out;
+	}
 
 	memcpy(csr_base, data, sizeof(*csr_base));
 	memcpy(csr_length, data + 8, sizeof(*csr_length));
-	acpi_os_free(data);
 
-	return AE_OK;
+out:
+	acpi_os_free(data);
+	return status;
 }
 
 EXPORT_SYMBOL(hp_acpi_csr_space);
=== drivers/acpi/resources/rsxface.c 1.22 vs edited ==--- 1.22/drivers/acpi/resources/rsxface.c	2005-01-20 22:17:54 -07:00
+++ edited/drivers/acpi/resources/rsxface.c	2005-03-18 12:24:34 -07:00
@@ -435,3 +435,90 @@
 }
 EXPORT_SYMBOL(acpi_resource_to_address64);
 
+static inline int
+acpi_uuidcmp (struct acpi_uuid left, struct acpi_uuid right)
+{
+	return memcmp(&left, &right, sizeof(left));
+}
+
+static acpi_status
+acpi_vendor_resource_match(struct acpi_resource *resource, void *context)
+{
+	struct acpi_vendor_info *info = (struct acpi_vendor_info *) context;
+	struct acpi_resource_vendor *vendor;
+	struct acpi_vendor_descriptor *descriptor;
+	u32 length;
+
+	if (resource->id != ACPI_RSTYPE_VENDOR)
+		return AE_OK;
+
+	vendor = (struct acpi_resource_vendor *) &resource->data;
+	descriptor = (struct acpi_vendor_descriptor *) vendor->reserved;
+	if (vendor->length <= sizeof(*info->descriptor) ||
+	    descriptor->uuid_subtype != info->descriptor->uuid_subtype ||
+	    acpi_uuidcmp(descriptor->uuid, info->descriptor->uuid))
+		return AE_OK;
+
+	length = vendor->length - sizeof(struct acpi_vendor_descriptor);
+	info->data = acpi_os_allocate(length);
+	if (!info->data)
+		return AE_NO_MEMORY;
+
+	memcpy(info->data, vendor->reserved + sizeof(struct acpi_vendor_descriptor), length);
+	info->length = length;
+	return AE_CTRL_TERMINATE;
+}
+
+/*******************************************************************************
+ *
+ * FUNCTION:    acpi_find_vendor_resource
+ *
+ * PARAMETERS:  device_handle   - a handle to the device object for the
+ *                                device we are querying
+ *              id              - a pointer to the acpi_vendor_descriptor
+ *                                for the UUID-identified vendor-defined
+ *                                resource we want
+ *              data            - a pointer to a pointer where the address
+ *                                of the vendor data will be stored
+ *              length          - a pointer to an integer where the length
+ *                                of the vendor data will be stored
+ *
+ * RETURN:      Status
+ *
+ * DESCRIPTION: This function walks the current resources for the specified
+ *              device and looks for a vendor-defined resource that matches
+ *              the supplied UUID and subtype.
+ *
+ *              If the desired resource is found, a buffer is allocated for
+ *              the vendor-defined data (excluding the UUID and other headers),
+ *              and the address and size of the buffer are returned in *data
+ *              and *length.  The caller is responsible for deallocating
+ *              the buffer with acpi_os_free().
+ *
+ *              If the function fails, AE_NOT_FOUND will be returned and
+ *              the values of *data and *length are unchanged.
+ *
+ ******************************************************************************/
+
+acpi_status
+acpi_find_vendor_resource(
+	acpi_handle			device_handle,
+	struct acpi_vendor_descriptor	*id,
+	u8				**data,
+	u32				*length)
+{
+	struct acpi_vendor_info info;
+
+	info.descriptor = id;
+	info.data = NULL;
+
+	acpi_walk_resources(device_handle, METHOD_NAME__CRS,
+		acpi_vendor_resource_match, &info);
+	if (!info.data)
+		return AE_NOT_FOUND;
+
+	*data = info.data;
+	*length = info.length;
+	return AE_OK;
+}
+EXPORT_SYMBOL(acpi_find_vendor_resource);
=== include/acpi/acpixf.h 1.31 vs edited ==--- 1.31/include/acpi/acpixf.h	2005-01-20 22:17:55 -07:00
+++ edited/include/acpi/acpixf.h	2005-03-18 12:09:12 -07:00
@@ -425,10 +425,10 @@
 
 acpi_status
 acpi_walk_resources (
-	acpi_handle                             device_handle,
-	char                                    *path,
+	acpi_handle                     device_handle,
+	char                            *path,
 	ACPI_WALK_RESOURCE_CALLBACK     user_function,
-	void                                    *context);
+	void                            *context);
 
 acpi_status
 acpi_set_current_resources (
@@ -443,7 +443,14 @@
 acpi_status
 acpi_resource_to_address64 (
 	struct acpi_resource            *resource,
-	struct acpi_resource_address64 *out);
+	struct acpi_resource_address64  *out);
+
+acpi_status
+acpi_find_vendor_resource (
+	acpi_handle                     device_handle,
+	struct acpi_vendor_descriptor   *id,
+	u8                              **data,
+	u32                             *length);
 
 /*
  * Hardware (ACPI device) interfaces
=== include/acpi/actypes.h 1.41 vs edited ==--- 1.41/include/acpi/actypes.h	2005-01-20 22:17:55 -07:00
+++ edited/include/acpi/actypes.h	2005-03-18 11:23:21 -07:00
@@ -1045,6 +1045,16 @@
 #define ACPI_PRODUCER                   (u8) 0x00
 #define ACPI_CONSUMER                   (u8) 0x01
 
+struct acpi_uuid {
+	u8                              b[16];
+};
+
+#define ACPI_UUID(a,b,c,d0,d1,d2,d3,d4,d5,d6,d7) \
+((struct acpi_uuid) \
+{{ (a) & 0xff, ((a) >> 8) & 0xff, ((a) >> 16) & 0xff, ((a) >> 24) & 0xff, \
+  (b) & 0xff, ((b) >> 8) & 0xff, \
+  (c) & 0xff, ((c) >> 8) & 0xff, \
+  (d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7) }})
 
 /*
  *  Structures used to describe device resources
@@ -1097,6 +1107,18 @@
 {
 	u32                                 length;
 	u8                                  reserved[1];
+};
+
+struct acpi_vendor_descriptor
+{
+	u8                                  uuid_subtype;
+	struct acpi_uuid                    uuid;
+};
+
+struct acpi_vendor_info {
+	struct acpi_vendor_descriptor       *descriptor;
+	u8                                  *data;
+	u32                                 length;
 };
 
 struct acpi_resource_end_tag

Re: [ACPI] [PATCH] ACPI: implement UUID-labelled vendor-defined resources

[Bjorn Helgaas]

On Friday 18 March 2005 1:19 pm, Bjorn Helgaas wrote:
> ACPI 3.0 includes UUID-labelled vendor-defined resources (section 6.4.3.2),
> so move the code that supports this from arch/ia64 into ACPI proper.

There were some questions about the copyright status of this patch,
and whether it could be licensed appropriately for ACPI.  But I thought
those were all resolved.

I'm only trying to be a good citizen and contribute support for new
stuff in ACPI 3.0.  But if people want this to stay in ia64, I guess
that's OK with me, too.

BTW, is there still an ACPI BK tree?  The ones mentioned here:
    http://ftp.kernel.org/pub/linux/kernel/people/lenb/acpi/patches/README.ACPI
seem to be gone.

> When the code was under arch/ia64, we used EFI GUID stuff, but this time I
> defined acpi_uuid equivalents to avoid the need to depend on EFI.
> 
> Len, Tony, this touches both acpi and ia64.  Let me know if this is
> a problem.
> 
> This patch may be used under either the GPL or the BSD license.
> 
> Signed-off-by: Bjorn Helgaas <bjorn.helgaas@hp.com>
> 
> === arch/ia64/kernel/acpi-ext.c 1.5 vs edited ==> --- 1.5/arch/ia64/kernel/acpi-ext.c	2004-10-05 12:19:50 -06:00
> +++ edited/arch/ia64/kernel/acpi-ext.c	2005-03-18 11:29:18 -07:00
> @@ -12,89 +12,35 @@
>  #include <linux/module.h>
>  #include <linux/types.h>
>  #include <linux/acpi.h>
> -#include <linux/efi.h>
>  
>  #include <asm/acpi-ext.h>
>  
> -struct acpi_vendor_descriptor {
> -	u8				guid_id;
> -	efi_guid_t			guid;
> -};
> -
> -struct acpi_vendor_info {
> -	struct acpi_vendor_descriptor	*descriptor;
> -	u8				*data;
> -	u32				length;
> -};
> -
> -acpi_status
> -acpi_vendor_resource_match(struct acpi_resource *resource, void *context)
> -{
> -	struct acpi_vendor_info *info = (struct acpi_vendor_info *) context;
> -	struct acpi_resource_vendor *vendor;
> -	struct acpi_vendor_descriptor *descriptor;
> -	u32 length;
> -
> -	if (resource->id != ACPI_RSTYPE_VENDOR)
> -		return AE_OK;
> -
> -	vendor = (struct acpi_resource_vendor *) &resource->data;
> -	descriptor = (struct acpi_vendor_descriptor *) vendor->reserved;
> -	if (vendor->length <= sizeof(*info->descriptor) ||
> -	    descriptor->guid_id != info->descriptor->guid_id ||
> -	    efi_guidcmp(descriptor->guid, info->descriptor->guid))
> -		return AE_OK;
> -
> -	length = vendor->length - sizeof(struct acpi_vendor_descriptor);
> -	info->data = acpi_os_allocate(length);
> -	if (!info->data)
> -		return AE_NO_MEMORY;
> -
> -	memcpy(info->data, vendor->reserved + sizeof(struct acpi_vendor_descriptor), length);
> -	info->length = length;
> -	return AE_CTRL_TERMINATE;
> -}
> -
> -acpi_status
> -acpi_find_vendor_resource(acpi_handle obj, struct acpi_vendor_descriptor *id,
> -		u8 **data, u32 *length)
> -{
> -	struct acpi_vendor_info info;
> -
> -	info.descriptor = id;
> -	info.data = NULL;
> -
> -	acpi_walk_resources(obj, METHOD_NAME__CRS, acpi_vendor_resource_match, &info);
> -	if (!info.data)
> -		return AE_NOT_FOUND;
> -
> -	*data = info.data;
> -	*length = info.length;
> -	return AE_OK;
> -}
> -
>  struct acpi_vendor_descriptor hp_ccsr_descriptor = {
> -	.guid_id = 2,
> -	.guid    = EFI_GUID(0x69e9adf9, 0x924f, 0xab5f, 0xf6, 0x4a, 0x24, 0xd2, 0x01, 0x37, 0x0e, 0xad)
> +	.uuid_subtype = 2,
> +	.uuid    = ACPI_UUID(0x69e9adf9, 0x924f, 0xab5f, 0xf6, 0x4a, 0x24, 0xd2, 0x01, 0x37, 0x0e, 0xad)
>  };
>  
>  acpi_status
>  hp_acpi_csr_space(acpi_handle obj, u64 *csr_base, u64 *csr_length)
>  {
> -	acpi_status status;
> -	u8 *data;
> +	acpi_status status = AE_OK;
> +	u8 *data = NULL;
>  	u32 length;
>  
> -	status = acpi_find_vendor_resource(obj, &hp_ccsr_descriptor, &data, &length);
> +	status = acpi_find_vendor_resource(obj, &hp_ccsr_descriptor, &data,
> +		&length);
>  
> -	if (ACPI_FAILURE(status) || length != 16)
> -		return AE_NOT_FOUND;
> +	if (ACPI_FAILURE(status) || length != 16) {
> +		status = AE_NOT_FOUND;
> +		goto out;
> +	}
>  
>  	memcpy(csr_base, data, sizeof(*csr_base));
>  	memcpy(csr_length, data + 8, sizeof(*csr_length));
> -	acpi_os_free(data);
>  
> -	return AE_OK;
> +out:
> +	acpi_os_free(data);
> +	return status;
>  }
>  
>  EXPORT_SYMBOL(hp_acpi_csr_space);
> === drivers/acpi/resources/rsxface.c 1.22 vs edited ==> --- 1.22/drivers/acpi/resources/rsxface.c	2005-01-20 22:17:54 -07:00
> +++ edited/drivers/acpi/resources/rsxface.c	2005-03-18 12:24:34 -07:00
> @@ -435,3 +435,90 @@
>  }
>  EXPORT_SYMBOL(acpi_resource_to_address64);
>  
> +static inline int
> +acpi_uuidcmp (struct acpi_uuid left, struct acpi_uuid right)
> +{
> +	return memcmp(&left, &right, sizeof(left));
> +}
> +
> +static acpi_status
> +acpi_vendor_resource_match(struct acpi_resource *resource, void *context)
> +{
> +	struct acpi_vendor_info *info = (struct acpi_vendor_info *) context;
> +	struct acpi_resource_vendor *vendor;
> +	struct acpi_vendor_descriptor *descriptor;
> +	u32 length;
> +
> +	if (resource->id != ACPI_RSTYPE_VENDOR)
> +		return AE_OK;
> +
> +	vendor = (struct acpi_resource_vendor *) &resource->data;
> +	descriptor = (struct acpi_vendor_descriptor *) vendor->reserved;
> +	if (vendor->length <= sizeof(*info->descriptor) ||
> +	    descriptor->uuid_subtype != info->descriptor->uuid_subtype ||
> +	    acpi_uuidcmp(descriptor->uuid, info->descriptor->uuid))
> +		return AE_OK;
> +
> +	length = vendor->length - sizeof(struct acpi_vendor_descriptor);
> +	info->data = acpi_os_allocate(length);
> +	if (!info->data)
> +		return AE_NO_MEMORY;
> +
> +	memcpy(info->data, vendor->reserved + sizeof(struct acpi_vendor_descriptor), length);
> +	info->length = length;
> +	return AE_CTRL_TERMINATE;
> +}
> +
> +/*******************************************************************************
> + *
> + * FUNCTION:    acpi_find_vendor_resource
> + *
> + * PARAMETERS:  device_handle   - a handle to the device object for the
> + *                                device we are querying
> + *              id              - a pointer to the acpi_vendor_descriptor
> + *                                for the UUID-identified vendor-defined
> + *                                resource we want
> + *              data            - a pointer to a pointer where the address
> + *                                of the vendor data will be stored
> + *              length          - a pointer to an integer where the length
> + *                                of the vendor data will be stored
> + *
> + * RETURN:      Status
> + *
> + * DESCRIPTION: This function walks the current resources for the specified
> + *              device and looks for a vendor-defined resource that matches
> + *              the supplied UUID and subtype.
> + *
> + *              If the desired resource is found, a buffer is allocated for
> + *              the vendor-defined data (excluding the UUID and other headers),
> + *              and the address and size of the buffer are returned in *data
> + *              and *length.  The caller is responsible for deallocating
> + *              the buffer with acpi_os_free().
> + *
> + *              If the function fails, AE_NOT_FOUND will be returned and
> + *              the values of *data and *length are unchanged.
> + *
> + ******************************************************************************/
> +
> +acpi_status
> +acpi_find_vendor_resource(
> +	acpi_handle			device_handle,
> +	struct acpi_vendor_descriptor	*id,
> +	u8				**data,
> +	u32				*length)
> +{
> +	struct acpi_vendor_info info;
> +
> +	info.descriptor = id;
> +	info.data = NULL;
> +
> +	acpi_walk_resources(device_handle, METHOD_NAME__CRS,
> +		acpi_vendor_resource_match, &info);
> +	if (!info.data)
> +		return AE_NOT_FOUND;
> +
> +	*data = info.data;
> +	*length = info.length;
> +	return AE_OK;
> +}
> +EXPORT_SYMBOL(acpi_find_vendor_resource);
> === include/acpi/acpixf.h 1.31 vs edited ==> --- 1.31/include/acpi/acpixf.h	2005-01-20 22:17:55 -07:00
> +++ edited/include/acpi/acpixf.h	2005-03-18 12:09:12 -07:00
> @@ -425,10 +425,10 @@
>  
>  acpi_status
>  acpi_walk_resources (
> -	acpi_handle                             device_handle,
> -	char                                    *path,
> +	acpi_handle                     device_handle,
> +	char                            *path,
>  	ACPI_WALK_RESOURCE_CALLBACK     user_function,
> -	void                                    *context);
> +	void                            *context);
>  
>  acpi_status
>  acpi_set_current_resources (
> @@ -443,7 +443,14 @@
>  acpi_status
>  acpi_resource_to_address64 (
>  	struct acpi_resource            *resource,
> -	struct acpi_resource_address64 *out);
> +	struct acpi_resource_address64  *out);
> +
> +acpi_status
> +acpi_find_vendor_resource (
> +	acpi_handle                     device_handle,
> +	struct acpi_vendor_descriptor   *id,
> +	u8                              **data,
> +	u32                             *length);
>  
>  /*
>   * Hardware (ACPI device) interfaces
> === include/acpi/actypes.h 1.41 vs edited ==> --- 1.41/include/acpi/actypes.h	2005-01-20 22:17:55 -07:00
> +++ edited/include/acpi/actypes.h	2005-03-18 11:23:21 -07:00
> @@ -1045,6 +1045,16 @@
>  #define ACPI_PRODUCER                   (u8) 0x00
>  #define ACPI_CONSUMER                   (u8) 0x01
>  
> +struct acpi_uuid {
> +	u8                              b[16];
> +};
> +
> +#define ACPI_UUID(a,b,c,d0,d1,d2,d3,d4,d5,d6,d7) \
> +((struct acpi_uuid) \
> +{{ (a) & 0xff, ((a) >> 8) & 0xff, ((a) >> 16) & 0xff, ((a) >> 24) & 0xff, \
> +  (b) & 0xff, ((b) >> 8) & 0xff, \
> +  (c) & 0xff, ((c) >> 8) & 0xff, \
> +  (d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7) }})
>  
>  /*
>   *  Structures used to describe device resources
> @@ -1097,6 +1107,18 @@
>  {
>  	u32                                 length;
>  	u8                                  reserved[1];
> +};
> +
> +struct acpi_vendor_descriptor
> +{
> +	u8                                  uuid_subtype;
> +	struct acpi_uuid                    uuid;
> +};
> +
> +struct acpi_vendor_info {
> +	struct acpi_vendor_descriptor       *descriptor;
> +	u8                                  *data;
> +	u32                                 length;
>  };
>  
>  struct acpi_resource_end_tag
> 
> 
> 
> 
> -------------------------------------------------------
> SF email is sponsored by - The IT Product Guide
> Read honest & candid reviews on hundreds of IT Products from real users.
> Discover which products truly live up to the hype. Start reading now.
> http://ads.osdn.com/?ad_ide95&alloc_id\x14396&op=click
> _______________________________________________
> Acpi-devel mailing list
> Acpi-devel@lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/acpi-devel
> 

RE: [ACPI] [PATCH] ACPI: implement UUID-labelled vendor-defined resources

[Moore, Robert]

And to make things even more interesting, the base ACPICA code looks
nothing like the final Linux version of the code; it is converted on the
fly before every release to Linux.

BTW, Please explain in more detail what support is needed in ACPICA for
the ACPI 3.0 vendor-defined resource.  Also, any idea how we are
supposed to determine if the UUID data exists within the descriptor?
(i.e., how do we differentiate an ACPI 2.0 vendor descriptor from an
ACPI 3.0 descriptor?)

Thanks,
Bob


> -----Original Message-----
> From: acpi-devel-admin@lists.sourceforge.net [mailto:acpi-devel-
> admin@lists.sourceforge.net] On Behalf Of Bjorn Helgaas
> Sent: Friday, September 16, 2005 10:41 AM
> To: Brown, Len
> Cc: Alex Williamson; acpi-devel@lists.sourceforge.net; Luck, Tony;
linux-
> ia64@vger.kernel.org
> Subject: [ACPI] [PATCH] ACPI: implement UUID-labelled vendor-defined
> resources
> 
> ACPI 3.0 includes UUID-labelled vendor-defined resources (section
> 6.4.3.2),
> so move the code that supports this from arch/ia64 into ACPI proper.
> 
> Len, Tony, this touches both acpi and ia64.  Probably easiest
> if Tony acks it and Len decides whether to apply it.
> 
> HP owns all the copyrights on the code being moved, and we agree
> that the code being moved into the ACPI CA may be used under either
> the GPL or the BSD-style license used by the ACPI CA.
> 
> (There should be something in Documentation/acpi about how to
> contribute to the ACPI CA.  It's a royal pain in the rear :-)).
> 

Re: [ACPI] [PATCH] ACPI: implement UUID-labelled vendor-defined resources

[Bjorn Helgaas]

On Friday 16 September 2005 3:56 pm, Moore, Robert wrote:
> And to make things even more interesting, the base ACPICA code looks
> nothing like the final Linux version of the code; it is converted on the
> fly before every release to Linux.

Well, if you decide you'll integrate the code, I can dig out the
pre-converted ACPICA code and make a patch against it.

> BTW, Please explain in more detail what support is needed in ACPICA for
> the ACPI 3.0 vendor-defined resource.  Also, any idea how we are
> supposed to determine if the UUID data exists within the descriptor?
> (i.e., how do we differentiate an ACPI 2.0 vendor descriptor from an
> ACPI 3.0 descriptor?)

There's no mark that distinguishes 2.0 and 3.0 vendor descriptors.
As far as I can tell, a 3.0 descriptor (that contains a UUID and
sub-type) is also a perfectly valid 2.0 descriptor.

ACPI 3.0 "strongs recommends," but apparently doesn't actually
require a UUID, so a 2.0 vendor descriptor should also be a valid
3.0 descriptor.

The idea is that we just look through all the vendor descriptors
for the supplied UUID.  If we find one, we return the information.
There's a small possibility that an ACPI 2.0, non-UUID-labelled
descriptor will contain data that happens to match the random
16-byte UUID, and we'll return it by mistake.  But that possibility
is pretty remote, I think.

The point of having this code in ACPICA is so that people who
use UUID-labelled vendor descriptors can do something simple
like this:

> struct acpi_vendor_descriptor hp_ccsr_descriptor = {
>         .uuid_subtype = 2,
>         .uuid = ACPI_UUID(0x69e9adf9, 0x924f, 0xab5f, 0xf6, 0x4a, 0x24, 0xd2,
>                           0x01, 0x37, 0x0e, 0xad)
> };
> 
> acpi_status hp_acpi_csr_space(acpi_handle obj, u64 * csr_base, u64 * csr_length)
> {
>...
>         status = acpi_find_vendor_resource(obj, &hp_ccsr_descriptor, &data,
>                 &length);

rather than having to duplicate the implementation of
acpi_find_vendor_resource().  But that's an obvious answer.
Maybe you had a deeper question that I missed?

This is pretty generic stuff, certainly not ia64-, or even OS-
dependent.  So I thought ACPICA would be a logical place for it.
If you have other suggestions, let me know.

Re: [ACPI] [PATCH] ACPI: implement UUID-labelled vendor-defined resources

[Bjorn Helgaas]

On Monday 19 September 2005 9:31 am, Bjorn Helgaas wrote:
> > BTW, Please explain in more detail what support is needed in ACPICA for
> > the ACPI 3.0 vendor-defined resource.  Also, any idea how we are
> > supposed to determine if the UUID data exists within the descriptor?
> > (i.e., how do we differentiate an ACPI 2.0 vendor descriptor from an
> > ACPI 3.0 descriptor?)
> 
> There's no mark that distinguishes 2.0 and 3.0 vendor descriptors.
> As far as I can tell, a 3.0 descriptor (that contains a UUID and
> sub-type) is also a perfectly valid 2.0 descriptor.
> 
> ACPI 3.0 "strongs recommends," but apparently doesn't actually
> require a UUID, so a 2.0 vendor descriptor should also be a valid
> 3.0 descriptor.
> 
> The idea is that we just look through all the vendor descriptors
> for the supplied UUID.  If we find one, we return the information.
> There's a small possibility that an ACPI 2.0, non-UUID-labelled
> descriptor will contain data that happens to match the random
> 16-byte UUID, and we'll return it by mistake.  But that possibility
> is pretty remote, I think.

Ping...  Did this make any sense, or did I answer the wrong questions?

Re: [ACPI] [PATCH] ACPI: implement UUID-labelled vendor-defined resources

[Christoph Hellwig]

On Fri, Sep 16, 2005 at 02:56:31PM -0700, Moore, Robert wrote:
> And to make things even more interesting, the base ACPICA code looks
> nothing like the final Linux version of the code; it is converted on the
> fly before every release to Linux.

So the Linux code is not the "preferred from of modification"?  You're
on an extremly slipperly slope vs the GPL there.  Not that I want to
sue your or intel, but this is certainly not in the spirit of the
License.

Re: [ACPI] [PATCH] ACPI: implement UUID-labelled vendor-defined resources

[Pavel Machek]

Hi!

> > And to make things even more interesting, the base ACPICA code looks
> > nothing like the final Linux version of the code; it is converted on the
> > fly before every release to Linux.
> 
> So the Linux code is not the "preferred from of modification"?  You're
> on an extremly slipperly slope vs the GPL there.  Not that I want to
> sue your or intel, but this is certainly not in the spirit of the
> License.

Actually, they change it to conform to kernel coding-style... That
should be okay.

								Pavel
-- 
if you have sharp zaurus hardware you don't need... you know my address

RE: [ACPI] [PATCH] ACPI: implement UUID-labelled vendor-defined resources

[Moore, Robert]

I'll get to this a bit later.
Thx
Bob


> -----Original Message-----
> From: Bjorn Helgaas [mailto:bjorn.helgaas@hp.com]
> Sent: Tuesday, September 20, 2005 4:10 PM
> To: acpi-devel@lists.sourceforge.net
> Cc: Moore, Robert; Brown, Len; Alex Williamson; Luck, Tony; linux-
> ia64@vger.kernel.org
> Subject: Re: [ACPI] [PATCH] ACPI: implement UUID-labelled
vendor-defined
> resources
> 
> On Monday 19 September 2005 9:31 am, Bjorn Helgaas wrote:
> > > BTW, Please explain in more detail what support is needed in
ACPICA
> for
> > > the ACPI 3.0 vendor-defined resource.  Also, any idea how we are
> > > supposed to determine if the UUID data exists within the
descriptor?
> > > (i.e., how do we differentiate an ACPI 2.0 vendor descriptor from
an
> > > ACPI 3.0 descriptor?)
> >
> > There's no mark that distinguishes 2.0 and 3.0 vendor descriptors.
> > As far as I can tell, a 3.0 descriptor (that contains a UUID and
> > sub-type) is also a perfectly valid 2.0 descriptor.
> >
> > ACPI 3.0 "strongs recommends," but apparently doesn't actually
> > require a UUID, so a 2.0 vendor descriptor should also be a valid
> > 3.0 descriptor.
> >
> > The idea is that we just look through all the vendor descriptors
> > for the supplied UUID.  If we find one, we return the information.
> > There's a small possibility that an ACPI 2.0, non-UUID-labelled
> > descriptor will contain data that happens to match the random
> > 16-byte UUID, and we'll return it by mistake.  But that possibility
> > is pretty remote, I think.
> 
> Ping...  Did this make any sense, or did I answer the wrong questions?

[PATCH] ACPI: implement UUID-labelled vendor-defined resources

[Bjorn Helgaas]

ACPI 3.0 includes UUID-labelled vendor-defined resources (section 6.4.3.2),
so move the code that supports this from arch/ia64 into ACPI proper.

Len, Tony, this touches both acpi and ia64.  Probably easiest
if Tony acks it and Len decides whether to apply it.

HP owns all the copyrights on the code being moved, and we agree
that the code being moved into the ACPI CA may be used under either
the GPL or the BSD-style license used by the ACPI CA.

(There should be something in Documentation/acpi about how to
contribute to the ACPI CA.  It's a royal pain in the rear :-)).

Signed-off-by: Bjorn Helgaas <bjorn.helgaas@hp.com>

=== arch/ia64/kernel/acpi-ext.c 1.5 vs edited ==Index: work-vga2/arch/ia64/kernel/acpi-ext.c
=================================--- work-vga2.orig/arch/ia64/kernel/acpi-ext.c	2005-09-14 09:28:07.000000000 -0600
+++ work-vga2/arch/ia64/kernel/acpi-ext.c	2005-09-15 14:52:33.000000000 -0600
@@ -1,105 +1,45 @@
 /*
- * arch/ia64/kernel/acpi-ext.c
+ * Vendor specific extensions to ACPI.
  *
- * Copyright (C) 2003 Hewlett-Packard
+ * (c) Copyright 2003, 2005 Hewlett-Packard Development Company, L.P.
  * Copyright (C) Alex Williamson
  * Copyright (C) Bjorn Helgaas
- *
- * Vendor specific extensions to ACPI.
  */
 
 #include <linux/config.h>
 #include <linux/module.h>
 #include <linux/types.h>
 #include <linux/acpi.h>
-#include <linux/efi.h>
 
 #include <asm/acpi-ext.h>
 
-struct acpi_vendor_descriptor {
-	u8 guid_id;
-	efi_guid_t guid;
-};
-
-struct acpi_vendor_info {
-	struct acpi_vendor_descriptor *descriptor;
-	u8 *data;
-	u32 length;
-};
-
-acpi_status
-acpi_vendor_resource_match(struct acpi_resource *resource, void *context)
-{
-	struct acpi_vendor_info *info = (struct acpi_vendor_info *)context;
-	struct acpi_resource_vendor *vendor;
-	struct acpi_vendor_descriptor *descriptor;
-	u32 length;
-
-	if (resource->id != ACPI_RSTYPE_VENDOR)
-		return AE_OK;
-
-	vendor = (struct acpi_resource_vendor *)&resource->data;
-	descriptor = (struct acpi_vendor_descriptor *)vendor->reserved;
-	if (vendor->length <= sizeof(*info->descriptor) ||
-	    descriptor->guid_id != info->descriptor->guid_id ||
-	    efi_guidcmp(descriptor->guid, info->descriptor->guid))
-		return AE_OK;
-
-	length = vendor->length - sizeof(struct acpi_vendor_descriptor);
-	info->data = acpi_os_allocate(length);
-	if (!info->data)
-		return AE_NO_MEMORY;
-
-	memcpy(info->data,
-	       vendor->reserved + sizeof(struct acpi_vendor_descriptor),
-	       length);
-	info->length = length;
-	return AE_CTRL_TERMINATE;
-}
-
-acpi_status
-acpi_find_vendor_resource(acpi_handle obj, struct acpi_vendor_descriptor * id,
-			  u8 ** data, u32 * length)
-{
-	struct acpi_vendor_info info;
-
-	info.descriptor = id;
-	info.data = NULL;
-
-	acpi_walk_resources(obj, METHOD_NAME__CRS, acpi_vendor_resource_match,
-			    &info);
-	if (!info.data)
-		return AE_NOT_FOUND;
-
-	*data = info.data;
-	*length = info.length;
-	return AE_OK;
-}
 
 struct acpi_vendor_descriptor hp_ccsr_descriptor = {
-	.guid_id = 2,
-	.guid -	    EFI_GUID(0x69e9adf9, 0x924f, 0xab5f, 0xf6, 0x4a, 0x24, 0xd2, 0x01,
-		     0x37, 0x0e, 0xad)
+	.uuid_subtype = 2,
+	.uuid = ACPI_UUID(0x69e9adf9, 0x924f, 0xab5f, 0xf6, 0x4a, 0x24, 0xd2,
+			  0x01, 0x37, 0x0e, 0xad)
 };
 
 acpi_status hp_acpi_csr_space(acpi_handle obj, u64 * csr_base, u64 * csr_length)
 {
-	acpi_status status;
-	u8 *data;
+	acpi_status status = AE_OK;
+	u8 *data = NULL;
 	u32 length;
 
-	status -	    acpi_find_vendor_resource(obj, &hp_ccsr_descriptor, &data, &length);
+	status = acpi_find_vendor_resource(obj, &hp_ccsr_descriptor, &data,
+		&length);
 
-	if (ACPI_FAILURE(status) || length != 16)
-		return AE_NOT_FOUND;
+	if (ACPI_FAILURE(status) || length != 16) {
+		status = AE_NOT_FOUND;
+		goto out;
+	}
 
 	memcpy(csr_base, data, sizeof(*csr_base));
 	memcpy(csr_length, data + 8, sizeof(*csr_length));
-	acpi_os_free(data);
 
-	return AE_OK;
+ out:
+	acpi_os_free(data);
+	return status;
 }
 
 EXPORT_SYMBOL(hp_acpi_csr_space);
Index: work-vga2/drivers/acpi/resources/rsxface.c
=================================--- work-vga2.orig/drivers/acpi/resources/rsxface.c	2005-09-14 09:28:10.000000000 -0600
+++ work-vga2/drivers/acpi/resources/rsxface.c	2005-09-15 14:29:02.000000000 -0600
@@ -410,3 +410,90 @@
 }
 
 EXPORT_SYMBOL(acpi_resource_to_address64);
+
+static inline int
+acpi_uuidcmp (struct acpi_uuid left, struct acpi_uuid right)
+{
+	return memcmp(&left, &right, sizeof(left));
+}
+
+static acpi_status
+acpi_vendor_resource_match(struct acpi_resource *resource, void *context)
+{
+	struct acpi_vendor_info *info = (struct acpi_vendor_info *) context;
+	struct acpi_resource_vendor *vendor;
+	struct acpi_vendor_descriptor *descriptor;
+	u32 length;
+
+	if (resource->id != ACPI_RSTYPE_VENDOR)
+		return AE_OK;
+
+	vendor = (struct acpi_resource_vendor *) &resource->data;
+	descriptor = (struct acpi_vendor_descriptor *) vendor->reserved;
+	if (vendor->length <= sizeof(*info->descriptor) ||
+	    descriptor->uuid_subtype != info->descriptor->uuid_subtype ||
+	    acpi_uuidcmp(descriptor->uuid, info->descriptor->uuid))
+		return AE_OK;
+
+	length = vendor->length - sizeof(struct acpi_vendor_descriptor);
+	info->data = acpi_os_allocate(length);
+	if (!info->data)
+		return AE_NO_MEMORY;
+
+	memcpy(info->data, vendor->reserved +
+		sizeof(struct acpi_vendor_descriptor), length);
+	info->length = length;
+	return AE_CTRL_TERMINATE;
+}
+
+/*******************************************************************************
+ *
+ * FUNCTION:    acpi_find_vendor_resource
+ *
+ * PARAMETERS:  device_handle   - a handle to the device object for the
+ *                                device we are querying
+ *              id              - a pointer to the acpi_vendor_descriptor
+ *                                for the UUID-identified vendor-defined
+ *                                resource we want
+ *              data            - a pointer to a pointer where the address
+ *                                of the vendor data will be stored
+ *              length          - a pointer to an integer where the length
+ *                                of the vendor data will be stored
+ *
+ * RETURN:      Status
+ *
+ * DESCRIPTION: This function walks the current resources for the specified
+ *              device and looks for a vendor-defined resource that matches
+ *              the supplied UUID and subtype.
+ *
+ *              If the desired resource is found, a buffer is allocated for
+ *              the vendor-defined data (excluding the UUID and other headers),
+ *              and the address and size of the buffer are returned in *data
+ *              and *length.  The caller is responsible for deallocating
+ *              the buffer with acpi_os_free().
+ *
+ *              If the function fails, AE_NOT_FOUND will be returned and
+ *              the values of *data and *length are unchanged.
+ *
+ ******************************************************************************/
+
+acpi_status
+acpi_find_vendor_resource(acpi_handle device_handle,
+	struct acpi_vendor_descriptor *id, u8 **data, u32 *length)
+{
+	struct acpi_vendor_info info;
+
+	info.descriptor = id;
+	info.data = NULL;
+
+	acpi_walk_resources(device_handle, METHOD_NAME__CRS,
+		acpi_vendor_resource_match, &info);
+	if (!info.data)
+		return AE_NOT_FOUND;
+
+	*data = info.data;
+	*length = info.length;
+	return AE_OK;
+}
+
+EXPORT_SYMBOL(acpi_find_vendor_resource);
Index: work-vga2/include/acpi/acpixf.h
=================================--- work-vga2.orig/include/acpi/acpixf.h	2005-09-14 09:29:10.000000000 -0600
+++ work-vga2/include/acpi/acpixf.h	2005-09-15 14:30:59.000000000 -0600
@@ -295,6 +295,11 @@
 acpi_resource_to_address64(struct acpi_resource *resource,
 			   struct acpi_resource_address64 *out);
 
+acpi_status
+acpi_find_vendor_resource (acpi_handle device_handle,
+			   struct acpi_vendor_descriptor *id,
+			   u8 **data, u32 *length);
+
 /*
  * Hardware (ACPI device) interfaces
  */
Index: work-vga2/include/acpi/actypes.h
=================================--- work-vga2.orig/include/acpi/actypes.h	2005-09-14 09:29:11.000000000 -0600
+++ work-vga2/include/acpi/actypes.h	2005-09-15 14:33:06.000000000 -0600
@@ -974,6 +974,17 @@
 #define ACPI_PRODUCER                   (u8) 0x00
 #define ACPI_CONSUMER                   (u8) 0x01
 
+struct acpi_uuid {
+	u8                              b[16];
+};
+
+#define ACPI_UUID(a,b,c,d0,d1,d2,d3,d4,d5,d6,d7) \
+    ((struct acpi_uuid) \
+    {{ (a) & 0xff, ((a) >> 8) & 0xff, ((a) >> 16) & 0xff, ((a) >> 24) & 0xff, \
+      (b) & 0xff, ((b) >> 8) & 0xff, \
+      (c) & 0xff, ((c) >> 8) & 0xff, \
+      (d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7) }})
+
 /*
  *  Structures used to describe device resources
  */
@@ -1021,6 +1032,18 @@
 	u8 reserved[1];
 };
 
+struct acpi_vendor_descriptor
+{
+	u8 uuid_subtype;
+	struct acpi_uuid uuid;
+};
+
+struct acpi_vendor_info {
+	struct acpi_vendor_descriptor *descriptor;
+	u8 *data;
+	u32 length;
+};
+
 struct acpi_resource_end_tag {
 	u8 checksum;
 };