extcon.h 2.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  1. /* SPDX-License-Identifier: GPL-2.0 */
  2. #ifndef __LINUX_EXTCON_INTERNAL_H__
  3. #define __LINUX_EXTCON_INTERNAL_H__
  4. #include <linux/extcon-provider.h>
  5. /**
  6. * struct extcon_dev - An extcon device represents one external connector.
  7. * @name: The name of this extcon device. Parent device name is
  8. * used if NULL.
  9. * @supported_cable: Array of supported cable names ending with EXTCON_NONE.
  10. * If supported_cable is NULL, cable name related APIs
  11. * are disabled.
  12. * @mutually_exclusive: Array of mutually exclusive set of cables that cannot
  13. * be attached simultaneously. The array should be
  14. * ending with NULL or be NULL (no mutually exclusive
  15. * cables). For example, if it is { 0x7, 0x30, 0}, then,
  16. * {0, 1}, {0, 1, 2}, {0, 2}, {1, 2}, or {4, 5} cannot
  17. * be attached simulataneously. {0x7, 0} is equivalent to
  18. * {0x3, 0x6, 0x5, 0}. If it is {0xFFFFFFFF, 0}, there
  19. * can be no simultaneous connections.
  20. * @dev: Device of this extcon.
  21. * @state: Attach/detach state of this extcon. Do not provide at
  22. * register-time.
  23. * @nh_all: Notifier for the state change events for all supported
  24. * external connectors from this extcon.
  25. * @nh: Notifier for the state change events from this extcon
  26. * @entry: To support list of extcon devices so that users can
  27. * search for extcon devices based on the extcon name.
  28. * @lock:
  29. * @max_supported: Internal value to store the number of cables.
  30. * @extcon_dev_type: Device_type struct to provide attribute_groups
  31. * customized for each extcon device.
  32. * @cables: Sysfs subdirectories. Each represents one cable.
  33. *
  34. * In most cases, users only need to provide "User initializing data" of
  35. * this struct when registering an extcon. In some exceptional cases,
  36. * optional callbacks may be needed. However, the values in "internal data"
  37. * are overwritten by register function.
  38. */
  39. struct extcon_dev {
  40. /* Optional user initializing data */
  41. const char *name;
  42. const unsigned int *supported_cable;
  43. const u32 *mutually_exclusive;
  44. /* Internal data. Please do not set. */
  45. struct device dev;
  46. struct raw_notifier_head nh_all;
  47. struct raw_notifier_head *nh;
  48. struct list_head entry;
  49. int max_supported;
  50. spinlock_t lock; /* could be called by irq handler */
  51. u32 state;
  52. /* /sys/class/extcon/.../cable.n/... */
  53. struct device_type extcon_dev_type;
  54. struct extcon_cable *cables;
  55. /* /sys/class/extcon/.../mutually_exclusive/... */
  56. struct attribute_group attr_g_muex;
  57. struct attribute **attrs_muex;
  58. struct device_attribute *d_attrs_muex;
  59. };
  60. #endif /* __LINUX_EXTCON_INTERNAL_H__ */