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 19struct irq_domain; 20 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 */ 26struct mfd_cell { 27 const char *name; 28 int id; 29 30 /* refcounting for multiple drivers to use a single cell */ 31 atomic_t *usage_count; 32 int (*enable)(struct platform_device *dev); 33 int (*disable)(struct platform_device *dev); 34 35 int (*suspend)(struct platform_device *dev); 36 int (*resume)(struct platform_device *dev); 37 38 /* platform data passed to the sub devices drivers */ 39 void *platform_data; 40 size_t pdata_size; 41 /* 42 * Device Tree compatible string 43 * See: Documentation/devicetree/usage-model.txt Chapter 2.2 for details 44 */ 45 const char *of_compatible; 46 47 /* Matches ACPI PNP id, either _HID or _CID */ 48 const char *acpi_pnpid; 49 50 /* 51 * These resources can be specified relative to the parent device. 52 * For accessing hardware you should use resources from the platform dev 53 */ 54 int num_resources; 55 const struct resource *resources; 56 57 /* don't check for resource conflicts */ 58 bool ignore_resource_conflicts; 59 60 /* 61 * Disable runtime PM callbacks for this subdevice - see 62 * pm_runtime_no_callbacks(). 63 */ 64 bool pm_runtime_no_callbacks; 65 66 /* A list of regulator supplies that should be mapped to the MFD 67 * device rather than the child device when requested 68 */ 69 const char * const *parent_supplies; 70 int num_parent_supplies; 71}; 72 73/* 74 * 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 */ 79extern int mfd_cell_enable(struct platform_device *pdev); 80extern int mfd_cell_disable(struct platform_device *pdev); 81 82/* 83 * "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/* 101 * 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{ 106 return pdev->mfd_cell; 107} 108 109extern int mfd_add_devices(struct device *parent, int id, 110 const struct mfd_cell *cells, int n_devs, 111 struct resource *mem_base, 112 int irq_base, struct irq_domain *irq_domain); 113 114static 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 121extern void mfd_remove_devices(struct device *parent); 122 123#endif 124