cros_ec_i2c.c 4.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176
  1. /*
  2. * Chromium OS cros_ec driver - I2C interface
  3. *
  4. * Copyright (c) 2012 The Chromium OS Authors.
  5. *
  6. * SPDX-License-Identifier: GPL-2.0+
  7. */
  8. /*
  9. * The Matrix Keyboard Protocol driver handles talking to the keyboard
  10. * controller chip. Mostly this is for keyboard functions, but some other
  11. * things have slipped in, so we provide generic services to talk to the
  12. * KBC.
  13. */
  14. #include <common.h>
  15. #include <i2c.h>
  16. #include <cros_ec.h>
  17. #ifdef DEBUG_TRACE
  18. #define debug_trace(fmt, b...) debug(fmt, #b)
  19. #else
  20. #define debug_trace(fmt, b...)
  21. #endif
  22. int cros_ec_i2c_command(struct cros_ec_dev *dev, uint8_t cmd, int cmd_version,
  23. const uint8_t *dout, int dout_len,
  24. uint8_t **dinp, int din_len)
  25. {
  26. int old_bus = 0;
  27. /* version8, cmd8, arglen8, out8[dout_len], csum8 */
  28. int out_bytes = dout_len + 4;
  29. /* response8, arglen8, in8[din_len], checksum8 */
  30. int in_bytes = din_len + 3;
  31. uint8_t *ptr;
  32. /* Receive input data, so that args will be dword aligned */
  33. uint8_t *in_ptr;
  34. int len, csum, ret;
  35. old_bus = i2c_get_bus_num();
  36. /*
  37. * Sanity-check I/O sizes given transaction overhead in internal
  38. * buffers.
  39. */
  40. if (out_bytes > sizeof(dev->dout)) {
  41. debug("%s: Cannot send %d bytes\n", __func__, dout_len);
  42. return -1;
  43. }
  44. if (in_bytes > sizeof(dev->din)) {
  45. debug("%s: Cannot receive %d bytes\n", __func__, din_len);
  46. return -1;
  47. }
  48. assert(dout_len >= 0);
  49. assert(dinp);
  50. /*
  51. * Copy command and data into output buffer so we can do a single I2C
  52. * burst transaction.
  53. */
  54. ptr = dev->dout;
  55. /*
  56. * in_ptr starts of pointing to a dword-aligned input data buffer.
  57. * We decrement it back by the number of header bytes we expect to
  58. * receive, so that the first parameter of the resulting input data
  59. * will be dword aligned.
  60. */
  61. in_ptr = dev->din + sizeof(int64_t);
  62. if (dev->protocol_version != 2) {
  63. /* Something we don't support */
  64. debug("%s: Protocol version %d unsupported\n",
  65. __func__, dev->protocol_version);
  66. return -1;
  67. }
  68. *ptr++ = EC_CMD_VERSION0 + cmd_version;
  69. *ptr++ = cmd;
  70. *ptr++ = dout_len;
  71. in_ptr -= 2; /* Expect status, length bytes */
  72. memcpy(ptr, dout, dout_len);
  73. ptr += dout_len;
  74. *ptr++ = (uint8_t)
  75. cros_ec_calc_checksum(dev->dout, dout_len + 3);
  76. /* Set to the proper i2c bus */
  77. if (i2c_set_bus_num(dev->bus_num)) {
  78. debug("%s: Cannot change to I2C bus %d\n", __func__,
  79. dev->bus_num);
  80. return -1;
  81. }
  82. /* Send output data */
  83. cros_ec_dump_data("out", -1, dev->dout, out_bytes);
  84. ret = i2c_write(dev->addr, 0, 0, dev->dout, out_bytes);
  85. if (ret) {
  86. debug("%s: Cannot complete I2C write to 0x%x\n",
  87. __func__, dev->addr);
  88. ret = -1;
  89. }
  90. if (!ret) {
  91. ret = i2c_read(dev->addr, 0, 0, in_ptr, in_bytes);
  92. if (ret) {
  93. debug("%s: Cannot complete I2C read from 0x%x\n",
  94. __func__, dev->addr);
  95. ret = -1;
  96. }
  97. }
  98. /* Return to original bus number */
  99. i2c_set_bus_num(old_bus);
  100. if (ret)
  101. return ret;
  102. if (*in_ptr != EC_RES_SUCCESS) {
  103. debug("%s: Received bad result code %d\n", __func__, *in_ptr);
  104. return -(int)*in_ptr;
  105. }
  106. len = in_ptr[1];
  107. if (len + 3 > sizeof(dev->din)) {
  108. debug("%s: Received length %#02x too large\n",
  109. __func__, len);
  110. return -1;
  111. }
  112. csum = cros_ec_calc_checksum(in_ptr, 2 + len);
  113. if (csum != in_ptr[2 + len]) {
  114. debug("%s: Invalid checksum rx %#02x, calced %#02x\n",
  115. __func__, in_ptr[2 + din_len], csum);
  116. return -1;
  117. }
  118. din_len = min(din_len, len);
  119. cros_ec_dump_data("in", -1, in_ptr, din_len + 3);
  120. /* Return pointer to dword-aligned input data, if any */
  121. *dinp = dev->din + sizeof(int64_t);
  122. return din_len;
  123. }
  124. int cros_ec_i2c_decode_fdt(struct cros_ec_dev *dev, const void *blob)
  125. {
  126. /* Decode interface-specific FDT params */
  127. dev->max_frequency = fdtdec_get_int(blob, dev->node,
  128. "i2c-max-frequency", 100000);
  129. dev->bus_num = i2c_get_bus_num_fdt(dev->parent_node);
  130. if (dev->bus_num == -1) {
  131. debug("%s: Failed to read bus number\n", __func__);
  132. return -1;
  133. }
  134. dev->addr = fdtdec_get_int(blob, dev->node, "reg", -1);
  135. if (dev->addr == -1) {
  136. debug("%s: Failed to read device address\n", __func__);
  137. return -1;
  138. }
  139. return 0;
  140. }
  141. /**
  142. * Initialize I2C protocol.
  143. *
  144. * @param dev CROS_EC device
  145. * @param blob Device tree blob
  146. * @return 0 if ok, -1 on error
  147. */
  148. int cros_ec_i2c_init(struct cros_ec_dev *dev, const void *blob)
  149. {
  150. i2c_init(dev->max_frequency, dev->addr);
  151. return 0;
  152. }