x86, docbook: Fix errors from x86 headers merger
[sfrench/cifs-2.6.git] / arch / arm / plat-s3c / include / plat / iic.h
1 /* arch/arm/plat-s3c/include/plat/iic.h
2  *
3  * Copyright 2004-2009 Simtec Electronics
4  *      Ben Dooks <ben@simtec.co.uk>
5  *
6  * S3C - I2C Controller platform_device info
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License version 2 as
10  * published by the Free Software Foundation.
11 */
12
13 #ifndef __ASM_ARCH_IIC_H
14 #define __ASM_ARCH_IIC_H __FILE__
15
16 #define S3C_IICFLG_FILTER       (1<<0)  /* enable s3c2440 filter */
17
18 /**
19  *      struct s3c2410_platform_i2c - Platform data for s3c I2C.
20  *      @bus_num: The bus number to use (if possible).
21  *      @flags: Any flags for the I2C bus (E.g. S3C_IICFLK_FILTER).
22  *      @slave_addr: The I2C address for the slave device (if enabled).
23  *      @frequency: The desired frequency in Hz of the bus.  This is
24  *                  guaranteed to not be exceeded.  If the caller does
25  *                  not care, use zero and the driver will select a
26  *                  useful default.
27  *      @sda_delay: The delay (in ns) applied to SDA edges.
28  *      @cfg_gpio: A callback to configure the pins for I2C operation.
29  */
30 struct s3c2410_platform_i2c {
31         int             bus_num;
32         unsigned int    flags;
33         unsigned int    slave_addr;
34         unsigned long   frequency;
35         unsigned int    sda_delay;
36
37         void    (*cfg_gpio)(struct platform_device *dev);
38 };
39
40 /**
41  * s3c_i2c0_set_platdata - set platform data for i2c0 device
42  * @i2c: The platform data to set, or NULL for default data.
43  *
44  * Register the given platform data for use with the i2c0 device. This
45  * call copies the platform data, so the caller can use __initdata for
46  * their copy.
47  *
48  * This call will set cfg_gpio if is null to the default platform
49  * implementation.
50  *
51  * Any user of s3c_device_i2c0 should call this, even if it is with
52  * NULL to ensure that the device is given the default platform data
53  * as the driver will no longer carry defaults.
54  */
55 extern void s3c_i2c0_set_platdata(struct s3c2410_platform_i2c *i2c);
56 extern void s3c_i2c1_set_platdata(struct s3c2410_platform_i2c *i2c);
57
58 /* defined by architecture to configure gpio */
59 extern void s3c_i2c0_cfg_gpio(struct platform_device *dev);
60 extern void s3c_i2c1_cfg_gpio(struct platform_device *dev);
61
62 #endif /* __ASM_ARCH_IIC_H */