summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorPhilippe Langlais <philippe.langlais@stericsson.com>2011-10-20 10:31:40 +0200
committerPhilippe Langlais <philippe.langlais@stericsson.com>2012-05-22 11:06:05 +0200
commita2ea60e5ec438a66518a02f1b91703b815ae1579 (patch)
treeefa97a58aaecf269b3676bd42fb355e8cedb2c00 /include
parenta2283e55fb118961b53483dd9bf411bf42386d13 (diff)
lsm303dlh: add DocBook documentation
Adding DocBook documentation for lsm303dlh accelerometer and magnetometer drivers. ST-Ericsson ID: 277198 Change-Id: Idfca43aa6ffaa39b7f73d0135dc6d2b01a0a44c6 Signed-off-by: Chethan Krishna N <chethan.krishna@stericsson.com> Reviewed-on: http://gerrit.lud.stericsson.com/gerrit/23784 Reviewed-by: Srinidhi KASAGAR <srinidhi.kasagar@stericsson.com> Conflicts: Documentation/DocBook/Makefile
Diffstat (limited to 'include')
-rw-r--r--include/linux/lsm303dlh.h45
1 files changed, 25 insertions, 20 deletions
diff --git a/include/linux/lsm303dlh.h b/include/linux/lsm303dlh.h
index d9fd6148198..ad369b1fbd5 100644
--- a/include/linux/lsm303dlh.h
+++ b/include/linux/lsm303dlh.h
@@ -29,27 +29,32 @@
#include <linux/ioctl.h>
#ifdef __KERNEL__
+/**
+ * struct lsm303dlh_platform_data - platform datastructure for lsm303dlh
+ * @name_a: accelerometer name
+ * @name_m: magnetometer name
+ * @irq_a1: interrupt line 1 of accelerometer
+ * @irq_a2: interrupt line 2 of accelerometer
+ * @irq_m: interrupt line of magnetometer
+ * @axis_map_x: x axis position on the hardware, 0 1 or 2
+ * @axis_map_y: y axis position on the hardware, 0 1 or 2
+ * @axis_map_z: z axis position on the hardware, 0 1 or 2
+ * @negative_x: x axis is orientation, 0 or 1
+ * @negative_y: y axis is orientation, 0 or 1
+ * @negative_z: z axis is orientation, 0 or 1
+ */
struct lsm303dlh_platform_data {
-
- /* name of device for regulator */
-
- const char *name_a; /* acelerometer name */
- const char *name_m; /* magnetometer name */
-
- /* interrupt data */
- u32 irq_a1; /* interrupt line 1 of accelrometer*/
- u32 irq_a2; /* interrupt line 2 of accelrometer*/
- u32 irq_m; /* interrupt line of magnetometer*/
-
- /* position of x,y and z axis */
- u8 axis_map_x; /* [0-2] */
- u8 axis_map_y; /* [0-2] */
- u8 axis_map_z; /* [0-2] */
-
- /* orientation of x,y and z axis */
- u8 negative_x; /* [0-1] */
- u8 negative_y; /* [0-1] */
- u8 negative_z; /* [0-1] */
+ const char *name_a;
+ const char *name_m;
+ u32 irq_a1;
+ u32 irq_a2;
+ u32 irq_m;
+ u8 axis_map_x;
+ u8 axis_map_y;
+ u8 axis_map_z;
+ u8 negative_x;
+ u8 negative_y;
+ u8 negative_z;
};
#endif /* __KERNEL__ */