OMAP: omap_device: add omap_device_is_valid()
Subsystems (2)
PATCH 1/2 OMAP: omap_device: add omap_device_is_valid()
The omap_device struct contains a 'struct platform_device'. Normally, converting a platform_device pointer to an omap_device pointer consists of simply doing a container_of(), as is done currently by the to_omap_device() macro.
However, if this is attempted when using platform_device that has not been created as part of the omap_device creation, the container_of() will point to a memory location before the platform_device pointer which will contain random data.
Therefore, we need a way to detect valid omap_device pointers. This patch solves this by using the simple magic number approach.
---
Changes from original version:
- set magic value before omap_device_register()
arch/arm/plat-omap/include/plat/omap_device.h | 2 ++ arch/arm/plat-omap/omap_device.c | 16 ++++++++++++++++ 2 files changed, 18 insertions(+), 0 deletions(-)
arch/arm/plat-omap/include/plat/omap_device.h +2 -0
@@ -62,6 +62,7 @@* */ struct omap_device { +u32 magic;struct platform_device pdev;struct omap_hwmod **hwmods;struct omap_device_pm_latency *pm_lats;
@@ -81,6 +82,7 @@ int omap_device_shutdown(struct platform_device *pdev);/* Core code interface */ +bool omap_device_is_valid (struct omap_device *od);int omap_device_count_resources (struct omap_device *od);int omap_device_fill_resources (struct omap_device *od,struct resource *res);
arch/arm/plat-omap/omap_device.c +16 -0
@@ -100,6 +100,8 @@# error Unknown OMAP device#endif +#define OMAP_DEVICE_MAGIC 0xf00dcafe +/* Private functions */ /**
@@ -413,6 +415,8 @@ struct omap_device *omap_device_build_ss(const char *pdev_name, int pdev_id, od->pm_lats = pm_lats; od->pm_lats_cnt = pm_lats_cnt; + od->magic =OMAP_DEVICE_MAGIC ; + ret =omap_device_register (od);if (ret) goto odbs_exit4;
@@ -599,6 +603,18 @@ int omap_device_align_pm_lat(struct platform_device *pdev, }/** +* omap_device_is_valid() +* @od: struct omap_device * +* +* Return whether struct omap_device pointer @od points to a valid +* omap_device. +*/ +bool omap_device_is_valid (struct omap_device *od) +{ +return (od && od->magic ==OMAP_DEVICE_MAGIC ); +} + +/** * omap_device_get_pwrdm - return the powerdomain * associated with @od * @od: struct omap_device * *
Signature · 1 line
1.6.6
PATCH 2/2 OMAP: omap_device: when 'called from invalid state', print state
The omap_device_[enable|idle|shutdown] functions print a warning when called from an invalid state. Print the invalid state in the warning messages. This also uses __func__ to get the function name.
Also, move the entire print string onto a single line to facilitate grepping or error messages. Recent discussions on LKML show strong preference for grep-able code vs. strict 80 column limit.
--- arch/arm/plat-omap/omap_device.c | 12 ++++++------ 1 files changed, 6 insertions(+), 6 deletions(-)
arch/arm/plat-omap/omap_device.c +6 -6
@@ -476,8 +476,8 @@ int omap_device_enable(struct platform_device *pdev) od =_find_by_pdev (pdev);if (od->_state ==OMAP_DEVICE_STATE_ENABLED ) { -WARN (1 ,"omap_device: %s.%d: omap_device_enable() called from " -"invalid state\n" , od->pdev.name, od->pdev.id); +WARN (1 ,"omap_device: %s.%d: %s() called from invalid state %d\n" , + od->pdev.name, od->pdev.id, __func__, od->_state);return -EINVAL ; }
@@ -515,8 +515,8 @@ int omap_device_idle(struct platform_device *pdev) od =_find_by_pdev (pdev);if (od->_state !=OMAP_DEVICE_STATE_ENABLED ) { -WARN (1 ,"omap_device: %s.%d: omap_device_idle() called from " -"invalid state\n" , od->pdev.name, od->pdev.id); +WARN (1 ,"omap_device: %s.%d: %s() called from invalid state %d\n" , + od->pdev.name, od->pdev.id, __func__, od->_state);return -EINVAL ; }
@@ -548,8 +548,8 @@ int omap_device_shutdown(struct platform_device *pdev)if (od->_state !=OMAP_DEVICE_STATE_ENABLED && od->_state !=OMAP_DEVICE_STATE_IDLE ) { -WARN (1 ,"omap_device: %s.%d: omap_device_shutdown() called " -"from invalid state\n" , od->pdev.name, od->pdev.id); +WARN (1 ,"omap_device: %s.%d: %s() called from invalid state %d\n" , + od->pdev.name, od->pdev.id, __func__, od->_state);return -EINVAL ; }
Signature · 1 line
1.6.6
Re: [PATCH 2/2] OMAP: omap_device: when 'called from invalid state', print state
Quoted 10 lines · Kevin Hilman
The omap_device_[enable|idle|shutdown] functions print a warning when called from an invalid state. Print the invalid state in the warning messages. This also uses
__func__to get the function name.Also, move the entire print string onto a single line to facilitate grepping or error messages. Recent discussions on LKML show strong preference for grep-able code vs. strict 80 column limit.
Signed-off-by Kevin Hilman <[email protected]>
Thanks, queued for 2.6.34.
- Paul
Hi Kevin,
this looks fine. Two quick comments:
Quoted 5 lines · Kevin Hilman
The
omap_devicestruct contains a 'structplatform_device'. Normally, converting aplatform_devicepointer to anomap_devicepointer consists of simply doing acontainer_of(), as is done currently by theto_omap_device()macro.
Quoted 7 lines
However, if this is attempted when using
platform_devicethat has not been created as part of theomap_devicecreation, thecontainer_of()will point to a memory location before theplatform_devicepointer which will contain random data.Therefore, we need a way to detect valid
omap_devicepointers. This patch solves this by using the simple magic number approach.
Sounds okay; just FYI at some point in the future, it would be good for one of us to take a whack at converting omap_device to contain platform_device, the same way that platform_device contains struct device, etc..
Quoted 53 lines
Signed-off-by Kevin Hilman <[email protected]>---
Changes from original version:
- set magic value beforeomap_device_register()arch/arm/plat-omap/include/plat/omap_device.h | 2 ++ arch/arm/plat-omap/omap_device.c | 16 ++++++++++++++++ 2 files changed, 18 insertions(+), 0 deletions(-)arch/arm/plat-omap/include/plat/omap_device.h +2
-0@@ -62,6 +62,7 @@* */ struct omap_device { +u32 magic;struct platform_device pdev;struct omap_hwmod **hwmods;struct omap_device_pm_latency *pm_lats;@@ -81,6 +82,7 @@ int omap_device_shutdown(struct platform_device *pdev);/* Core code interface */ +bool omap_device_is_valid (struct omap_device *od);int omap_device_count_resources (struct omap_device *od);int omap_device_fill_resources (struct omap_device *od,struct resource *res);arch/arm/plat-omap/omap_device.c +4
-0@@ -100,6 +100,8 @@# error Unknown OMAP device#endif +#define OMAP_DEVICE_MAGIC 0xf00dcafe +/* Private functions */ /** @@ -413,6 +415,8 @@ struct omap_device *omap_device_build_ss(const char *pdev_name, int pdev_id, od->pm_lats = pm_lats; od->pm_lats_cnt = pm_lats_cnt; + od->magic =OMAP_DEVICE_MAGIC ; + ret =omap_device_register (od);if (ret) goto odbs_exit4;
arch/arm/plat-omap/omap_device.c int omap_device_align_pm_lat(struct platform_device *pdev, · line 606
Quoted 4 lines
arch/arm/plat-omap/omap_device.c +1
-0@@ -599,6 +603,18 @@ int omap_device_align_pm_lat(struct platform_device *pdev, }/** +* omap_device_is_valid()
I think kerneldoc will want a short description after the function name. Can plug this in here during the merge process if you want...
Quoted 22 lines
arch/arm/plat-omap/omap_device.c +11
-0+* @od: struct omap_device * +* +* Return whether struct omap_device pointer @od points to a valid +* omap_device. +*/ +bool omap_device_is_valid (struct omap_device *od) +{ +return (od && od->magic ==OMAP_DEVICE_MAGIC ); +} + +/** * omap_device_get_pwrdm - return the powerdomain * associated with @od * @od: struct omap_device * * Signature · 6 lines
1.6.6 -- To unsubscribe from this list: send the line "unsubscribe linux-omap" in the body of a message to [email protected] More majordomo info at http://vger.kernel.org/majordomo-info.html
- Paul
Quoted 16 lines · Paul Walmsley
Hi Kevin,
this looks fine. Two quick comments:
Quoted 10 lines · Kevin Hilman
The
omap_devicestruct contains a 'structplatform_device'. Normally, converting aplatform_devicepointer to anomap_devicepointer consists of simply doing acontainer_of(), as is done currently by theto_omap_device()macro.However, if this is attempted when using
platform_devicethat has not been created as part of theomap_devicecreation, thecontainer_of()will point to a memory location before theplatform_devicepointer which will contain random data.
Quoted 7 lines
Quoted 2 lines
Therefore, we need a way to detect valid
omap_devicepointers. This patch solves this by using the simple magic number approach.Sounds okay; just FYI at some point in the future, it would be good for one of us to take a whack at converting
omap_deviceto containplatform_device, the same way thatplatform_devicecontains struct device, etc..
Hmm, not sure I follow...
struct omap_device already contains a struct platform_device, which in turn contains a struct device, so to get an omap_device from a struct device, there are two container of operaions: to_platform_device() and to_omap_device()
from omap_device.h:
struct omap_device {
u32 magic;
struct platform_device pdev;
[...]
}#define to_omap_device(x) container_of((x), struct omap_device, pdev)
from platform_device.h:
struct platform_device {
const char * name;
int id;
struct device dev;
[...]
}#define to_platform_device(x) container_of((x), struct platform_device, dev)
Quoted 55 lines
Quoted 55 lines
Signed-off-by Kevin Hilman <[email protected]>---
Changes from original version:
- set magic value beforeomap_device_register()arch/arm/plat-omap/include/plat/omap_device.h | 2 ++ arch/arm/plat-omap/omap_device.c | 16 ++++++++++++++++ 2 files changed, 18 insertions(+), 0 deletions(-)arch/arm/plat-omap/include/plat/omap_device.h +2
-0@@ -62,6 +62,7 @@* */ struct omap_device { +u32 magic;struct platform_device pdev;struct omap_hwmod **hwmods;struct omap_device_pm_latency *pm_lats;@@ -81,6 +82,7 @@ int omap_device_shutdown(struct platform_device *pdev);/* Core code interface */ +bool omap_device_is_valid (struct omap_device *od);int omap_device_count_resources (struct omap_device *od);int omap_device_fill_resources (struct omap_device *od,struct resource *res);arch/arm/plat-omap/omap_device.c +4
-0@@ -100,6 +100,8 @@# error Unknown OMAP device#endif +#define OMAP_DEVICE_MAGIC 0xf00dcafe +/* Private functions */ /** @@ -413,6 +415,8 @@ struct omap_device *omap_device_build_ss(const char *pdev_name, int pdev_id, od->pm_lats = pm_lats; od->pm_lats_cnt = pm_lats_cnt; + od->magic =OMAP_DEVICE_MAGIC ; + ret =omap_device_register (od);if (ret) goto odbs_exit4;@@ -599,6 +603,18 @@ int omap_device_align_pm_lat(struct platform_device *pdev, }
Quoted 5 lines
arch/arm/plat-omap/omap_device.c int omap_device_align_pm_lat(struct platform_device *pdev, · line 606
Quoted 2 lines
arch/arm/plat-omap/omap_device.c +1
-0/** +* omap_device_is_valid() I think kerneldoc will want a short description after the function name. Can plug this in here during the merge process if you want...
done, updated version below.
Thanks for comments,
Kevin
Quoted 1 line
From
cd8cfaf6663da00645eca7bcf8f2faf1d5b96cf2Mon Sep 17 00:00:00 2001
From: Kevin Hilman <[email protected]>
Date: Tue, 12 Jan 2010 16:37:47 -0800
Subject: [PATCH 1/2] OMAP: omap_device: add omap_device_is_valid()
The omap_device struct contains a 'struct platform_device'. Normally, converting a platform_device pointer to an omap_device pointer consists of simply doing a container_of(), as is done currently by the to_omap_device() macro.
However, if this is attempted when using platform_device that has not been created as part of the omap_device creation, the container_of() will point to a memory location before the platform_device pointer which will contain random data.
Therefore, we need a way to detect valid omap_device pointers. This patch solves this by using the simple magic number approach.
--- arch/arm/plat-omap/include/plat/omap_device.h | 2 ++ arch/arm/plat-omap/omap_device.c | 16 ++++++++++++++++ 2 files changed, 18 insertions(+), 0 deletions(-)
arch/arm/plat-omap/include/plat/omap_device.h +2 -0
@@ -62,6 +62,7 @@* */ struct omap_device { +u32 magic;struct platform_device pdev;struct omap_hwmod **hwmods;struct omap_device_pm_latency *pm_lats;
@@ -81,6 +82,7 @@ int omap_device_shutdown(struct platform_device *pdev);/* Core code interface */ +bool omap_device_is_valid (struct omap_device *od);int omap_device_count_resources (struct omap_device *od);int omap_device_fill_resources (struct omap_device *od,struct resource *res);
arch/arm/plat-omap/omap_device.c +16 -0
@@ -100,6 +100,8 @@# error Unknown OMAP device#endif +#define OMAP_DEVICE_MAGIC 0xf00dcafe +/* Private functions */ /**
@@ -413,6 +415,8 @@ struct omap_device *omap_device_build_ss(const char *pdev_name, int pdev_id, od->pm_lats = pm_lats; od->pm_lats_cnt = pm_lats_cnt; + od->magic =OMAP_DEVICE_MAGIC ; + ret =omap_device_register (od);if (ret) goto odbs_exit4;
@@ -599,6 +603,18 @@ int omap_device_align_pm_lat(struct platform_device *pdev, }/** +* omap_device_is_valid - Check if pointer is a valid omap_device +* @od: struct omap_device * +* +* Return whether struct omap_device pointer @od points to a valid +* omap_device. +*/ +bool omap_device_is_valid (struct omap_device *od) +{ +return (od && od->magic ==OMAP_DEVICE_MAGIC ); +} + +/** * omap_device_get_pwrdm - return the powerdomain * associated with @od * @od: struct omap_device * *
Signature · 1 line
1.6.6
Hi Kevin,
Quoted 17 lines · Kevin Hilman
Hmm, not sure I follow...
struct
omap_devicealready contains a structplatform_device, which in turn contains a struct device, so to get anomap_devicefrom a struct device, there are two container of operaions:to_platform_device()andto_omap_device()from
omap_device.h:struct omap_device { u32 magic; struct platform_device pdev; [...] }#define
to_omap_device(x)container_of((x), struct omap_device, pdev)
Quoted 8 lines
from
platform_device.h:struct platform_device { const char * name; int id; struct device dev; [...] }#define
to_platform_device(x)container_of((x), struct platform_device, dev)
Sorry - my E-mail was too hasty and unclear. What I had in mind was the lifecycle aspect of omap_device - i.e., ensuring that omap_devices are automatically freed by the device core, similar to the way that platform_device_alloc() does it.
- Paul