include/linux/mfd/core.h

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