Commit | Line | Data |
---|---|---|
aa613de6 DB |
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 DB |
17 | #include <linux/platform_device.h> |
18 | ||
0848c94f MB |
19 | struct irq_domain; |
20 | ||
aa613de6 DB |
21 | /* |
22 | * This struct describes the MFD part ("cell"). | |
23 | * After registration the copy of this structure will become the platform data | |
24 | * of the resulting platform_device | |
25 | */ | |
26 | struct mfd_cell { | |
27 | const char *name; | |
3bed6e41 | 28 | int id; |
aa613de6 | 29 | |
1e29af62 AS |
30 | /* refcounting for multiple drivers to use a single cell */ |
31 | atomic_t *usage_count; | |
aa613de6 DB |
32 | int (*enable)(struct platform_device *dev); |
33 | int (*disable)(struct platform_device *dev); | |
1e29af62 | 34 | |
aa613de6 DB |
35 | int (*suspend)(struct platform_device *dev); |
36 | int (*resume)(struct platform_device *dev); | |
37 | ||
eb895607 SO |
38 | /* platform data passed to the sub devices drivers */ |
39 | void *platform_data; | |
40 | size_t pdata_size; | |
2968ab13 LJ |
41 | /* |
42 | * Device Tree compatible string | |
43 | * See: Documentation/devicetree/usage-model.txt Chapter 2.2 for details | |
44 | */ | |
c94bb233 | 45 | const char *of_compatible; |
eb895607 | 46 | |
aa613de6 | 47 | /* |
2798e226 AS |
48 | * These resources can be specified relative to the parent device. |
49 | * For accessing hardware you should use resources from the platform dev | |
aa613de6 DB |
50 | */ |
51 | int num_resources; | |
52 | const struct resource *resources; | |
5f2545fa DD |
53 | |
54 | /* don't check for resource conflicts */ | |
55 | bool ignore_resource_conflicts; | |
4c90aa94 MB |
56 | |
57 | /* | |
58 | * Disable runtime PM callbacks for this subdevice - see | |
59 | * pm_runtime_no_callbacks(). | |
60 | */ | |
61 | bool pm_runtime_no_callbacks; | |
aa613de6 DB |
62 | }; |
63 | ||
1e29af62 AS |
64 | /* |
65 | * Convenience functions for clients using shared cells. Refcounting | |
66 | * happens automatically, with the cell's enable/disable callbacks | |
67 | * being called only when a device is first being enabled or no other | |
68 | * clients are making use of it. | |
69 | */ | |
f77289ac AS |
70 | extern int mfd_cell_enable(struct platform_device *pdev); |
71 | extern int mfd_cell_disable(struct platform_device *pdev); | |
1e29af62 | 72 | |
fa1df691 AS |
73 | /* |
74 | * "Clone" multiple platform devices for a single cell. This is to be used | |
75 | * for devices that have multiple users of a cell. For example, if an mfd | |
76 | * driver wants the cell "foo" to be used by a GPIO driver, an MTD driver, | |
77 | * and a platform driver, the following bit of code would be use after first | |
78 | * calling mfd_add_devices(): | |
79 | * | |
80 | * const char *fclones[] = { "foo-gpio", "foo-mtd" }; | |
81 | * err = mfd_clone_cells("foo", fclones, ARRAY_SIZE(fclones)); | |
82 | * | |
83 | * Each driver (MTD, GPIO, and platform driver) would then register | |
84 | * platform_drivers for "foo-mtd", "foo-gpio", and "foo", respectively. | |
85 | * The cell's .enable/.disable hooks should be used to deal with hardware | |
86 | * resource contention. | |
87 | */ | |
88 | extern int mfd_clone_cell(const char *cell, const char **clones, | |
89 | size_t n_clones); | |
90 | ||
fe891a00 AS |
91 | /* |
92 | * Given a platform device that's been created by mfd_add_devices(), fetch | |
93 | * the mfd_cell that created it. | |
94 | */ | |
95 | static inline const struct mfd_cell *mfd_get_cell(struct platform_device *pdev) | |
96 | { | |
e710d7d5 | 97 | return pdev->mfd_cell; |
fe891a00 AS |
98 | } |
99 | ||
424f525a | 100 | extern int mfd_add_devices(struct device *parent, int id, |
1e29af62 | 101 | struct mfd_cell *cells, int n_devs, |
7f71ac93 | 102 | struct resource *mem_base, |
0848c94f | 103 | int irq_base, struct irq_domain *irq_domain); |
aa613de6 | 104 | |
424f525a | 105 | extern void mfd_remove_devices(struct device *parent); |
aa613de6 DB |
106 | |
107 | #endif |