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