tpec.c 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526
  1. /* ThinkPad embedded-controller sensors and power sources (see tpec.h).
  2. *
  3. * The X201 (i5 M 520, Arrandale) has no IT87xx Super I/O like the
  4. * AT3IONT-I. Its board temperatures, fan tachometer, battery and AC state
  5. * live behind the ACPI embedded controller, which Linux's thinkpad_acpi
  6. * reads through the same ports: command/status 0x66, data 0x62. The EC
  7. * protocol is simple enough to drive directly:
  8. *
  9. * write 0x80 (read) to 0x66, then the register index to 0x62,
  10. * wait for OBF (0x01) and read the byte back from 0x62.
  11. *
  12. * The SMBIOS type 1 entry gates the probe to Lenovo/IBM machines, so the
  13. * EC ports are never touched on the ASUS board, QEMU or other hardware.
  14. *
  15. * Two details matter on real hardware:
  16. * - There is no SCI handler, so hotkey events queue up in the output buffer.
  17. * A pending byte is drained before every command; otherwise the EC would
  18. * never replace it with the register we asked for.
  19. * - Firmware keeps running in legacy/SMM mode (we have no ACPI interpreter),
  20. * so an SMI can access the EC between our port accesses. The status
  21. * handshake plus bounded polling keeps that to an occasional bad sample.
  22. * Temperature/fan reads are read-only; the battery reader writes only the
  23. * H8 information-page selector at 0x81 and restores it afterwards.
  24. *
  25. * EC register map (thinkpad_acpi/H8): 0x78..0x7F and 0xC0..0xC7 temperatures
  26. * (0x80 = sensor not present, 0x00 = register not implemented), 0x84/0x85
  27. * fan tachometer LSB/MSB and 0x2F fan control (bit 7 automatic, bit 6
  28. * disengaged/full speed, bits 2:0 level). EC 0xEF is the functional
  29. * revision: revision 3 and later only implement the 0x78..0x7F sensors.
  30. *
  31. * Battery/AC: 0x38/0x39 are the battery 0/1 status bytes (bit 7 present,
  32. * bit 6 discharging, bit 5 charging) and 0x46 bit 4 is the AC-adapter
  33. * state. Battery data is a 16-byte window at 0xA0..0xAF selected by 0x81:
  34. * the high nibble is the battery (0x00/0x10), the low nibble the page
  35. * (0 dynamic, 1 mode, 2 static design data, 5 manufacturer, 6 model).
  36. */
  37. #include "tpec.h"
  38. #include "ec.h"
  39. #include "paging.h"
  40. #include "serial.h"
  41. #define TP_FAN_LEVEL 0x2F
  42. #define TP_FAN_LSB 0x84
  43. #define TP_FAN_MSB 0x85
  44. #define TP_TEMP_LO 0x78 /* temp_c[0..7] */
  45. #define TP_TEMP_HI 0xC0 /* temp_c[8..15] */
  46. #define TP_EC_REV 0xEF /* EC functional revision */
  47. #define TP_BAT0_STATUS 0x38 /* bit 7 present, 6 discharging, 5 charging */
  48. #define TP_BAT1_STATUS 0x39
  49. #define TP_AC_STATUS 0x46 /* bit 4: AC adapter online */
  50. #define TP_BAT_PAGE 0x81 /* information-page selector */
  51. #define TP_BAT_DATA 0xA0 /* 16-byte selected page */
  52. #define TP_BAT_PAGE_DYNAMIC 0
  53. #define TP_BAT_PAGE_MODE 1
  54. #define TP_BAT_PAGE_STATIC 2
  55. #define TP_BAT_PAGE_MFR 5
  56. #define TP_BAT_PAGE_MODEL 6
  57. #define TP_BAT_REMAINING 0x00
  58. #define TP_BAT_FULL 0x02
  59. #define TP_BAT_RSOC 0x06
  60. #define TP_BAT_RATE 0x08
  61. #define TP_BAT_VOLTAGE 0x0A
  62. static int tpec_state = -1; /* -1 unprobed, 0 absent, 1 present */
  63. static unsigned int tpec_ec_rev;
  64. static char tpec_vendor[16];
  65. static char tpec_product[32];
  66. static char tpec_version[32];
  67. static unsigned int rd32(const unsigned char *p)
  68. {
  69. return (unsigned int)p[0] | ((unsigned int)p[1] << 8) |
  70. ((unsigned int)p[2] << 16) | ((unsigned int)p[3] << 24);
  71. }
  72. static void copy_trim(char *dst, unsigned int size, const unsigned char *src)
  73. {
  74. unsigned int i = 0;
  75. while (i + 1 < size && src && src[i]) {
  76. dst[i] = (char)src[i];
  77. i++;
  78. }
  79. while (i && dst[i - 1] == ' ')
  80. i--;
  81. dst[i] = '\0';
  82. }
  83. /* Map every 4 MB page touched by [addr, addr+len); SMBIOS tables can sit
  84. * above the 128 MB identity map on larger machines (same approach as
  85. * acpi.c). */
  86. static void map_range(unsigned int addr, unsigned int len)
  87. {
  88. unsigned int p = addr & 0xFFC00000u;
  89. unsigned int last = (addr + len - 1u) & 0xFFC00000u;
  90. for (;;) {
  91. paging_map_ram(p, 0x400000u);
  92. if (p >= last || p > 0xFFC00000u - 0x400000u)
  93. break;
  94. p += 0x400000u;
  95. }
  96. }
  97. /* The n-th (1-based) string that follows a formatted SMBIOS structure. */
  98. static const unsigned char *smbios_string(const unsigned char *p,
  99. const unsigned char *end,
  100. unsigned int index)
  101. {
  102. unsigned int n = 1;
  103. if (!index)
  104. return 0;
  105. while (p < end && *p) {
  106. const unsigned char *s = p;
  107. if (n == index)
  108. return s;
  109. while (p < end && *p)
  110. p++;
  111. p++;
  112. n++;
  113. }
  114. return 0;
  115. }
  116. static int smbios_type1(char vendor[16], char product[32], char version[32])
  117. {
  118. const unsigned char *ep = 0;
  119. const unsigned char *table, *end, *p;
  120. unsigned int addr, table_addr, table_len, i;
  121. for (addr = 0xF0000; addr < 0x100000; addr += 16) {
  122. const unsigned char *q = (const unsigned char *)addr;
  123. unsigned char sum = 0;
  124. unsigned int len;
  125. if (q[0] != '_' || q[1] != 'S' || q[2] != 'M' || q[3] != '_')
  126. continue;
  127. len = q[5];
  128. if (len < 0x1F || len > 0x40)
  129. continue;
  130. for (i = 0; i < len; i++)
  131. sum = (unsigned char)(sum + q[i]);
  132. if (sum)
  133. continue;
  134. if (q[0x10] != '_' || q[0x11] != 'D' || q[0x12] != 'M' ||
  135. q[0x13] != 'I' || q[0x14] != '_')
  136. continue;
  137. ep = q;
  138. break;
  139. }
  140. if (!ep)
  141. return -1;
  142. table_len = (unsigned int)ep[0x16] | ((unsigned int)ep[0x17] << 8);
  143. table_addr = rd32(ep + 0x18);
  144. if (table_addr < 0x1000 || table_addr >= 0xFF000000u ||
  145. table_len < 4 || table_len > 0x10000u ||
  146. table_addr + table_len < table_addr)
  147. return -1;
  148. map_range(table_addr, table_len);
  149. table = (const unsigned char *)table_addr;
  150. end = table + table_len;
  151. for (p = table; p + 4 <= end; ) {
  152. unsigned char type = p[0];
  153. unsigned int len = p[1];
  154. const unsigned char *strs, *next;
  155. if (len < 4)
  156. break;
  157. if (type == 127) /* end-of-table */
  158. break;
  159. strs = p + len;
  160. if (strs > end)
  161. break;
  162. if (type == 1) {
  163. if (len >= 8) {
  164. copy_trim(vendor, 16,
  165. smbios_string(strs, end, p[4]));
  166. copy_trim(product, 32,
  167. smbios_string(strs, end, p[5]));
  168. copy_trim(version, 32,
  169. smbios_string(strs, end, p[6]));
  170. return 0;
  171. }
  172. break;
  173. }
  174. next = strs;
  175. while (next + 1 < end && !(next[0] == 0 && next[1] == 0))
  176. next++;
  177. next += 2;
  178. if (next > end)
  179. break;
  180. p = next;
  181. }
  182. return -1;
  183. }
  184. /* Select an H8 battery information page. Only writes 0x81 when the page
  185. * already differs; *dirty remembers that the original page must be restored. */
  186. static int ec_battery_page(unsigned int battery, unsigned int page, int *dirty)
  187. {
  188. unsigned char cur;
  189. unsigned char want = (unsigned char)((battery << 4) | page);
  190. if (ec_read(TP_BAT_PAGE, &cur) == 0 && cur == want)
  191. return 0;
  192. if (ec_write(TP_BAT_PAGE, want) != 0)
  193. return -1;
  194. *dirty = 1;
  195. return 0;
  196. }
  197. static void ec_read_string(char *dst, unsigned int size, unsigned char reg)
  198. {
  199. unsigned int i = 0;
  200. while (i + 1 < size) {
  201. unsigned char b;
  202. if (ec_read((unsigned char)(reg + i), &b) != 0)
  203. break;
  204. if (b == 0x00 || b == 0xFF)
  205. break;
  206. dst[i++] = (char)b;
  207. }
  208. while (i && dst[i - 1] == ' ')
  209. i--;
  210. dst[i] = '\0';
  211. }
  212. static int str_eq(const char *a, const char *b)
  213. {
  214. while (*a && *a == *b) {
  215. a++;
  216. b++;
  217. }
  218. return *a == *b;
  219. }
  220. static void log_info(void)
  221. {
  222. serial_puts(SERIAL_COM1, "tpec: ");
  223. if (tpec_vendor[0]) {
  224. serial_puts(SERIAL_COM1, tpec_vendor);
  225. serial_puts(SERIAL_COM1, " ");
  226. }
  227. if (tpec_product[0]) {
  228. serial_puts(SERIAL_COM1, tpec_product);
  229. serial_puts(SERIAL_COM1, " ");
  230. }
  231. if (tpec_version[0])
  232. serial_puts(SERIAL_COM1, tpec_version);
  233. }
  234. void tpec_init(void)
  235. {
  236. char vendor[16], product[32], version[32];
  237. unsigned char probe, rev;
  238. tpec_state = 0;
  239. tpec_vendor[0] = '\0';
  240. tpec_product[0] = '\0';
  241. tpec_version[0] = '\0';
  242. if (smbios_type1(vendor, product, version) != 0) {
  243. serial_puts(SERIAL_COM1, "tpec: no SMBIOS type 1, disabled\n");
  244. return;
  245. }
  246. copy_trim(tpec_vendor, sizeof(tpec_vendor), (const unsigned char *)vendor);
  247. copy_trim(tpec_product, sizeof(tpec_product),
  248. (const unsigned char *)product);
  249. copy_trim(tpec_version, sizeof(tpec_version),
  250. (const unsigned char *)version);
  251. if (!str_eq(vendor, "LENOVO") && !str_eq(vendor, "IBM")) {
  252. log_info();
  253. serial_puts(SERIAL_COM1, ": not a ThinkPad vendor, no EC probe\n");
  254. return;
  255. }
  256. if (ec_read(TP_FAN_LEVEL, &probe) != 0) {
  257. log_info();
  258. serial_puts(SERIAL_COM1, ": EC not responding\n");
  259. return;
  260. }
  261. if (ec_read(TP_EC_REV, &rev) == 0)
  262. tpec_ec_rev = rev;
  263. tpec_state = 1;
  264. log_info();
  265. serial_puts(SERIAL_COM1, ": EC ok, fw rev ");
  266. serial_putdec(SERIAL_COM1, tpec_ec_rev);
  267. serial_puts(SERIAL_COM1, ", fan level ");
  268. serial_puthex(SERIAL_COM1, probe);
  269. serial_puts(SERIAL_COM1, "\n");
  270. }
  271. int tpec_present(void)
  272. {
  273. if (tpec_state < 0)
  274. tpec_init();
  275. return tpec_state > 0;
  276. }
  277. void tpec_read(struct tpec_info *out)
  278. {
  279. unsigned char b;
  280. unsigned int i;
  281. out->present = 0;
  282. out->vendor[0] = '\0';
  283. out->product[0] = '\0';
  284. out->version[0] = '\0';
  285. for (i = 0; i < TPEC_TEMP_COUNT; i++)
  286. out->temp_c[i] = -128;
  287. out->fan_rpm = 0;
  288. out->fan_level = 0;
  289. if (tpec_state < 0)
  290. tpec_init();
  291. if (!tpec_state)
  292. return;
  293. out->present = 1;
  294. for (i = 0; i < sizeof(out->vendor) - 1 && tpec_vendor[i]; i++)
  295. out->vendor[i] = tpec_vendor[i];
  296. out->vendor[i] = '\0';
  297. for (i = 0; i < sizeof(out->product) - 1 && tpec_product[i]; i++)
  298. out->product[i] = tpec_product[i];
  299. out->product[i] = '\0';
  300. for (i = 0; i < sizeof(out->version) - 1 && tpec_version[i]; i++)
  301. out->version[i] = tpec_version[i];
  302. out->version[i] = '\0';
  303. for (i = 0; i < 8; i++) {
  304. if (ec_read((unsigned char)(TP_TEMP_LO + i), &b) != 0)
  305. continue;
  306. /* 0x80 = sensor present but unavailable, 0x00 = register not
  307. * implemented (thinkpad_acpi treats a block of zeros as an EC
  308. * that does not expose the register map at all). */
  309. if (b != 0x80 && b != 0x00)
  310. out->temp_c[i] = (signed char)b;
  311. }
  312. /* EC functional revision 3 and later only uses 0x78..0x7F; the 0xC0
  313. * block may hold unrelated values (e.g. a power supply ID) there. */
  314. if (tpec_ec_rev < 3) {
  315. for (i = 0; i < 8; i++) {
  316. if (ec_read((unsigned char)(TP_TEMP_HI + i), &b) != 0)
  317. continue;
  318. if (b != 0x80 && b != 0x00)
  319. out->temp_c[8 + i] = (signed char)b;
  320. }
  321. }
  322. {
  323. unsigned char lo = 0, hi = 0;
  324. if (ec_read(TP_FAN_LSB, &lo) == 0 &&
  325. ec_read(TP_FAN_MSB, &hi) == 0) {
  326. if (!(lo == 0xFF && hi == 0xFF))
  327. out->fan_rpm = ((unsigned int)hi << 8) | lo;
  328. }
  329. }
  330. if (ec_read(TP_FAN_LEVEL, &b) == 0)
  331. out->fan_level = b;
  332. }
  333. static void tpec_copy_ident(char *dst, unsigned int size, const char *src)
  334. {
  335. unsigned int i;
  336. for (i = 0; i + 1 < size && src[i]; i++)
  337. dst[i] = src[i];
  338. dst[i] = '\0';
  339. }
  340. static void tpec_read_battery(struct power_battery *b, unsigned int index,
  341. int detail, int *page_dirty)
  342. {
  343. unsigned char st;
  344. unsigned int v;
  345. unsigned int remaining = 0, full = 0, rsoc = 0xFFFF;
  346. int have_remaining = 0, have_full = 0, have_rsoc = 0;
  347. int have_voltage = 0;
  348. if (ec_read((unsigned char)(TP_BAT0_STATUS + index), &st) != 0) {
  349. b->error = 1;
  350. return;
  351. }
  352. b->status = st;
  353. b->present = (st & 0x80) ? 1 : 0;
  354. b->charging = (st & 0x20) ? 1 : 0;
  355. b->discharging = (st & 0x40) ? 1 : 0;
  356. if (!b->present)
  357. return;
  358. if (ec_battery_page(index, TP_BAT_PAGE_DYNAMIC, page_dirty) != 0) {
  359. b->error = 1;
  360. return;
  361. }
  362. if (ec_read16((unsigned char)(TP_BAT_DATA + TP_BAT_REMAINING), &v) == 0) {
  363. remaining = v;
  364. have_remaining = (v != 0xFFFF);
  365. }
  366. if (ec_read16((unsigned char)(TP_BAT_DATA + TP_BAT_FULL), &v) == 0) {
  367. full = v;
  368. have_full = (v != 0xFFFF);
  369. }
  370. if (ec_read16((unsigned char)(TP_BAT_DATA + TP_BAT_RSOC), &v) == 0) {
  371. rsoc = v;
  372. have_rsoc = (v != 0xFFFF);
  373. }
  374. if (ec_read16((unsigned char)(TP_BAT_DATA + TP_BAT_RATE), &v) == 0) {
  375. if (v != 0xFFFF)
  376. b->rate = (int)(short)v;
  377. } else {
  378. b->error = 1;
  379. }
  380. if (ec_read16((unsigned char)(TP_BAT_DATA + TP_BAT_VOLTAGE), &v) == 0 &&
  381. v != 0xFFFF) {
  382. b->voltage_mv = v;
  383. have_voltage = 1;
  384. } else {
  385. b->error = 1;
  386. }
  387. b->remaining = have_remaining ? remaining : 0;
  388. b->full = have_full ? full : 0;
  389. if (!have_remaining || !have_full || !have_voltage)
  390. b->error = 1;
  391. /* Percentage is unit-independent (both capacities use the same unit).
  392. * Reject the 0xFFFF "unknown" marker and obviously inconsistent reads;
  393. * fall back to the SBS relative state of charge if that is sane. */
  394. if (have_full && have_remaining && full > 0 && full != 0xFFFF &&
  395. remaining != 0xFFFF && remaining <= full + full / 4) {
  396. b->percent = (int)((remaining * 100u + full / 2u) / full);
  397. if (b->percent > 100)
  398. b->percent = 100;
  399. b->percent_valid = 1;
  400. } else if (have_rsoc && rsoc <= 100) {
  401. b->percent = (int)rsoc;
  402. b->percent_valid = 1;
  403. }
  404. if (!detail)
  405. return;
  406. if (ec_battery_page(index, TP_BAT_PAGE_MODE, page_dirty) == 0) {
  407. if (ec_read16(TP_BAT_DATA, &v) == 0 && v != 0xFFFF) {
  408. b->unit_known = 1;
  409. b->unit_mwh = (int)((v >> 15) & 1);
  410. }
  411. } else {
  412. b->error = 1;
  413. }
  414. if (ec_battery_page(index, TP_BAT_PAGE_STATIC, page_dirty) == 0) {
  415. if (ec_read16(TP_BAT_DATA, &v) == 0 && v != 0xFFFF)
  416. b->design = v;
  417. } else {
  418. b->error = 1;
  419. }
  420. /* The vendor DSDT's GBIF/GBST report mWh/mW when the mode bit is set:
  421. * capacities are scaled by 10 (the 10.8 V pack) and the rate by the
  422. * measured voltage. Match that so powerinfo shows the same units as
  423. * the firmware's ACPI battery interface. The percentage above was
  424. * already computed from the raw values, so the scale does not matter. */
  425. if (b->unit_mwh) {
  426. b->remaining *= 10;
  427. b->full *= 10;
  428. b->design *= 10;
  429. if (b->voltage_mv)
  430. b->rate = (b->rate * (int)b->voltage_mv) / 1000;
  431. }
  432. if (ec_battery_page(index, TP_BAT_PAGE_MFR, page_dirty) == 0)
  433. ec_read_string(b->manufacturer, sizeof(b->manufacturer),
  434. TP_BAT_DATA);
  435. else
  436. b->error = 1;
  437. if (ec_battery_page(index, TP_BAT_PAGE_MODEL, page_dirty) == 0)
  438. ec_read_string(b->model, sizeof(b->model), TP_BAT_DATA);
  439. else
  440. b->error = 1;
  441. }
  442. void tpec_power_read(struct power_info *out, int detail)
  443. {
  444. unsigned int i;
  445. unsigned char saved_page = 0, ac;
  446. int have_saved = 0, page_dirty = 0;
  447. for (i = 0; i < sizeof(*out); i++)
  448. ((unsigned char *)out)[i] = 0;
  449. out->ac_online = -1;
  450. if (tpec_state < 0)
  451. tpec_init();
  452. if (!tpec_state)
  453. return;
  454. out->present = 1;
  455. out->source = SYS_POWER_SRC_TPEC;
  456. out->ec_rev = tpec_ec_rev;
  457. tpec_copy_ident(out->vendor, sizeof(out->vendor), tpec_vendor);
  458. tpec_copy_ident(out->product, sizeof(out->product), tpec_product);
  459. tpec_copy_ident(out->version, sizeof(out->version), tpec_version);
  460. if (ec_read(TP_AC_STATUS, &ac) == 0)
  461. out->ac_online = (ac & 0x10) ? 1 : 0;
  462. if (ec_read(TP_BAT_PAGE, &saved_page) == 0)
  463. have_saved = 1;
  464. for (i = 0; i < POWER_BATT_MAX; i++) {
  465. tpec_read_battery(&out->battery[i], i, detail, &page_dirty);
  466. if (out->battery[i].present)
  467. out->battery_count++;
  468. }
  469. if (page_dirty)
  470. (void)ec_write(TP_BAT_PAGE, have_saved ? saved_page : 0);
  471. }