pmu.h 7.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236
  1. /*
  2. * Definitions for talking to the PMU. The PMU is a microcontroller
  3. * which controls battery charging and system power on PowerBook 3400
  4. * and 2400 models as well as the RTC and various other things.
  5. *
  6. * Copyright (C) 1998 Paul Mackerras.
  7. */
  8. #define PMU_DRIVER_VERSION 2
  9. /*
  10. * PMU commands
  11. */
  12. #define PMU_POWER_CTRL0 0x10 /* control power of some devices */
  13. #define PMU_POWER_CTRL 0x11 /* control power of some devices */
  14. #define PMU_ADB_CMD 0x20 /* send ADB packet */
  15. #define PMU_ADB_POLL_OFF 0x21 /* disable ADB auto-poll */
  16. #define PMU_WRITE_NVRAM 0x33 /* write non-volatile RAM */
  17. #define PMU_READ_NVRAM 0x3b /* read non-volatile RAM */
  18. #define PMU_SET_RTC 0x30 /* set real-time clock */
  19. #define PMU_READ_RTC 0x38 /* read real-time clock */
  20. #define PMU_SET_VOLBUTTON 0x40 /* set volume up/down position */
  21. #define PMU_BACKLIGHT_BRIGHT 0x41 /* set backlight brightness */
  22. #define PMU_GET_VOLBUTTON 0x48 /* get volume up/down position */
  23. #define PMU_PCEJECT 0x4c /* eject PC-card from slot */
  24. #define PMU_BATTERY_STATE 0x6b /* report battery state etc. */
  25. #define PMU_SMART_BATTERY_STATE 0x6f /* report battery state (new way) */
  26. #define PMU_SET_INTR_MASK 0x70 /* set PMU interrupt mask */
  27. #define PMU_INT_ACK 0x78 /* read interrupt bits */
  28. #define PMU_SHUTDOWN 0x7e /* turn power off */
  29. #define PMU_CPU_SPEED 0x7d /* control CPU speed on some models */
  30. #define PMU_SLEEP 0x7f /* put CPU to sleep */
  31. #define PMU_POWER_EVENTS 0x8f /* Send power-event commands to PMU */
  32. #define PMU_I2C_CMD 0x9a /* I2C operations */
  33. #define PMU_RESET 0xd0 /* reset CPU */
  34. #define PMU_GET_BRIGHTBUTTON 0xd9 /* report brightness up/down pos */
  35. #define PMU_GET_COVER 0xdc /* report cover open/closed */
  36. #define PMU_SYSTEM_READY 0xdf /* tell PMU we are awake */
  37. #define PMU_GET_VERSION 0xea /* read the PMU version */
  38. /* Bits to use with the PMU_POWER_CTRL0 command */
  39. #define PMU_POW0_ON 0x80 /* OR this to power ON the device */
  40. #define PMU_POW0_OFF 0x00 /* leave bit 7 to 0 to power it OFF */
  41. #define PMU_POW0_HARD_DRIVE 0x04 /* Hard drive power (on wallstreet/lombard ?) */
  42. /* Bits to use with the PMU_POWER_CTRL command */
  43. #define PMU_POW_ON 0x80 /* OR this to power ON the device */
  44. #define PMU_POW_OFF 0x00 /* leave bit 7 to 0 to power it OFF */
  45. #define PMU_POW_BACKLIGHT 0x01 /* backlight power */
  46. #define PMU_POW_CHARGER 0x02 /* battery charger power */
  47. #define PMU_POW_IRLED 0x04 /* IR led power (on wallstreet) */
  48. #define PMU_POW_MEDIABAY 0x08 /* media bay power (wallstreet/lombard ?) */
  49. /* Bits in PMU interrupt and interrupt mask bytes */
  50. #define PMU_INT_PCEJECT 0x04 /* PC-card eject buttons */
  51. #define PMU_INT_SNDBRT 0x08 /* sound/brightness up/down buttons */
  52. #define PMU_INT_ADB 0x10 /* ADB autopoll or reply data */
  53. #define PMU_INT_BATTERY 0x20 /* Battery state change */
  54. #define PMU_INT_ENVIRONMENT 0x40 /* Environment interrupts */
  55. #define PMU_INT_TICK 0x80 /* 1-second tick interrupt */
  56. /* Other bits in PMU interrupt valid when PMU_INT_ADB is set */
  57. #define PMU_INT_ADB_AUTO 0x04 /* ADB autopoll, when PMU_INT_ADB */
  58. #define PMU_INT_WAITING_CHARGER 0x01 /* ??? */
  59. #define PMU_INT_AUTO_SRQ_POLL 0x02 /* ??? */
  60. /* Bits in the environement message (either obtained via PMU_GET_COVER,
  61. * or via PMU_INT_ENVIRONMENT on core99 */
  62. #define PMU_ENV_LID_CLOSED 0x01 /* The lid is closed */
  63. /* I2C related definitions */
  64. #define PMU_I2C_MODE_SIMPLE 0
  65. #define PMU_I2C_MODE_STDSUB 1
  66. #define PMU_I2C_MODE_COMBINED 2
  67. #define PMU_I2C_BUS_STATUS 0
  68. #define PMU_I2C_BUS_SYSCLK 1
  69. #define PMU_I2C_BUS_POWER 2
  70. #define PMU_I2C_STATUS_OK 0
  71. #define PMU_I2C_STATUS_DATAREAD 1
  72. #define PMU_I2C_STATUS_BUSY 0xfe
  73. /* Kind of PMU (model) */
  74. enum {
  75. PMU_UNKNOWN,
  76. PMU_OHARE_BASED, /* 2400, 3400, 3500 (old G3 powerbook) */
  77. PMU_HEATHROW_BASED, /* PowerBook G3 series */
  78. PMU_PADDINGTON_BASED, /* 1999 PowerBook G3 */
  79. PMU_KEYLARGO_BASED, /* Core99 motherboard (PMU99) */
  80. PMU_68K_V1, /* 68K PMU, version 1 */
  81. PMU_68K_V2, /* 68K PMU, version 2 */
  82. };
  83. /* PMU PMU_POWER_EVENTS commands */
  84. enum {
  85. PMU_PWR_GET_POWERUP_EVENTS = 0x00,
  86. PMU_PWR_SET_POWERUP_EVENTS = 0x01,
  87. PMU_PWR_CLR_POWERUP_EVENTS = 0x02,
  88. PMU_PWR_GET_WAKEUP_EVENTS = 0x03,
  89. PMU_PWR_SET_WAKEUP_EVENTS = 0x04,
  90. PMU_PWR_CLR_WAKEUP_EVENTS = 0x05,
  91. };
  92. /* Power events wakeup bits */
  93. enum {
  94. PMU_PWR_WAKEUP_KEY = 0x01, /* Wake on key press */
  95. PMU_PWR_WAKEUP_AC_INSERT = 0x02, /* Wake on AC adapter plug */
  96. PMU_PWR_WAKEUP_AC_CHANGE = 0x04,
  97. PMU_PWR_WAKEUP_LID_OPEN = 0x08,
  98. PMU_PWR_WAKEUP_RING = 0x10,
  99. };
  100. /*
  101. * Ioctl commands for the /dev/pmu device
  102. */
  103. #include <linux/ioctl.h>
  104. /* no param */
  105. #define PMU_IOC_SLEEP _IO('B', 0)
  106. /* out param: u32* backlight value: 0 to 15 */
  107. #define PMU_IOC_GET_BACKLIGHT _IOR('B', 1, size_t)
  108. /* in param: u32 backlight value: 0 to 15 */
  109. #define PMU_IOC_SET_BACKLIGHT _IOW('B', 2, size_t)
  110. /* out param: u32* PMU model */
  111. #define PMU_IOC_GET_MODEL _IOR('B', 3, size_t)
  112. /* out param: u32* has_adb: 0 or 1 */
  113. #define PMU_IOC_HAS_ADB _IOR('B', 4, size_t)
  114. /* out param: u32* can_sleep: 0 or 1 */
  115. #define PMU_IOC_CAN_SLEEP _IOR('B', 5, size_t)
  116. /* no param, but historically was _IOR('B', 6, 0), meaning 4 bytes */
  117. #define PMU_IOC_GRAB_BACKLIGHT _IOR('B', 6, size_t)
  118. #ifdef __KERNEL__
  119. extern int find_via_pmu(void);
  120. extern int pmu_request(struct adb_request *req,
  121. void (*done)(struct adb_request *), int nbytes, ...);
  122. extern int pmu_queue_request(struct adb_request *req);
  123. extern void pmu_poll(void);
  124. extern void pmu_poll_adb(void); /* For use by xmon */
  125. extern void pmu_wait_complete(struct adb_request *req);
  126. /* For use before switching interrupts off for a long time;
  127. * warning: not stackable
  128. */
  129. extern void pmu_suspend(void);
  130. extern void pmu_resume(void);
  131. extern void pmu_enable_irled(int on);
  132. extern void pmu_restart(void);
  133. extern void pmu_shutdown(void);
  134. extern void pmu_unlock(void);
  135. extern int pmu_present(void);
  136. extern int pmu_get_model(void);
  137. #ifdef CONFIG_PM
  138. /*
  139. * Stuff for putting the powerbook to sleep and waking it again.
  140. *
  141. */
  142. #include <linux/list.h>
  143. struct pmu_sleep_notifier
  144. {
  145. int (*notifier_call)(struct pmu_sleep_notifier *self, int when);
  146. int priority;
  147. struct list_head list;
  148. };
  149. /* Code values for calling sleep/wakeup handlers
  150. *
  151. * Note: If a sleep request got cancelled, all drivers will get
  152. * the PBOOK_SLEEP_REJECT, even those who didn't get the PBOOK_SLEEP_REQUEST.
  153. */
  154. #define PBOOK_SLEEP_REQUEST 1
  155. #define PBOOK_SLEEP_NOW 2
  156. #define PBOOK_SLEEP_REJECT 3
  157. #define PBOOK_WAKE 4
  158. /* Result codes returned by the notifiers */
  159. #define PBOOK_SLEEP_OK 0
  160. #define PBOOK_SLEEP_REFUSE -1
  161. /* priority levels in notifiers */
  162. #define SLEEP_LEVEL_VIDEO 100 /* Video driver (first wake) */
  163. #define SLEEP_LEVEL_MEDIABAY 90 /* Media bay driver */
  164. #define SLEEP_LEVEL_BLOCK 80 /* IDE, SCSI */
  165. #define SLEEP_LEVEL_NET 70 /* bmac, gmac */
  166. #define SLEEP_LEVEL_MISC 60 /* Anything else */
  167. #define SLEEP_LEVEL_USERLAND 55 /* Reserved for apm_emu */
  168. #define SLEEP_LEVEL_ADB 50 /* ADB (async) */
  169. #define SLEEP_LEVEL_SOUND 40 /* Sound driver (blocking) */
  170. /* special register notifier functions */
  171. int pmu_register_sleep_notifier(struct pmu_sleep_notifier* notifier);
  172. int pmu_unregister_sleep_notifier(struct pmu_sleep_notifier* notifier);
  173. #endif /* CONFIG_PM */
  174. #define PMU_MAX_BATTERIES 2
  175. /* values for pmu_power_flags */
  176. #define PMU_PWR_AC_PRESENT 0x00000001
  177. /* values for pmu_battery_info.flags */
  178. #define PMU_BATT_PRESENT 0x00000001
  179. #define PMU_BATT_CHARGING 0x00000002
  180. #define PMU_BATT_TYPE_MASK 0x000000f0
  181. #define PMU_BATT_TYPE_SMART 0x00000010 /* Smart battery */
  182. #define PMU_BATT_TYPE_HOOPER 0x00000020 /* 3400/3500 */
  183. #define PMU_BATT_TYPE_COMET 0x00000030 /* 2400 */
  184. struct pmu_battery_info
  185. {
  186. unsigned int flags;
  187. unsigned int charge; /* current charge */
  188. unsigned int max_charge; /* maximum charge */
  189. signed int amperage; /* current, positive if charging */
  190. unsigned int voltage; /* voltage */
  191. unsigned int time_remaining; /* remaining time */
  192. };
  193. extern int pmu_battery_count;
  194. extern struct pmu_battery_info pmu_batteries[PMU_MAX_BATTERIES];
  195. extern unsigned int pmu_power_flags;
  196. /* Backlight */
  197. extern void pmu_backlight_init(void);
  198. #endif /* __KERNEL__ */