blob: a76bc100bf974d667f64fec5dc4619297a8d71b7 [file] [log] [blame]
Dmitry Baryshkovaa613de2008-06-27 10:37:19 +01001/*
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
Ben Dooks7f71ac92008-07-28 18:29:09 +020014#ifndef MFD_CORE_H
15#define MFD_CORE_H
16
Dmitry Baryshkovaa613de2008-06-27 10:37:19 +010017#include <linux/platform_device.h>
18
Mark Brown0848c942012-09-11 15:16:36 +080019struct irq_domain;
20
Dmitry Baryshkovaa613de2008-06-27 10:37:19 +010021/*
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 */
26struct mfd_cell {
27 const char *name;
Mark Brown3bed6e42009-07-27 14:45:51 +010028 int id;
Dmitry Baryshkovaa613de2008-06-27 10:37:19 +010029
Andres Salomon1e29af62011-02-17 19:07:34 -080030 /* refcounting for multiple drivers to use a single cell */
31 atomic_t *usage_count;
Dmitry Baryshkovaa613de2008-06-27 10:37:19 +010032 int (*enable)(struct platform_device *dev);
33 int (*disable)(struct platform_device *dev);
Andres Salomon1e29af62011-02-17 19:07:34 -080034
Dmitry Baryshkovaa613de2008-06-27 10:37:19 +010035 int (*suspend)(struct platform_device *dev);
36 int (*resume)(struct platform_device *dev);
37
Samuel Ortizeb895602011-04-06 16:52:52 +020038 /* platform data passed to the sub devices drivers */
39 void *platform_data;
40 size_t pdata_size;
Lee Jones2968ab12012-07-02 10:50:19 +010041 /*
42 * Device Tree compatible string
43 * See: Documentation/devicetree/usage-model.txt Chapter 2.2 for details
44 */
Lee Jonesc94bb232012-06-29 19:01:03 +020045 const char *of_compatible;
Samuel Ortizeb895602011-04-06 16:52:52 +020046
Mika Westerberg6ab34302014-09-16 14:52:36 +030047 /* Matches ACPI PNP id, either _HID or _CID */
48 const char *acpi_pnpid;
49
Dmitry Baryshkovaa613de2008-06-27 10:37:19 +010050 /*
Andres Salomon2798e222011-02-17 19:07:08 -080051 * These resources can be specified relative to the parent device.
52 * For accessing hardware you should use resources from the platform dev
Dmitry Baryshkovaa613de2008-06-27 10:37:19 +010053 */
54 int num_resources;
55 const struct resource *resources;
Daniel Drake5f2545f2010-09-30 21:55:36 +010056
57 /* don't check for resource conflicts */
58 bool ignore_resource_conflicts;
Mark Brown4c90aa92010-11-26 17:19:34 +000059
60 /*
61 * Disable runtime PM callbacks for this subdevice - see
62 * pm_runtime_no_callbacks().
63 */
64 bool pm_runtime_no_callbacks;
Charles Keepax7fcd4272013-10-15 20:14:21 +010065
66 /* A list of regulator supplies that should be mapped to the MFD
67 * device rather than the child device when requested
68 */
Lee Jones9f8c0fe2014-05-23 16:44:10 +010069 const char * const *parent_supplies;
Charles Keepax7fcd4272013-10-15 20:14:21 +010070 int num_parent_supplies;
Dmitry Baryshkovaa613de2008-06-27 10:37:19 +010071};
72
Andres Salomonfe891a02011-02-17 19:07:09 -080073/*
Andres Salomon1e29af62011-02-17 19:07:34 -080074 * Convenience functions for clients using shared cells. Refcounting
75 * happens automatically, with the cell's enable/disable callbacks
76 * being called only when a device is first being enabled or no other
77 * clients are making use of it.
78 */
Andres Salomonf77289a2011-03-03 09:51:58 -080079extern int mfd_cell_enable(struct platform_device *pdev);
80extern int mfd_cell_disable(struct platform_device *pdev);
Andres Salomon1e29af62011-02-17 19:07:34 -080081
82/*
Andres Salomonfa1df692011-03-21 19:19:35 -070083 * "Clone" multiple platform devices for a single cell. This is to be used
84 * for devices that have multiple users of a cell. For example, if an mfd
85 * driver wants the cell "foo" to be used by a GPIO driver, an MTD driver,
86 * and a platform driver, the following bit of code would be use after first
87 * calling mfd_add_devices():
88 *
89 * const char *fclones[] = { "foo-gpio", "foo-mtd" };
90 * err = mfd_clone_cells("foo", fclones, ARRAY_SIZE(fclones));
91 *
92 * Each driver (MTD, GPIO, and platform driver) would then register
93 * platform_drivers for "foo-mtd", "foo-gpio", and "foo", respectively.
94 * The cell's .enable/.disable hooks should be used to deal with hardware
95 * resource contention.
96 */
97extern int mfd_clone_cell(const char *cell, const char **clones,
98 size_t n_clones);
99
100/*
Andres Salomonfe891a02011-02-17 19:07:09 -0800101 * Given a platform device that's been created by mfd_add_devices(), fetch
102 * the mfd_cell that created it.
103 */
104static inline const struct mfd_cell *mfd_get_cell(struct platform_device *pdev)
105{
Samuel Ortize710d7d2011-04-08 00:43:01 +0200106 return pdev->mfd_cell;
Andres Salomonfe891a02011-02-17 19:07:09 -0800107}
108
Dmitry Baryshkov424f5252008-07-29 01:30:26 +0200109extern int mfd_add_devices(struct device *parent, int id,
Geert Uytterhoeven03e361b2013-10-29 10:03:04 +0100110 const struct mfd_cell *cells, int n_devs,
Ben Dooks7f71ac92008-07-28 18:29:09 +0200111 struct resource *mem_base,
Mark Brown0848c942012-09-11 15:16:36 +0800112 int irq_base, struct irq_domain *irq_domain);
Dmitry Baryshkovaa613de2008-06-27 10:37:19 +0100113
Johan Hovolda7975472014-09-26 12:55:30 +0200114static inline int mfd_add_hotplug_devices(struct device *parent,
115 const struct mfd_cell *cells, int n_devs)
116{
117 return mfd_add_devices(parent, PLATFORM_DEVID_AUTO, cells, n_devs,
118 NULL, 0, NULL);
119}
120
Dmitry Baryshkov424f5252008-07-29 01:30:26 +0200121extern void mfd_remove_devices(struct device *parent);
Dmitry Baryshkovaa613de2008-06-27 10:37:19 +0100122
Dmitry Baryshkovaa613de2008-06-27 10:37:19 +0100123#endif