]>
Commit | Line | Data |
---|---|---|
aa613de6 DES |
1 | /* |
2 | * drivers/mfd/mfd-core.h | |
3 | * | |
4 | * core MFD support | |
5 | * Copyright (c) 2006 Ian Molton | |
6 | * Copyright (c) 2007 Dmitry Baryshkov | |
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 | ||
7f71ac93 BD |
14 | #ifndef MFD_CORE_H |
15 | #define MFD_CORE_H | |
16 | ||
aa613de6 DES |
17 | #include <linux/platform_device.h> |
18 | ||
0848c94f | 19 | struct irq_domain; |
f4d05266 | 20 | struct property_entry; |
0848c94f | 21 | |
98a3be44 AS |
22 | /* Matches ACPI PNP id, either _HID or _CID, or ACPI _ADR */ |
23 | struct mfd_cell_acpi_match { | |
24 | const char *pnpid; | |
25 | const unsigned long long adr; | |
26 | }; | |
27 | ||
aa613de6 DES |
28 | /* |
29 | * This struct describes the MFD part ("cell"). | |
30 | * After registration the copy of this structure will become the platform data | |
31 | * of the resulting platform_device | |
32 | */ | |
33 | struct mfd_cell { | |
34 | const char *name; | |
3bed6e41 | 35 | int id; |
aa613de6 | 36 | |
1e29af62 AS |
37 | /* refcounting for multiple drivers to use a single cell */ |
38 | atomic_t *usage_count; | |
aa613de6 DES |
39 | int (*enable)(struct platform_device *dev); |
40 | int (*disable)(struct platform_device *dev); | |
1e29af62 | 41 | |
aa613de6 DES |
42 | int (*suspend)(struct platform_device *dev); |
43 | int (*resume)(struct platform_device *dev); | |
44 | ||
eb895607 SO |
45 | /* platform data passed to the sub devices drivers */ |
46 | void *platform_data; | |
47 | size_t pdata_size; | |
4d215cab AS |
48 | |
49 | /* device properties passed to the sub devices drivers */ | |
f4d05266 | 50 | struct property_entry *properties; |
4d215cab | 51 | |
2968ab13 LJ |
52 | /* |
53 | * Device Tree compatible string | |
54 | * See: Documentation/devicetree/usage-model.txt Chapter 2.2 for details | |
55 | */ | |
c94bb233 | 56 | const char *of_compatible; |
eb895607 | 57 | |
98a3be44 AS |
58 | /* Matches ACPI */ |
59 | const struct mfd_cell_acpi_match *acpi_match; | |
6ab34301 | 60 | |
aa613de6 | 61 | /* |
2798e226 AS |
62 | * These resources can be specified relative to the parent device. |
63 | * For accessing hardware you should use resources from the platform dev | |
aa613de6 DES |
64 | */ |
65 | int num_resources; | |
66 | const struct resource *resources; | |
5f2545fa DD |
67 | |
68 | /* don't check for resource conflicts */ | |
69 | bool ignore_resource_conflicts; | |
4c90aa94 MB |
70 | |
71 | /* | |
72 | * Disable runtime PM callbacks for this subdevice - see | |
73 | * pm_runtime_no_callbacks(). | |
74 | */ | |
75 | bool pm_runtime_no_callbacks; | |
7fcd4274 CK |
76 | |
77 | /* A list of regulator supplies that should be mapped to the MFD | |
78 | * device rather than the child device when requested | |
79 | */ | |
9f8c0fe9 | 80 | const char * const *parent_supplies; |
7fcd4274 | 81 | int num_parent_supplies; |
aa613de6 DES |
82 | }; |
83 | ||
1e29af62 AS |
84 | /* |
85 | * Convenience functions for clients using shared cells. Refcounting | |
86 | * happens automatically, with the cell's enable/disable callbacks | |
87 | * being called only when a device is first being enabled or no other | |
88 | * clients are making use of it. | |
89 | */ | |
f77289ac AS |
90 | extern int mfd_cell_enable(struct platform_device *pdev); |
91 | extern int mfd_cell_disable(struct platform_device *pdev); | |
1e29af62 | 92 | |
fa1df691 AS |
93 | /* |
94 | * "Clone" multiple platform devices for a single cell. This is to be used | |
95 | * for devices that have multiple users of a cell. For example, if an mfd | |
96 | * driver wants the cell "foo" to be used by a GPIO driver, an MTD driver, | |
97 | * and a platform driver, the following bit of code would be use after first | |
98 | * calling mfd_add_devices(): | |
99 | * | |
100 | * const char *fclones[] = { "foo-gpio", "foo-mtd" }; | |
101 | * err = mfd_clone_cells("foo", fclones, ARRAY_SIZE(fclones)); | |
102 | * | |
103 | * Each driver (MTD, GPIO, and platform driver) would then register | |
104 | * platform_drivers for "foo-mtd", "foo-gpio", and "foo", respectively. | |
105 | * The cell's .enable/.disable hooks should be used to deal with hardware | |
106 | * resource contention. | |
107 | */ | |
108 | extern int mfd_clone_cell(const char *cell, const char **clones, | |
109 | size_t n_clones); | |
110 | ||
fe891a00 AS |
111 | /* |
112 | * Given a platform device that's been created by mfd_add_devices(), fetch | |
113 | * the mfd_cell that created it. | |
114 | */ | |
115 | static inline const struct mfd_cell *mfd_get_cell(struct platform_device *pdev) | |
116 | { | |
e710d7d5 | 117 | return pdev->mfd_cell; |
fe891a00 AS |
118 | } |
119 | ||
424f525a | 120 | extern int mfd_add_devices(struct device *parent, int id, |
03e361b2 | 121 | const struct mfd_cell *cells, int n_devs, |
7f71ac93 | 122 | struct resource *mem_base, |
0848c94f | 123 | int irq_base, struct irq_domain *irq_domain); |
aa613de6 | 124 | |
a7975473 JH |
125 | static inline int mfd_add_hotplug_devices(struct device *parent, |
126 | const struct mfd_cell *cells, int n_devs) | |
127 | { | |
128 | return mfd_add_devices(parent, PLATFORM_DEVID_AUTO, cells, n_devs, | |
129 | NULL, 0, NULL); | |
130 | } | |
131 | ||
424f525a | 132 | extern void mfd_remove_devices(struct device *parent); |
aa613de6 | 133 | |
a8f447be LD |
134 | extern int devm_mfd_add_devices(struct device *dev, int id, |
135 | const struct mfd_cell *cells, int n_devs, | |
136 | struct resource *mem_base, | |
137 | int irq_base, struct irq_domain *irq_domain); | |
aa613de6 | 138 | #endif |