core.h 2.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101
  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. #ifndef MFD_CORE_H
  14. #define MFD_CORE_H
  15. #include <linux/platform_device.h>
  16. /*
  17. * This struct describes the MFD part ("cell").
  18. * After registration the copy of this structure will become the platform data
  19. * of the resulting platform_device
  20. */
  21. struct mfd_cell {
  22. const char *name;
  23. int id;
  24. /* refcounting for multiple drivers to use a single cell */
  25. atomic_t *usage_count;
  26. int (*enable)(struct platform_device *dev);
  27. int (*disable)(struct platform_device *dev);
  28. int (*suspend)(struct platform_device *dev);
  29. int (*resume)(struct platform_device *dev);
  30. /* platform data passed to the sub devices drivers */
  31. void *platform_data;
  32. size_t pdata_size;
  33. /*
  34. * These resources can be specified relative to the parent device.
  35. * For accessing hardware you should use resources from the platform dev
  36. */
  37. int num_resources;
  38. const struct resource *resources;
  39. /* don't check for resource conflicts */
  40. bool ignore_resource_conflicts;
  41. /*
  42. * Disable runtime PM callbacks for this subdevice - see
  43. * pm_runtime_no_callbacks().
  44. */
  45. bool pm_runtime_no_callbacks;
  46. };
  47. /*
  48. * Convenience functions for clients using shared cells. Refcounting
  49. * happens automatically, with the cell's enable/disable callbacks
  50. * being called only when a device is first being enabled or no other
  51. * clients are making use of it.
  52. */
  53. extern int mfd_cell_enable(struct platform_device *pdev);
  54. extern int mfd_cell_disable(struct platform_device *pdev);
  55. /*
  56. * "Clone" multiple platform devices for a single cell. This is to be used
  57. * for devices that have multiple users of a cell. For example, if an mfd
  58. * driver wants the cell "foo" to be used by a GPIO driver, an MTD driver,
  59. * and a platform driver, the following bit of code would be use after first
  60. * calling mfd_add_devices():
  61. *
  62. * const char *fclones[] = { "foo-gpio", "foo-mtd" };
  63. * err = mfd_clone_cells("foo", fclones, ARRAY_SIZE(fclones));
  64. *
  65. * Each driver (MTD, GPIO, and platform driver) would then register
  66. * platform_drivers for "foo-mtd", "foo-gpio", and "foo", respectively.
  67. * The cell's .enable/.disable hooks should be used to deal with hardware
  68. * resource contention.
  69. */
  70. extern int mfd_clone_cell(const char *cell, const char **clones,
  71. size_t n_clones);
  72. /*
  73. * Given a platform device that's been created by mfd_add_devices(), fetch
  74. * the mfd_cell that created it.
  75. */
  76. static inline const struct mfd_cell *mfd_get_cell(struct platform_device *pdev)
  77. {
  78. return pdev->mfd_cell;
  79. }
  80. extern int mfd_add_devices(struct device *parent, int id,
  81. struct mfd_cell *cells, int n_devs,
  82. struct resource *mem_base,
  83. int irq_base);
  84. extern void mfd_remove_devices(struct device *parent);
  85. #endif