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