188364387SHung-ying Tyan /* 288364387SHung-ying Tyan * Chromium OS cros_ec driver 388364387SHung-ying Tyan * 488364387SHung-ying Tyan * Copyright (c) 2012 The Chromium OS Authors. 588364387SHung-ying Tyan * 61a459660SWolfgang Denk * SPDX-License-Identifier: GPL-2.0+ 788364387SHung-ying Tyan */ 888364387SHung-ying Tyan 988364387SHung-ying Tyan /* 10836bb6e8SSimon Glass * This is the interface to the Chrome OS EC. It provides keyboard functions, 11836bb6e8SSimon Glass * power control and battery management. Quite a few other functions are 12836bb6e8SSimon Glass * provided to enable the EC software to be updated, talk to the EC's I2C bus 13836bb6e8SSimon Glass * and store a small amount of data in a memory which persists while the EC 14836bb6e8SSimon Glass * is not reset. 1588364387SHung-ying Tyan */ 1688364387SHung-ying Tyan 1788364387SHung-ying Tyan #include <common.h> 1888364387SHung-ying Tyan #include <command.h> 1984d6cbd3SSimon Glass #include <dm.h> 2088364387SHung-ying Tyan #include <i2c.h> 2188364387SHung-ying Tyan #include <cros_ec.h> 2288364387SHung-ying Tyan #include <fdtdec.h> 2388364387SHung-ying Tyan #include <malloc.h> 2488364387SHung-ying Tyan #include <spi.h> 252ab83f0dSSimon Glass #include <asm/errno.h> 2688364387SHung-ying Tyan #include <asm/io.h> 2788364387SHung-ying Tyan #include <asm-generic/gpio.h> 2884d6cbd3SSimon Glass #include <dm/device-internal.h> 2984d6cbd3SSimon Glass #include <dm/uclass-internal.h> 3088364387SHung-ying Tyan 3188364387SHung-ying Tyan #ifdef DEBUG_TRACE 3288364387SHung-ying Tyan #define debug_trace(fmt, b...) debug(fmt, #b) 3388364387SHung-ying Tyan #else 3488364387SHung-ying Tyan #define debug_trace(fmt, b...) 3588364387SHung-ying Tyan #endif 3688364387SHung-ying Tyan 3788364387SHung-ying Tyan enum { 3888364387SHung-ying Tyan /* Timeout waiting for a flash erase command to complete */ 3988364387SHung-ying Tyan CROS_EC_CMD_TIMEOUT_MS = 5000, 4088364387SHung-ying Tyan /* Timeout waiting for a synchronous hash to be recomputed */ 4188364387SHung-ying Tyan CROS_EC_CMD_HASH_TIMEOUT_MS = 2000, 4288364387SHung-ying Tyan }; 4388364387SHung-ying Tyan 4484d6cbd3SSimon Glass #ifndef CONFIG_DM_CROS_EC 4588364387SHung-ying Tyan static struct cros_ec_dev static_dev, *last_dev; 4684d6cbd3SSimon Glass #endif 4788364387SHung-ying Tyan 4888364387SHung-ying Tyan DECLARE_GLOBAL_DATA_PTR; 4988364387SHung-ying Tyan 5088364387SHung-ying Tyan /* Note: depends on enum ec_current_image */ 5188364387SHung-ying Tyan static const char * const ec_current_image_name[] = {"unknown", "RO", "RW"}; 5288364387SHung-ying Tyan 5388364387SHung-ying Tyan void cros_ec_dump_data(const char *name, int cmd, const uint8_t *data, int len) 5488364387SHung-ying Tyan { 5588364387SHung-ying Tyan #ifdef DEBUG 5688364387SHung-ying Tyan int i; 5788364387SHung-ying Tyan 5888364387SHung-ying Tyan printf("%s: ", name); 5988364387SHung-ying Tyan if (cmd != -1) 6088364387SHung-ying Tyan printf("cmd=%#x: ", cmd); 6188364387SHung-ying Tyan for (i = 0; i < len; i++) 6288364387SHung-ying Tyan printf("%02x ", data[i]); 6388364387SHung-ying Tyan printf("\n"); 6488364387SHung-ying Tyan #endif 6588364387SHung-ying Tyan } 6688364387SHung-ying Tyan 6788364387SHung-ying Tyan /* 6888364387SHung-ying Tyan * Calculate a simple 8-bit checksum of a data block 6988364387SHung-ying Tyan * 7088364387SHung-ying Tyan * @param data Data block to checksum 7188364387SHung-ying Tyan * @param size Size of data block in bytes 7288364387SHung-ying Tyan * @return checksum value (0 to 255) 7388364387SHung-ying Tyan */ 7488364387SHung-ying Tyan int cros_ec_calc_checksum(const uint8_t *data, int size) 7588364387SHung-ying Tyan { 7688364387SHung-ying Tyan int csum, i; 7788364387SHung-ying Tyan 7888364387SHung-ying Tyan for (i = csum = 0; i < size; i++) 7988364387SHung-ying Tyan csum += data[i]; 8088364387SHung-ying Tyan return csum & 0xff; 8188364387SHung-ying Tyan } 8288364387SHung-ying Tyan 832d8ede58SSimon Glass /** 842d8ede58SSimon Glass * Create a request packet for protocol version 3. 852d8ede58SSimon Glass * 862d8ede58SSimon Glass * The packet is stored in the device's internal output buffer. 872d8ede58SSimon Glass * 882d8ede58SSimon Glass * @param dev CROS-EC device 892d8ede58SSimon Glass * @param cmd Command to send (EC_CMD_...) 902d8ede58SSimon Glass * @param cmd_version Version of command to send (EC_VER_...) 912d8ede58SSimon Glass * @param dout Output data (may be NULL If dout_len=0) 922d8ede58SSimon Glass * @param dout_len Size of output data in bytes 932d8ede58SSimon Glass * @return packet size in bytes, or <0 if error. 942d8ede58SSimon Glass */ 952d8ede58SSimon Glass static int create_proto3_request(struct cros_ec_dev *dev, 962d8ede58SSimon Glass int cmd, int cmd_version, 972d8ede58SSimon Glass const void *dout, int dout_len) 982d8ede58SSimon Glass { 992d8ede58SSimon Glass struct ec_host_request *rq = (struct ec_host_request *)dev->dout; 1002d8ede58SSimon Glass int out_bytes = dout_len + sizeof(*rq); 1012d8ede58SSimon Glass 1022d8ede58SSimon Glass /* Fail if output size is too big */ 1032d8ede58SSimon Glass if (out_bytes > (int)sizeof(dev->dout)) { 1042d8ede58SSimon Glass debug("%s: Cannot send %d bytes\n", __func__, dout_len); 1052d8ede58SSimon Glass return -EC_RES_REQUEST_TRUNCATED; 1062d8ede58SSimon Glass } 1072d8ede58SSimon Glass 1082d8ede58SSimon Glass /* Fill in request packet */ 1092d8ede58SSimon Glass rq->struct_version = EC_HOST_REQUEST_VERSION; 1102d8ede58SSimon Glass rq->checksum = 0; 1112d8ede58SSimon Glass rq->command = cmd; 1122d8ede58SSimon Glass rq->command_version = cmd_version; 1132d8ede58SSimon Glass rq->reserved = 0; 1142d8ede58SSimon Glass rq->data_len = dout_len; 1152d8ede58SSimon Glass 1162d8ede58SSimon Glass /* Copy data after header */ 1172d8ede58SSimon Glass memcpy(rq + 1, dout, dout_len); 1182d8ede58SSimon Glass 1192d8ede58SSimon Glass /* Write checksum field so the entire packet sums to 0 */ 1202d8ede58SSimon Glass rq->checksum = (uint8_t)(-cros_ec_calc_checksum(dev->dout, out_bytes)); 1212d8ede58SSimon Glass 1222d8ede58SSimon Glass cros_ec_dump_data("out", cmd, dev->dout, out_bytes); 1232d8ede58SSimon Glass 1242d8ede58SSimon Glass /* Return size of request packet */ 1252d8ede58SSimon Glass return out_bytes; 1262d8ede58SSimon Glass } 1272d8ede58SSimon Glass 1282d8ede58SSimon Glass /** 1292d8ede58SSimon Glass * Prepare the device to receive a protocol version 3 response. 1302d8ede58SSimon Glass * 1312d8ede58SSimon Glass * @param dev CROS-EC device 1322d8ede58SSimon Glass * @param din_len Maximum size of response in bytes 1332d8ede58SSimon Glass * @return maximum expected number of bytes in response, or <0 if error. 1342d8ede58SSimon Glass */ 1352d8ede58SSimon Glass static int prepare_proto3_response_buffer(struct cros_ec_dev *dev, int din_len) 1362d8ede58SSimon Glass { 1372d8ede58SSimon Glass int in_bytes = din_len + sizeof(struct ec_host_response); 1382d8ede58SSimon Glass 1392d8ede58SSimon Glass /* Fail if input size is too big */ 1402d8ede58SSimon Glass if (in_bytes > (int)sizeof(dev->din)) { 1412d8ede58SSimon Glass debug("%s: Cannot receive %d bytes\n", __func__, din_len); 1422d8ede58SSimon Glass return -EC_RES_RESPONSE_TOO_BIG; 1432d8ede58SSimon Glass } 1442d8ede58SSimon Glass 1452d8ede58SSimon Glass /* Return expected size of response packet */ 1462d8ede58SSimon Glass return in_bytes; 1472d8ede58SSimon Glass } 1482d8ede58SSimon Glass 1492d8ede58SSimon Glass /** 1502d8ede58SSimon Glass * Handle a protocol version 3 response packet. 1512d8ede58SSimon Glass * 1522d8ede58SSimon Glass * The packet must already be stored in the device's internal input buffer. 1532d8ede58SSimon Glass * 1542d8ede58SSimon Glass * @param dev CROS-EC device 1552d8ede58SSimon Glass * @param dinp Returns pointer to response data 1562d8ede58SSimon Glass * @param din_len Maximum size of response in bytes 1578bbb38b1SSimon Glass * @return number of bytes of response data, or <0 if error. Note that error 1588bbb38b1SSimon Glass * codes can be from errno.h or -ve EC_RES_INVALID_CHECKSUM values (and they 1598bbb38b1SSimon Glass * overlap!) 1602d8ede58SSimon Glass */ 1612d8ede58SSimon Glass static int handle_proto3_response(struct cros_ec_dev *dev, 1622d8ede58SSimon Glass uint8_t **dinp, int din_len) 1632d8ede58SSimon Glass { 1642d8ede58SSimon Glass struct ec_host_response *rs = (struct ec_host_response *)dev->din; 1652d8ede58SSimon Glass int in_bytes; 1662d8ede58SSimon Glass int csum; 1672d8ede58SSimon Glass 1682d8ede58SSimon Glass cros_ec_dump_data("in-header", -1, dev->din, sizeof(*rs)); 1692d8ede58SSimon Glass 1702d8ede58SSimon Glass /* Check input data */ 1712d8ede58SSimon Glass if (rs->struct_version != EC_HOST_RESPONSE_VERSION) { 1722d8ede58SSimon Glass debug("%s: EC response version mismatch\n", __func__); 1732d8ede58SSimon Glass return -EC_RES_INVALID_RESPONSE; 1742d8ede58SSimon Glass } 1752d8ede58SSimon Glass 1762d8ede58SSimon Glass if (rs->reserved) { 1772d8ede58SSimon Glass debug("%s: EC response reserved != 0\n", __func__); 1782d8ede58SSimon Glass return -EC_RES_INVALID_RESPONSE; 1792d8ede58SSimon Glass } 1802d8ede58SSimon Glass 1812d8ede58SSimon Glass if (rs->data_len > din_len) { 1822d8ede58SSimon Glass debug("%s: EC returned too much data\n", __func__); 1832d8ede58SSimon Glass return -EC_RES_RESPONSE_TOO_BIG; 1842d8ede58SSimon Glass } 1852d8ede58SSimon Glass 1862d8ede58SSimon Glass cros_ec_dump_data("in-data", -1, dev->din + sizeof(*rs), rs->data_len); 1872d8ede58SSimon Glass 1882d8ede58SSimon Glass /* Update in_bytes to actual data size */ 1892d8ede58SSimon Glass in_bytes = sizeof(*rs) + rs->data_len; 1902d8ede58SSimon Glass 1912d8ede58SSimon Glass /* Verify checksum */ 1922d8ede58SSimon Glass csum = cros_ec_calc_checksum(dev->din, in_bytes); 1932d8ede58SSimon Glass if (csum) { 1942d8ede58SSimon Glass debug("%s: EC response checksum invalid: 0x%02x\n", __func__, 1952d8ede58SSimon Glass csum); 1962d8ede58SSimon Glass return -EC_RES_INVALID_CHECKSUM; 1972d8ede58SSimon Glass } 1982d8ede58SSimon Glass 1992d8ede58SSimon Glass /* Return error result, if any */ 2002d8ede58SSimon Glass if (rs->result) 2012d8ede58SSimon Glass return -(int)rs->result; 2022d8ede58SSimon Glass 2032d8ede58SSimon Glass /* If we're still here, set response data pointer and return length */ 2042d8ede58SSimon Glass *dinp = (uint8_t *)(rs + 1); 2052d8ede58SSimon Glass 2062d8ede58SSimon Glass return rs->data_len; 2072d8ede58SSimon Glass } 2082d8ede58SSimon Glass 2092d8ede58SSimon Glass static int send_command_proto3(struct cros_ec_dev *dev, 2102d8ede58SSimon Glass int cmd, int cmd_version, 2112d8ede58SSimon Glass const void *dout, int dout_len, 2122d8ede58SSimon Glass uint8_t **dinp, int din_len) 2132d8ede58SSimon Glass { 21484d6cbd3SSimon Glass #ifdef CONFIG_DM_CROS_EC 21584d6cbd3SSimon Glass struct dm_cros_ec_ops *ops; 21684d6cbd3SSimon Glass #endif 2172d8ede58SSimon Glass int out_bytes, in_bytes; 2182d8ede58SSimon Glass int rv; 2192d8ede58SSimon Glass 2202d8ede58SSimon Glass /* Create request packet */ 2212d8ede58SSimon Glass out_bytes = create_proto3_request(dev, cmd, cmd_version, 2222d8ede58SSimon Glass dout, dout_len); 2232d8ede58SSimon Glass if (out_bytes < 0) 2242d8ede58SSimon Glass return out_bytes; 2252d8ede58SSimon Glass 2262d8ede58SSimon Glass /* Prepare response buffer */ 2272d8ede58SSimon Glass in_bytes = prepare_proto3_response_buffer(dev, din_len); 2282d8ede58SSimon Glass if (in_bytes < 0) 2292d8ede58SSimon Glass return in_bytes; 2302d8ede58SSimon Glass 23184d6cbd3SSimon Glass #ifdef CONFIG_DM_CROS_EC 23284d6cbd3SSimon Glass ops = dm_cros_ec_get_ops(dev->dev); 2338bbb38b1SSimon Glass rv = ops->packet ? ops->packet(dev->dev, out_bytes, in_bytes) : -ENOSYS; 23484d6cbd3SSimon Glass #else 2352d8ede58SSimon Glass switch (dev->interface) { 236a6070283SRandall Spangler #ifdef CONFIG_CROS_EC_SPI 237a6070283SRandall Spangler case CROS_EC_IF_SPI: 238a6070283SRandall Spangler rv = cros_ec_spi_packet(dev, out_bytes, in_bytes); 239a6070283SRandall Spangler break; 240a6070283SRandall Spangler #endif 241df93d90aSSimon Glass #ifdef CONFIG_CROS_EC_SANDBOX 242df93d90aSSimon Glass case CROS_EC_IF_SANDBOX: 243df93d90aSSimon Glass rv = cros_ec_sandbox_packet(dev, out_bytes, in_bytes); 244df93d90aSSimon Glass break; 245df93d90aSSimon Glass #endif 2462d8ede58SSimon Glass case CROS_EC_IF_NONE: 2472d8ede58SSimon Glass /* TODO: support protocol 3 for LPC, I2C; for now fall through */ 2482d8ede58SSimon Glass default: 2492d8ede58SSimon Glass debug("%s: Unsupported interface\n", __func__); 2502d8ede58SSimon Glass rv = -1; 2512d8ede58SSimon Glass } 25284d6cbd3SSimon Glass #endif 2532d8ede58SSimon Glass if (rv < 0) 2542d8ede58SSimon Glass return rv; 2552d8ede58SSimon Glass 2562d8ede58SSimon Glass /* Process the response */ 2572d8ede58SSimon Glass return handle_proto3_response(dev, dinp, din_len); 2582d8ede58SSimon Glass } 2592d8ede58SSimon Glass 26088364387SHung-ying Tyan static int send_command(struct cros_ec_dev *dev, uint8_t cmd, int cmd_version, 26188364387SHung-ying Tyan const void *dout, int dout_len, 26288364387SHung-ying Tyan uint8_t **dinp, int din_len) 26388364387SHung-ying Tyan { 26484d6cbd3SSimon Glass #ifdef CONFIG_DM_CROS_EC 26584d6cbd3SSimon Glass struct dm_cros_ec_ops *ops; 26684d6cbd3SSimon Glass #endif 2672d8ede58SSimon Glass int ret = -1; 2682d8ede58SSimon Glass 2692d8ede58SSimon Glass /* Handle protocol version 3 support */ 2702d8ede58SSimon Glass if (dev->protocol_version == 3) { 2712d8ede58SSimon Glass return send_command_proto3(dev, cmd, cmd_version, 2722d8ede58SSimon Glass dout, dout_len, dinp, din_len); 2732d8ede58SSimon Glass } 27488364387SHung-ying Tyan 27584d6cbd3SSimon Glass #ifdef CONFIG_DM_CROS_EC 27684d6cbd3SSimon Glass ops = dm_cros_ec_get_ops(dev->dev); 27784d6cbd3SSimon Glass ret = ops->command(dev->dev, cmd, cmd_version, 27884d6cbd3SSimon Glass (const uint8_t *)dout, dout_len, dinp, din_len); 27984d6cbd3SSimon Glass #else 28088364387SHung-ying Tyan switch (dev->interface) { 28188364387SHung-ying Tyan #ifdef CONFIG_CROS_EC_SPI 28288364387SHung-ying Tyan case CROS_EC_IF_SPI: 28388364387SHung-ying Tyan ret = cros_ec_spi_command(dev, cmd, cmd_version, 28488364387SHung-ying Tyan (const uint8_t *)dout, dout_len, 28588364387SHung-ying Tyan dinp, din_len); 28688364387SHung-ying Tyan break; 28788364387SHung-ying Tyan #endif 28888364387SHung-ying Tyan #ifdef CONFIG_CROS_EC_I2C 28988364387SHung-ying Tyan case CROS_EC_IF_I2C: 29088364387SHung-ying Tyan ret = cros_ec_i2c_command(dev, cmd, cmd_version, 29188364387SHung-ying Tyan (const uint8_t *)dout, dout_len, 29288364387SHung-ying Tyan dinp, din_len); 29388364387SHung-ying Tyan break; 29488364387SHung-ying Tyan #endif 29588364387SHung-ying Tyan #ifdef CONFIG_CROS_EC_LPC 29688364387SHung-ying Tyan case CROS_EC_IF_LPC: 29788364387SHung-ying Tyan ret = cros_ec_lpc_command(dev, cmd, cmd_version, 29888364387SHung-ying Tyan (const uint8_t *)dout, dout_len, 29988364387SHung-ying Tyan dinp, din_len); 30088364387SHung-ying Tyan break; 30188364387SHung-ying Tyan #endif 30288364387SHung-ying Tyan case CROS_EC_IF_NONE: 30388364387SHung-ying Tyan default: 30488364387SHung-ying Tyan ret = -1; 30588364387SHung-ying Tyan } 30684d6cbd3SSimon Glass #endif 30788364387SHung-ying Tyan 30888364387SHung-ying Tyan return ret; 30988364387SHung-ying Tyan } 31088364387SHung-ying Tyan 31188364387SHung-ying Tyan /** 31288364387SHung-ying Tyan * Send a command to the CROS-EC device and return the reply. 31388364387SHung-ying Tyan * 31488364387SHung-ying Tyan * The device's internal input/output buffers are used. 31588364387SHung-ying Tyan * 31688364387SHung-ying Tyan * @param dev CROS-EC device 31788364387SHung-ying Tyan * @param cmd Command to send (EC_CMD_...) 31888364387SHung-ying Tyan * @param cmd_version Version of command to send (EC_VER_...) 31988364387SHung-ying Tyan * @param dout Output data (may be NULL If dout_len=0) 32088364387SHung-ying Tyan * @param dout_len Size of output data in bytes 32188364387SHung-ying Tyan * @param dinp Response data (may be NULL If din_len=0). 32288364387SHung-ying Tyan * If not NULL, it will be updated to point to the data 32388364387SHung-ying Tyan * and will always be double word aligned (64-bits) 32488364387SHung-ying Tyan * @param din_len Maximum size of response in bytes 3258bbb38b1SSimon Glass * @return number of bytes in response, or -ve on error 32688364387SHung-ying Tyan */ 32788364387SHung-ying Tyan static int ec_command_inptr(struct cros_ec_dev *dev, uint8_t cmd, 32888364387SHung-ying Tyan int cmd_version, const void *dout, int dout_len, uint8_t **dinp, 32988364387SHung-ying Tyan int din_len) 33088364387SHung-ying Tyan { 3312ab83f0dSSimon Glass uint8_t *din = NULL; 33288364387SHung-ying Tyan int len; 33388364387SHung-ying Tyan 33488364387SHung-ying Tyan len = send_command(dev, cmd, cmd_version, dout, dout_len, 33588364387SHung-ying Tyan &din, din_len); 33688364387SHung-ying Tyan 33788364387SHung-ying Tyan /* If the command doesn't complete, wait a while */ 33888364387SHung-ying Tyan if (len == -EC_RES_IN_PROGRESS) { 3392ab83f0dSSimon Glass struct ec_response_get_comms_status *resp = NULL; 34088364387SHung-ying Tyan ulong start; 34188364387SHung-ying Tyan 34288364387SHung-ying Tyan /* Wait for command to complete */ 34388364387SHung-ying Tyan start = get_timer(0); 34488364387SHung-ying Tyan do { 34588364387SHung-ying Tyan int ret; 34688364387SHung-ying Tyan 34788364387SHung-ying Tyan mdelay(50); /* Insert some reasonable delay */ 34888364387SHung-ying Tyan ret = send_command(dev, EC_CMD_GET_COMMS_STATUS, 0, 34988364387SHung-ying Tyan NULL, 0, 35088364387SHung-ying Tyan (uint8_t **)&resp, sizeof(*resp)); 35188364387SHung-ying Tyan if (ret < 0) 35288364387SHung-ying Tyan return ret; 35388364387SHung-ying Tyan 35488364387SHung-ying Tyan if (get_timer(start) > CROS_EC_CMD_TIMEOUT_MS) { 35588364387SHung-ying Tyan debug("%s: Command %#02x timeout\n", 35688364387SHung-ying Tyan __func__, cmd); 35788364387SHung-ying Tyan return -EC_RES_TIMEOUT; 35888364387SHung-ying Tyan } 35988364387SHung-ying Tyan } while (resp->flags & EC_COMMS_STATUS_PROCESSING); 36088364387SHung-ying Tyan 36188364387SHung-ying Tyan /* OK it completed, so read the status response */ 36288364387SHung-ying Tyan /* not sure why it was 0 for the last argument */ 36388364387SHung-ying Tyan len = send_command(dev, EC_CMD_RESEND_RESPONSE, 0, 36488364387SHung-ying Tyan NULL, 0, &din, din_len); 36588364387SHung-ying Tyan } 36688364387SHung-ying Tyan 3672ab83f0dSSimon Glass debug("%s: len=%d, dinp=%p, *dinp=%p\n", __func__, len, dinp, 3682ab83f0dSSimon Glass dinp ? *dinp : NULL); 36988364387SHung-ying Tyan if (dinp) { 37088364387SHung-ying Tyan /* If we have any data to return, it must be 64bit-aligned */ 37188364387SHung-ying Tyan assert(len <= 0 || !((uintptr_t)din & 7)); 37288364387SHung-ying Tyan *dinp = din; 37388364387SHung-ying Tyan } 37488364387SHung-ying Tyan 37588364387SHung-ying Tyan return len; 37688364387SHung-ying Tyan } 37788364387SHung-ying Tyan 37888364387SHung-ying Tyan /** 37988364387SHung-ying Tyan * Send a command to the CROS-EC device and return the reply. 38088364387SHung-ying Tyan * 38188364387SHung-ying Tyan * The device's internal input/output buffers are used. 38288364387SHung-ying Tyan * 38388364387SHung-ying Tyan * @param dev CROS-EC device 38488364387SHung-ying Tyan * @param cmd Command to send (EC_CMD_...) 38588364387SHung-ying Tyan * @param cmd_version Version of command to send (EC_VER_...) 38688364387SHung-ying Tyan * @param dout Output data (may be NULL If dout_len=0) 38788364387SHung-ying Tyan * @param dout_len Size of output data in bytes 38888364387SHung-ying Tyan * @param din Response data (may be NULL If din_len=0). 38988364387SHung-ying Tyan * It not NULL, it is a place for ec_command() to copy the 39088364387SHung-ying Tyan * data to. 39188364387SHung-ying Tyan * @param din_len Maximum size of response in bytes 3928bbb38b1SSimon Glass * @return number of bytes in response, or -ve on error 39388364387SHung-ying Tyan */ 39488364387SHung-ying Tyan static int ec_command(struct cros_ec_dev *dev, uint8_t cmd, int cmd_version, 39588364387SHung-ying Tyan const void *dout, int dout_len, 39688364387SHung-ying Tyan void *din, int din_len) 39788364387SHung-ying Tyan { 39888364387SHung-ying Tyan uint8_t *in_buffer; 39988364387SHung-ying Tyan int len; 40088364387SHung-ying Tyan 40188364387SHung-ying Tyan assert((din_len == 0) || din); 40288364387SHung-ying Tyan len = ec_command_inptr(dev, cmd, cmd_version, dout, dout_len, 40388364387SHung-ying Tyan &in_buffer, din_len); 40488364387SHung-ying Tyan if (len > 0) { 40588364387SHung-ying Tyan /* 40688364387SHung-ying Tyan * If we were asked to put it somewhere, do so, otherwise just 40788364387SHung-ying Tyan * disregard the result. 40888364387SHung-ying Tyan */ 40988364387SHung-ying Tyan if (din && in_buffer) { 41088364387SHung-ying Tyan assert(len <= din_len); 41188364387SHung-ying Tyan memmove(din, in_buffer, len); 41288364387SHung-ying Tyan } 41388364387SHung-ying Tyan } 41488364387SHung-ying Tyan return len; 41588364387SHung-ying Tyan } 41688364387SHung-ying Tyan 41788364387SHung-ying Tyan int cros_ec_scan_keyboard(struct cros_ec_dev *dev, struct mbkp_keyscan *scan) 41888364387SHung-ying Tyan { 419836bb6e8SSimon Glass if (ec_command(dev, EC_CMD_MKBP_STATE, 0, NULL, 0, scan, 4202ab83f0dSSimon Glass sizeof(scan->data)) != sizeof(scan->data)) 42188364387SHung-ying Tyan return -1; 42288364387SHung-ying Tyan 42388364387SHung-ying Tyan return 0; 42488364387SHung-ying Tyan } 42588364387SHung-ying Tyan 42688364387SHung-ying Tyan int cros_ec_read_id(struct cros_ec_dev *dev, char *id, int maxlen) 42788364387SHung-ying Tyan { 42888364387SHung-ying Tyan struct ec_response_get_version *r; 42988364387SHung-ying Tyan 43088364387SHung-ying Tyan if (ec_command_inptr(dev, EC_CMD_GET_VERSION, 0, NULL, 0, 4312ab83f0dSSimon Glass (uint8_t **)&r, sizeof(*r)) != sizeof(*r)) 43288364387SHung-ying Tyan return -1; 43388364387SHung-ying Tyan 4342ab83f0dSSimon Glass if (maxlen > (int)sizeof(r->version_string_ro)) 43588364387SHung-ying Tyan maxlen = sizeof(r->version_string_ro); 43688364387SHung-ying Tyan 43788364387SHung-ying Tyan switch (r->current_image) { 43888364387SHung-ying Tyan case EC_IMAGE_RO: 43988364387SHung-ying Tyan memcpy(id, r->version_string_ro, maxlen); 44088364387SHung-ying Tyan break; 44188364387SHung-ying Tyan case EC_IMAGE_RW: 44288364387SHung-ying Tyan memcpy(id, r->version_string_rw, maxlen); 44388364387SHung-ying Tyan break; 44488364387SHung-ying Tyan default: 44588364387SHung-ying Tyan return -1; 44688364387SHung-ying Tyan } 44788364387SHung-ying Tyan 44888364387SHung-ying Tyan id[maxlen - 1] = '\0'; 44988364387SHung-ying Tyan return 0; 45088364387SHung-ying Tyan } 45188364387SHung-ying Tyan 45288364387SHung-ying Tyan int cros_ec_read_version(struct cros_ec_dev *dev, 45388364387SHung-ying Tyan struct ec_response_get_version **versionp) 45488364387SHung-ying Tyan { 45588364387SHung-ying Tyan if (ec_command_inptr(dev, EC_CMD_GET_VERSION, 0, NULL, 0, 45688364387SHung-ying Tyan (uint8_t **)versionp, sizeof(**versionp)) 4572ab83f0dSSimon Glass != sizeof(**versionp)) 45888364387SHung-ying Tyan return -1; 45988364387SHung-ying Tyan 46088364387SHung-ying Tyan return 0; 46188364387SHung-ying Tyan } 46288364387SHung-ying Tyan 46388364387SHung-ying Tyan int cros_ec_read_build_info(struct cros_ec_dev *dev, char **strp) 46488364387SHung-ying Tyan { 46588364387SHung-ying Tyan if (ec_command_inptr(dev, EC_CMD_GET_BUILD_INFO, 0, NULL, 0, 466836bb6e8SSimon Glass (uint8_t **)strp, EC_PROTO2_MAX_PARAM_SIZE) < 0) 46788364387SHung-ying Tyan return -1; 46888364387SHung-ying Tyan 46988364387SHung-ying Tyan return 0; 47088364387SHung-ying Tyan } 47188364387SHung-ying Tyan 47288364387SHung-ying Tyan int cros_ec_read_current_image(struct cros_ec_dev *dev, 47388364387SHung-ying Tyan enum ec_current_image *image) 47488364387SHung-ying Tyan { 47588364387SHung-ying Tyan struct ec_response_get_version *r; 47688364387SHung-ying Tyan 47788364387SHung-ying Tyan if (ec_command_inptr(dev, EC_CMD_GET_VERSION, 0, NULL, 0, 4782ab83f0dSSimon Glass (uint8_t **)&r, sizeof(*r)) != sizeof(*r)) 47988364387SHung-ying Tyan return -1; 48088364387SHung-ying Tyan 48188364387SHung-ying Tyan *image = r->current_image; 48288364387SHung-ying Tyan return 0; 48388364387SHung-ying Tyan } 48488364387SHung-ying Tyan 48588364387SHung-ying Tyan static int cros_ec_wait_on_hash_done(struct cros_ec_dev *dev, 48688364387SHung-ying Tyan struct ec_response_vboot_hash *hash) 48788364387SHung-ying Tyan { 48888364387SHung-ying Tyan struct ec_params_vboot_hash p; 48988364387SHung-ying Tyan ulong start; 49088364387SHung-ying Tyan 49188364387SHung-ying Tyan start = get_timer(0); 49288364387SHung-ying Tyan while (hash->status == EC_VBOOT_HASH_STATUS_BUSY) { 49388364387SHung-ying Tyan mdelay(50); /* Insert some reasonable delay */ 49488364387SHung-ying Tyan 49588364387SHung-ying Tyan p.cmd = EC_VBOOT_HASH_GET; 49688364387SHung-ying Tyan if (ec_command(dev, EC_CMD_VBOOT_HASH, 0, &p, sizeof(p), 49788364387SHung-ying Tyan hash, sizeof(*hash)) < 0) 49888364387SHung-ying Tyan return -1; 49988364387SHung-ying Tyan 50088364387SHung-ying Tyan if (get_timer(start) > CROS_EC_CMD_HASH_TIMEOUT_MS) { 50188364387SHung-ying Tyan debug("%s: EC_VBOOT_HASH_GET timeout\n", __func__); 50288364387SHung-ying Tyan return -EC_RES_TIMEOUT; 50388364387SHung-ying Tyan } 50488364387SHung-ying Tyan } 50588364387SHung-ying Tyan return 0; 50688364387SHung-ying Tyan } 50788364387SHung-ying Tyan 50888364387SHung-ying Tyan 50988364387SHung-ying Tyan int cros_ec_read_hash(struct cros_ec_dev *dev, 51088364387SHung-ying Tyan struct ec_response_vboot_hash *hash) 51188364387SHung-ying Tyan { 51288364387SHung-ying Tyan struct ec_params_vboot_hash p; 51388364387SHung-ying Tyan int rv; 51488364387SHung-ying Tyan 51588364387SHung-ying Tyan p.cmd = EC_VBOOT_HASH_GET; 51688364387SHung-ying Tyan if (ec_command(dev, EC_CMD_VBOOT_HASH, 0, &p, sizeof(p), 51788364387SHung-ying Tyan hash, sizeof(*hash)) < 0) 51888364387SHung-ying Tyan return -1; 51988364387SHung-ying Tyan 52088364387SHung-ying Tyan /* If the EC is busy calculating the hash, fidget until it's done. */ 52188364387SHung-ying Tyan rv = cros_ec_wait_on_hash_done(dev, hash); 52288364387SHung-ying Tyan if (rv) 52388364387SHung-ying Tyan return rv; 52488364387SHung-ying Tyan 52588364387SHung-ying Tyan /* If the hash is valid, we're done. Otherwise, we have to kick it off 52688364387SHung-ying Tyan * again and wait for it to complete. Note that we explicitly assume 52788364387SHung-ying Tyan * that hashing zero bytes is always wrong, even though that would 52888364387SHung-ying Tyan * produce a valid hash value. */ 52988364387SHung-ying Tyan if (hash->status == EC_VBOOT_HASH_STATUS_DONE && hash->size) 53088364387SHung-ying Tyan return 0; 53188364387SHung-ying Tyan 53288364387SHung-ying Tyan debug("%s: No valid hash (status=%d size=%d). Compute one...\n", 53388364387SHung-ying Tyan __func__, hash->status, hash->size); 53488364387SHung-ying Tyan 535836bb6e8SSimon Glass p.cmd = EC_VBOOT_HASH_START; 53688364387SHung-ying Tyan p.hash_type = EC_VBOOT_HASH_TYPE_SHA256; 53788364387SHung-ying Tyan p.nonce_size = 0; 53888364387SHung-ying Tyan p.offset = EC_VBOOT_HASH_OFFSET_RW; 53988364387SHung-ying Tyan 54088364387SHung-ying Tyan if (ec_command(dev, EC_CMD_VBOOT_HASH, 0, &p, sizeof(p), 54188364387SHung-ying Tyan hash, sizeof(*hash)) < 0) 54288364387SHung-ying Tyan return -1; 54388364387SHung-ying Tyan 54488364387SHung-ying Tyan rv = cros_ec_wait_on_hash_done(dev, hash); 54588364387SHung-ying Tyan if (rv) 54688364387SHung-ying Tyan return rv; 54788364387SHung-ying Tyan 54888364387SHung-ying Tyan debug("%s: hash done\n", __func__); 54988364387SHung-ying Tyan 55088364387SHung-ying Tyan return 0; 55188364387SHung-ying Tyan } 55288364387SHung-ying Tyan 55388364387SHung-ying Tyan static int cros_ec_invalidate_hash(struct cros_ec_dev *dev) 55488364387SHung-ying Tyan { 55588364387SHung-ying Tyan struct ec_params_vboot_hash p; 55688364387SHung-ying Tyan struct ec_response_vboot_hash *hash; 55788364387SHung-ying Tyan 55888364387SHung-ying Tyan /* We don't have an explict command for the EC to discard its current 55988364387SHung-ying Tyan * hash value, so we'll just tell it to calculate one that we know is 56088364387SHung-ying Tyan * wrong (we claim that hashing zero bytes is always invalid). 56188364387SHung-ying Tyan */ 56288364387SHung-ying Tyan p.cmd = EC_VBOOT_HASH_RECALC; 56388364387SHung-ying Tyan p.hash_type = EC_VBOOT_HASH_TYPE_SHA256; 56488364387SHung-ying Tyan p.nonce_size = 0; 56588364387SHung-ying Tyan p.offset = 0; 56688364387SHung-ying Tyan p.size = 0; 56788364387SHung-ying Tyan 56888364387SHung-ying Tyan debug("%s:\n", __func__); 56988364387SHung-ying Tyan 57088364387SHung-ying Tyan if (ec_command_inptr(dev, EC_CMD_VBOOT_HASH, 0, &p, sizeof(p), 57188364387SHung-ying Tyan (uint8_t **)&hash, sizeof(*hash)) < 0) 57288364387SHung-ying Tyan return -1; 57388364387SHung-ying Tyan 57488364387SHung-ying Tyan /* No need to wait for it to finish */ 57588364387SHung-ying Tyan return 0; 57688364387SHung-ying Tyan } 57788364387SHung-ying Tyan 57888364387SHung-ying Tyan int cros_ec_reboot(struct cros_ec_dev *dev, enum ec_reboot_cmd cmd, 57988364387SHung-ying Tyan uint8_t flags) 58088364387SHung-ying Tyan { 58188364387SHung-ying Tyan struct ec_params_reboot_ec p; 58288364387SHung-ying Tyan 58388364387SHung-ying Tyan p.cmd = cmd; 58488364387SHung-ying Tyan p.flags = flags; 58588364387SHung-ying Tyan 58688364387SHung-ying Tyan if (ec_command_inptr(dev, EC_CMD_REBOOT_EC, 0, &p, sizeof(p), NULL, 0) 58788364387SHung-ying Tyan < 0) 58888364387SHung-ying Tyan return -1; 58988364387SHung-ying Tyan 59088364387SHung-ying Tyan if (!(flags & EC_REBOOT_FLAG_ON_AP_SHUTDOWN)) { 59188364387SHung-ying Tyan /* 59288364387SHung-ying Tyan * EC reboot will take place immediately so delay to allow it 59388364387SHung-ying Tyan * to complete. Note that some reboot types (EC_REBOOT_COLD) 59488364387SHung-ying Tyan * will reboot the AP as well, in which case we won't actually 59588364387SHung-ying Tyan * get to this point. 59688364387SHung-ying Tyan */ 59788364387SHung-ying Tyan /* 59888364387SHung-ying Tyan * TODO(rspangler@chromium.org): Would be nice if we had a 59988364387SHung-ying Tyan * better way to determine when the reboot is complete. Could 60088364387SHung-ying Tyan * we poll a memory-mapped LPC value? 60188364387SHung-ying Tyan */ 60288364387SHung-ying Tyan udelay(50000); 60388364387SHung-ying Tyan } 60488364387SHung-ying Tyan 60588364387SHung-ying Tyan return 0; 60688364387SHung-ying Tyan } 60788364387SHung-ying Tyan 60888364387SHung-ying Tyan int cros_ec_interrupt_pending(struct cros_ec_dev *dev) 60988364387SHung-ying Tyan { 61088364387SHung-ying Tyan /* no interrupt support : always poll */ 61132f8a19fSSimon Glass if (!dm_gpio_is_valid(&dev->ec_int)) 6122ab83f0dSSimon Glass return -ENOENT; 61388364387SHung-ying Tyan 61432f8a19fSSimon Glass return dm_gpio_get_value(&dev->ec_int); 61588364387SHung-ying Tyan } 61688364387SHung-ying Tyan 617836bb6e8SSimon Glass int cros_ec_info(struct cros_ec_dev *dev, struct ec_response_mkbp_info *info) 61888364387SHung-ying Tyan { 619836bb6e8SSimon Glass if (ec_command(dev, EC_CMD_MKBP_INFO, 0, NULL, 0, info, 6202ab83f0dSSimon Glass sizeof(*info)) != sizeof(*info)) 62188364387SHung-ying Tyan return -1; 62288364387SHung-ying Tyan 62388364387SHung-ying Tyan return 0; 62488364387SHung-ying Tyan } 62588364387SHung-ying Tyan 62688364387SHung-ying Tyan int cros_ec_get_host_events(struct cros_ec_dev *dev, uint32_t *events_ptr) 62788364387SHung-ying Tyan { 62888364387SHung-ying Tyan struct ec_response_host_event_mask *resp; 62988364387SHung-ying Tyan 63088364387SHung-ying Tyan /* 63188364387SHung-ying Tyan * Use the B copy of the event flags, because the main copy is already 63288364387SHung-ying Tyan * used by ACPI/SMI. 63388364387SHung-ying Tyan */ 63488364387SHung-ying Tyan if (ec_command_inptr(dev, EC_CMD_HOST_EVENT_GET_B, 0, NULL, 0, 6352ab83f0dSSimon Glass (uint8_t **)&resp, sizeof(*resp)) < (int)sizeof(*resp)) 63688364387SHung-ying Tyan return -1; 63788364387SHung-ying Tyan 63888364387SHung-ying Tyan if (resp->mask & EC_HOST_EVENT_MASK(EC_HOST_EVENT_INVALID)) 63988364387SHung-ying Tyan return -1; 64088364387SHung-ying Tyan 64188364387SHung-ying Tyan *events_ptr = resp->mask; 64288364387SHung-ying Tyan return 0; 64388364387SHung-ying Tyan } 64488364387SHung-ying Tyan 64588364387SHung-ying Tyan int cros_ec_clear_host_events(struct cros_ec_dev *dev, uint32_t events) 64688364387SHung-ying Tyan { 64788364387SHung-ying Tyan struct ec_params_host_event_mask params; 64888364387SHung-ying Tyan 64988364387SHung-ying Tyan params.mask = events; 65088364387SHung-ying Tyan 65188364387SHung-ying Tyan /* 65288364387SHung-ying Tyan * Use the B copy of the event flags, so it affects the data returned 65388364387SHung-ying Tyan * by cros_ec_get_host_events(). 65488364387SHung-ying Tyan */ 65588364387SHung-ying Tyan if (ec_command_inptr(dev, EC_CMD_HOST_EVENT_CLEAR_B, 0, 65688364387SHung-ying Tyan ¶ms, sizeof(params), NULL, 0) < 0) 65788364387SHung-ying Tyan return -1; 65888364387SHung-ying Tyan 65988364387SHung-ying Tyan return 0; 66088364387SHung-ying Tyan } 66188364387SHung-ying Tyan 66288364387SHung-ying Tyan int cros_ec_flash_protect(struct cros_ec_dev *dev, 66388364387SHung-ying Tyan uint32_t set_mask, uint32_t set_flags, 66488364387SHung-ying Tyan struct ec_response_flash_protect *resp) 66588364387SHung-ying Tyan { 66688364387SHung-ying Tyan struct ec_params_flash_protect params; 66788364387SHung-ying Tyan 66888364387SHung-ying Tyan params.mask = set_mask; 66988364387SHung-ying Tyan params.flags = set_flags; 67088364387SHung-ying Tyan 67188364387SHung-ying Tyan if (ec_command(dev, EC_CMD_FLASH_PROTECT, EC_VER_FLASH_PROTECT, 67288364387SHung-ying Tyan ¶ms, sizeof(params), 6732ab83f0dSSimon Glass resp, sizeof(*resp)) != sizeof(*resp)) 67488364387SHung-ying Tyan return -1; 67588364387SHung-ying Tyan 67688364387SHung-ying Tyan return 0; 67788364387SHung-ying Tyan } 67888364387SHung-ying Tyan 67988364387SHung-ying Tyan static int cros_ec_check_version(struct cros_ec_dev *dev) 68088364387SHung-ying Tyan { 68188364387SHung-ying Tyan struct ec_params_hello req; 68288364387SHung-ying Tyan struct ec_response_hello *resp; 68388364387SHung-ying Tyan 68472a38e06SSimon Glass #ifdef CONFIG_DM_CROS_EC 68572a38e06SSimon Glass struct dm_cros_ec_ops *ops; 68672a38e06SSimon Glass int ret; 68772a38e06SSimon Glass 68872a38e06SSimon Glass ops = dm_cros_ec_get_ops(dev->dev); 68972a38e06SSimon Glass if (ops->check_version) { 69072a38e06SSimon Glass ret = ops->check_version(dev->dev); 69172a38e06SSimon Glass if (ret) 69272a38e06SSimon Glass return ret; 69372a38e06SSimon Glass } 69472a38e06SSimon Glass #else 69588364387SHung-ying Tyan #ifdef CONFIG_CROS_EC_LPC 69688364387SHung-ying Tyan /* LPC has its own way of doing this */ 69788364387SHung-ying Tyan if (dev->interface == CROS_EC_IF_LPC) 69888364387SHung-ying Tyan return cros_ec_lpc_check_version(dev); 69988364387SHung-ying Tyan #endif 70072a38e06SSimon Glass #endif 70188364387SHung-ying Tyan 70288364387SHung-ying Tyan /* 70388364387SHung-ying Tyan * TODO(sjg@chromium.org). 70488364387SHung-ying Tyan * There is a strange oddity here with the EC. We could just ignore 70588364387SHung-ying Tyan * the response, i.e. pass the last two parameters as NULL and 0. 70688364387SHung-ying Tyan * In this case we won't read back very many bytes from the EC. 70788364387SHung-ying Tyan * On the I2C bus the EC gets upset about this and will try to send 70888364387SHung-ying Tyan * the bytes anyway. This means that we will have to wait for that 70988364387SHung-ying Tyan * to complete before continuing with a new EC command. 71088364387SHung-ying Tyan * 71188364387SHung-ying Tyan * This problem is probably unique to the I2C bus. 71288364387SHung-ying Tyan * 71388364387SHung-ying Tyan * So for now, just read all the data anyway. 71488364387SHung-ying Tyan */ 715e8c12662SRandall Spangler 716a6070283SRandall Spangler /* Try sending a version 3 packet */ 717a6070283SRandall Spangler dev->protocol_version = 3; 718d11e8fd8SSimon Glass req.in_data = 0; 719a6070283SRandall Spangler if (ec_command_inptr(dev, EC_CMD_HELLO, 0, &req, sizeof(req), 720a6070283SRandall Spangler (uint8_t **)&resp, sizeof(*resp)) > 0) { 721a6070283SRandall Spangler return 0; 722a6070283SRandall Spangler } 723a6070283SRandall Spangler 724e8c12662SRandall Spangler /* Try sending a version 2 packet */ 725e8c12662SRandall Spangler dev->protocol_version = 2; 72688364387SHung-ying Tyan if (ec_command_inptr(dev, EC_CMD_HELLO, 0, &req, sizeof(req), 72788364387SHung-ying Tyan (uint8_t **)&resp, sizeof(*resp)) > 0) { 728e8c12662SRandall Spangler return 0; 72988364387SHung-ying Tyan } 73088364387SHung-ying Tyan 731e8c12662SRandall Spangler /* 732e8c12662SRandall Spangler * Fail if we're still here, since the EC doesn't understand any 733e8c12662SRandall Spangler * protcol version we speak. Version 1 interface without command 734e8c12662SRandall Spangler * version is no longer supported, and we don't know about any new 735e8c12662SRandall Spangler * protocol versions. 736e8c12662SRandall Spangler */ 737e8c12662SRandall Spangler dev->protocol_version = 0; 738e8c12662SRandall Spangler printf("%s: ERROR: old EC interface not supported\n", __func__); 739e8c12662SRandall Spangler return -1; 74088364387SHung-ying Tyan } 74188364387SHung-ying Tyan 74288364387SHung-ying Tyan int cros_ec_test(struct cros_ec_dev *dev) 74388364387SHung-ying Tyan { 74488364387SHung-ying Tyan struct ec_params_hello req; 74588364387SHung-ying Tyan struct ec_response_hello *resp; 74688364387SHung-ying Tyan 74788364387SHung-ying Tyan req.in_data = 0x12345678; 74888364387SHung-ying Tyan if (ec_command_inptr(dev, EC_CMD_HELLO, 0, &req, sizeof(req), 74988364387SHung-ying Tyan (uint8_t **)&resp, sizeof(*resp)) < sizeof(*resp)) { 75088364387SHung-ying Tyan printf("ec_command_inptr() returned error\n"); 75188364387SHung-ying Tyan return -1; 75288364387SHung-ying Tyan } 75388364387SHung-ying Tyan if (resp->out_data != req.in_data + 0x01020304) { 75488364387SHung-ying Tyan printf("Received invalid handshake %x\n", resp->out_data); 75588364387SHung-ying Tyan return -1; 75688364387SHung-ying Tyan } 75788364387SHung-ying Tyan 75888364387SHung-ying Tyan return 0; 75988364387SHung-ying Tyan } 76088364387SHung-ying Tyan 76188364387SHung-ying Tyan int cros_ec_flash_offset(struct cros_ec_dev *dev, enum ec_flash_region region, 76288364387SHung-ying Tyan uint32_t *offset, uint32_t *size) 76388364387SHung-ying Tyan { 76488364387SHung-ying Tyan struct ec_params_flash_region_info p; 76588364387SHung-ying Tyan struct ec_response_flash_region_info *r; 76688364387SHung-ying Tyan int ret; 76788364387SHung-ying Tyan 76888364387SHung-ying Tyan p.region = region; 76988364387SHung-ying Tyan ret = ec_command_inptr(dev, EC_CMD_FLASH_REGION_INFO, 77088364387SHung-ying Tyan EC_VER_FLASH_REGION_INFO, 77188364387SHung-ying Tyan &p, sizeof(p), (uint8_t **)&r, sizeof(*r)); 77288364387SHung-ying Tyan if (ret != sizeof(*r)) 77388364387SHung-ying Tyan return -1; 77488364387SHung-ying Tyan 77588364387SHung-ying Tyan if (offset) 77688364387SHung-ying Tyan *offset = r->offset; 77788364387SHung-ying Tyan if (size) 77888364387SHung-ying Tyan *size = r->size; 77988364387SHung-ying Tyan 78088364387SHung-ying Tyan return 0; 78188364387SHung-ying Tyan } 78288364387SHung-ying Tyan 78388364387SHung-ying Tyan int cros_ec_flash_erase(struct cros_ec_dev *dev, uint32_t offset, uint32_t size) 78488364387SHung-ying Tyan { 78588364387SHung-ying Tyan struct ec_params_flash_erase p; 78688364387SHung-ying Tyan 78788364387SHung-ying Tyan p.offset = offset; 78888364387SHung-ying Tyan p.size = size; 78988364387SHung-ying Tyan return ec_command_inptr(dev, EC_CMD_FLASH_ERASE, 0, &p, sizeof(p), 79088364387SHung-ying Tyan NULL, 0); 79188364387SHung-ying Tyan } 79288364387SHung-ying Tyan 79388364387SHung-ying Tyan /** 79488364387SHung-ying Tyan * Write a single block to the flash 79588364387SHung-ying Tyan * 79688364387SHung-ying Tyan * Write a block of data to the EC flash. The size must not exceed the flash 79788364387SHung-ying Tyan * write block size which you can obtain from cros_ec_flash_write_burst_size(). 79888364387SHung-ying Tyan * 79988364387SHung-ying Tyan * The offset starts at 0. You can obtain the region information from 80088364387SHung-ying Tyan * cros_ec_flash_offset() to find out where to write for a particular region. 80188364387SHung-ying Tyan * 80288364387SHung-ying Tyan * Attempting to write to the region where the EC is currently running from 80388364387SHung-ying Tyan * will result in an error. 80488364387SHung-ying Tyan * 80588364387SHung-ying Tyan * @param dev CROS-EC device 80688364387SHung-ying Tyan * @param data Pointer to data buffer to write 80788364387SHung-ying Tyan * @param offset Offset within flash to write to. 80888364387SHung-ying Tyan * @param size Number of bytes to write 80988364387SHung-ying Tyan * @return 0 if ok, -1 on error 81088364387SHung-ying Tyan */ 81188364387SHung-ying Tyan static int cros_ec_flash_write_block(struct cros_ec_dev *dev, 81288364387SHung-ying Tyan const uint8_t *data, uint32_t offset, uint32_t size) 81388364387SHung-ying Tyan { 81488364387SHung-ying Tyan struct ec_params_flash_write p; 81588364387SHung-ying Tyan 81688364387SHung-ying Tyan p.offset = offset; 81788364387SHung-ying Tyan p.size = size; 818836bb6e8SSimon Glass assert(data && p.size <= EC_FLASH_WRITE_VER0_SIZE); 819836bb6e8SSimon Glass memcpy(&p + 1, data, p.size); 82088364387SHung-ying Tyan 82188364387SHung-ying Tyan return ec_command_inptr(dev, EC_CMD_FLASH_WRITE, 0, 82288364387SHung-ying Tyan &p, sizeof(p), NULL, 0) >= 0 ? 0 : -1; 82388364387SHung-ying Tyan } 82488364387SHung-ying Tyan 82588364387SHung-ying Tyan /** 82688364387SHung-ying Tyan * Return optimal flash write burst size 82788364387SHung-ying Tyan */ 82888364387SHung-ying Tyan static int cros_ec_flash_write_burst_size(struct cros_ec_dev *dev) 82988364387SHung-ying Tyan { 830836bb6e8SSimon Glass return EC_FLASH_WRITE_VER0_SIZE; 83188364387SHung-ying Tyan } 83288364387SHung-ying Tyan 83388364387SHung-ying Tyan /** 83488364387SHung-ying Tyan * Check if a block of data is erased (all 0xff) 83588364387SHung-ying Tyan * 83688364387SHung-ying Tyan * This function is useful when dealing with flash, for checking whether a 83788364387SHung-ying Tyan * data block is erased and thus does not need to be programmed. 83888364387SHung-ying Tyan * 83988364387SHung-ying Tyan * @param data Pointer to data to check (must be word-aligned) 84088364387SHung-ying Tyan * @param size Number of bytes to check (must be word-aligned) 84188364387SHung-ying Tyan * @return 0 if erased, non-zero if any word is not erased 84288364387SHung-ying Tyan */ 84388364387SHung-ying Tyan static int cros_ec_data_is_erased(const uint32_t *data, int size) 84488364387SHung-ying Tyan { 84588364387SHung-ying Tyan assert(!(size & 3)); 84688364387SHung-ying Tyan size /= sizeof(uint32_t); 84788364387SHung-ying Tyan for (; size > 0; size -= 4, data++) 84888364387SHung-ying Tyan if (*data != -1U) 84988364387SHung-ying Tyan return 0; 85088364387SHung-ying Tyan 85188364387SHung-ying Tyan return 1; 85288364387SHung-ying Tyan } 85388364387SHung-ying Tyan 85488364387SHung-ying Tyan int cros_ec_flash_write(struct cros_ec_dev *dev, const uint8_t *data, 85588364387SHung-ying Tyan uint32_t offset, uint32_t size) 85688364387SHung-ying Tyan { 85788364387SHung-ying Tyan uint32_t burst = cros_ec_flash_write_burst_size(dev); 85888364387SHung-ying Tyan uint32_t end, off; 85988364387SHung-ying Tyan int ret; 86088364387SHung-ying Tyan 86188364387SHung-ying Tyan /* 86288364387SHung-ying Tyan * TODO: round up to the nearest multiple of write size. Can get away 86388364387SHung-ying Tyan * without that on link right now because its write size is 4 bytes. 86488364387SHung-ying Tyan */ 86588364387SHung-ying Tyan end = offset + size; 86688364387SHung-ying Tyan for (off = offset; off < end; off += burst, data += burst) { 86788364387SHung-ying Tyan uint32_t todo; 86888364387SHung-ying Tyan 86988364387SHung-ying Tyan /* If the data is empty, there is no point in programming it */ 87088364387SHung-ying Tyan todo = min(end - off, burst); 87188364387SHung-ying Tyan if (dev->optimise_flash_write && 87288364387SHung-ying Tyan cros_ec_data_is_erased((uint32_t *)data, todo)) 87388364387SHung-ying Tyan continue; 87488364387SHung-ying Tyan 87588364387SHung-ying Tyan ret = cros_ec_flash_write_block(dev, data, off, todo); 87688364387SHung-ying Tyan if (ret) 87788364387SHung-ying Tyan return ret; 87888364387SHung-ying Tyan } 87988364387SHung-ying Tyan 88088364387SHung-ying Tyan return 0; 88188364387SHung-ying Tyan } 88288364387SHung-ying Tyan 88388364387SHung-ying Tyan /** 88488364387SHung-ying Tyan * Read a single block from the flash 88588364387SHung-ying Tyan * 88688364387SHung-ying Tyan * Read a block of data from the EC flash. The size must not exceed the flash 88788364387SHung-ying Tyan * write block size which you can obtain from cros_ec_flash_write_burst_size(). 88888364387SHung-ying Tyan * 88988364387SHung-ying Tyan * The offset starts at 0. You can obtain the region information from 89088364387SHung-ying Tyan * cros_ec_flash_offset() to find out where to read for a particular region. 89188364387SHung-ying Tyan * 89288364387SHung-ying Tyan * @param dev CROS-EC device 89388364387SHung-ying Tyan * @param data Pointer to data buffer to read into 89488364387SHung-ying Tyan * @param offset Offset within flash to read from 89588364387SHung-ying Tyan * @param size Number of bytes to read 89688364387SHung-ying Tyan * @return 0 if ok, -1 on error 89788364387SHung-ying Tyan */ 89888364387SHung-ying Tyan static int cros_ec_flash_read_block(struct cros_ec_dev *dev, uint8_t *data, 89988364387SHung-ying Tyan uint32_t offset, uint32_t size) 90088364387SHung-ying Tyan { 90188364387SHung-ying Tyan struct ec_params_flash_read p; 90288364387SHung-ying Tyan 90388364387SHung-ying Tyan p.offset = offset; 90488364387SHung-ying Tyan p.size = size; 90588364387SHung-ying Tyan 90688364387SHung-ying Tyan return ec_command(dev, EC_CMD_FLASH_READ, 0, 90788364387SHung-ying Tyan &p, sizeof(p), data, size) >= 0 ? 0 : -1; 90888364387SHung-ying Tyan } 90988364387SHung-ying Tyan 91088364387SHung-ying Tyan int cros_ec_flash_read(struct cros_ec_dev *dev, uint8_t *data, uint32_t offset, 91188364387SHung-ying Tyan uint32_t size) 91288364387SHung-ying Tyan { 91388364387SHung-ying Tyan uint32_t burst = cros_ec_flash_write_burst_size(dev); 91488364387SHung-ying Tyan uint32_t end, off; 91588364387SHung-ying Tyan int ret; 91688364387SHung-ying Tyan 91788364387SHung-ying Tyan end = offset + size; 91888364387SHung-ying Tyan for (off = offset; off < end; off += burst, data += burst) { 91988364387SHung-ying Tyan ret = cros_ec_flash_read_block(dev, data, off, 92088364387SHung-ying Tyan min(end - off, burst)); 92188364387SHung-ying Tyan if (ret) 92288364387SHung-ying Tyan return ret; 92388364387SHung-ying Tyan } 92488364387SHung-ying Tyan 92588364387SHung-ying Tyan return 0; 92688364387SHung-ying Tyan } 92788364387SHung-ying Tyan 92888364387SHung-ying Tyan int cros_ec_flash_update_rw(struct cros_ec_dev *dev, 92988364387SHung-ying Tyan const uint8_t *image, int image_size) 93088364387SHung-ying Tyan { 93188364387SHung-ying Tyan uint32_t rw_offset, rw_size; 93288364387SHung-ying Tyan int ret; 93388364387SHung-ying Tyan 93488364387SHung-ying Tyan if (cros_ec_flash_offset(dev, EC_FLASH_REGION_RW, &rw_offset, &rw_size)) 93588364387SHung-ying Tyan return -1; 9362ab83f0dSSimon Glass if (image_size > (int)rw_size) 93788364387SHung-ying Tyan return -1; 93888364387SHung-ying Tyan 93988364387SHung-ying Tyan /* Invalidate the existing hash, just in case the AP reboots 94088364387SHung-ying Tyan * unexpectedly during the update. If that happened, the EC RW firmware 94188364387SHung-ying Tyan * would be invalid, but the EC would still have the original hash. 94288364387SHung-ying Tyan */ 94388364387SHung-ying Tyan ret = cros_ec_invalidate_hash(dev); 94488364387SHung-ying Tyan if (ret) 94588364387SHung-ying Tyan return ret; 94688364387SHung-ying Tyan 94788364387SHung-ying Tyan /* 94888364387SHung-ying Tyan * Erase the entire RW section, so that the EC doesn't see any garbage 94988364387SHung-ying Tyan * past the new image if it's smaller than the current image. 95088364387SHung-ying Tyan * 95188364387SHung-ying Tyan * TODO: could optimize this to erase just the current image, since 95288364387SHung-ying Tyan * presumably everything past that is 0xff's. But would still need to 95388364387SHung-ying Tyan * round up to the nearest multiple of erase size. 95488364387SHung-ying Tyan */ 95588364387SHung-ying Tyan ret = cros_ec_flash_erase(dev, rw_offset, rw_size); 95688364387SHung-ying Tyan if (ret) 95788364387SHung-ying Tyan return ret; 95888364387SHung-ying Tyan 95988364387SHung-ying Tyan /* Write the image */ 96088364387SHung-ying Tyan ret = cros_ec_flash_write(dev, image, rw_offset, image_size); 96188364387SHung-ying Tyan if (ret) 96288364387SHung-ying Tyan return ret; 96388364387SHung-ying Tyan 96488364387SHung-ying Tyan return 0; 96588364387SHung-ying Tyan } 96688364387SHung-ying Tyan 96788364387SHung-ying Tyan int cros_ec_read_vbnvcontext(struct cros_ec_dev *dev, uint8_t *block) 96888364387SHung-ying Tyan { 96988364387SHung-ying Tyan struct ec_params_vbnvcontext p; 97088364387SHung-ying Tyan int len; 97188364387SHung-ying Tyan 97288364387SHung-ying Tyan p.op = EC_VBNV_CONTEXT_OP_READ; 97388364387SHung-ying Tyan 97488364387SHung-ying Tyan len = ec_command(dev, EC_CMD_VBNV_CONTEXT, EC_VER_VBNV_CONTEXT, 97588364387SHung-ying Tyan &p, sizeof(p), block, EC_VBNV_BLOCK_SIZE); 97688364387SHung-ying Tyan if (len < EC_VBNV_BLOCK_SIZE) 97788364387SHung-ying Tyan return -1; 97888364387SHung-ying Tyan 97988364387SHung-ying Tyan return 0; 98088364387SHung-ying Tyan } 98188364387SHung-ying Tyan 98288364387SHung-ying Tyan int cros_ec_write_vbnvcontext(struct cros_ec_dev *dev, const uint8_t *block) 98388364387SHung-ying Tyan { 98488364387SHung-ying Tyan struct ec_params_vbnvcontext p; 98588364387SHung-ying Tyan int len; 98688364387SHung-ying Tyan 98788364387SHung-ying Tyan p.op = EC_VBNV_CONTEXT_OP_WRITE; 98888364387SHung-ying Tyan memcpy(p.block, block, sizeof(p.block)); 98988364387SHung-ying Tyan 99088364387SHung-ying Tyan len = ec_command_inptr(dev, EC_CMD_VBNV_CONTEXT, EC_VER_VBNV_CONTEXT, 99188364387SHung-ying Tyan &p, sizeof(p), NULL, 0); 99288364387SHung-ying Tyan if (len < 0) 99388364387SHung-ying Tyan return -1; 99488364387SHung-ying Tyan 99588364387SHung-ying Tyan return 0; 99688364387SHung-ying Tyan } 99788364387SHung-ying Tyan 99888364387SHung-ying Tyan int cros_ec_set_ldo(struct cros_ec_dev *dev, uint8_t index, uint8_t state) 99988364387SHung-ying Tyan { 100088364387SHung-ying Tyan struct ec_params_ldo_set params; 100188364387SHung-ying Tyan 100288364387SHung-ying Tyan params.index = index; 100388364387SHung-ying Tyan params.state = state; 100488364387SHung-ying Tyan 100588364387SHung-ying Tyan if (ec_command_inptr(dev, EC_CMD_LDO_SET, 0, 100688364387SHung-ying Tyan ¶ms, sizeof(params), 100788364387SHung-ying Tyan NULL, 0)) 100888364387SHung-ying Tyan return -1; 100988364387SHung-ying Tyan 101088364387SHung-ying Tyan return 0; 101188364387SHung-ying Tyan } 101288364387SHung-ying Tyan 101388364387SHung-ying Tyan int cros_ec_get_ldo(struct cros_ec_dev *dev, uint8_t index, uint8_t *state) 101488364387SHung-ying Tyan { 101588364387SHung-ying Tyan struct ec_params_ldo_get params; 101688364387SHung-ying Tyan struct ec_response_ldo_get *resp; 101788364387SHung-ying Tyan 101888364387SHung-ying Tyan params.index = index; 101988364387SHung-ying Tyan 102088364387SHung-ying Tyan if (ec_command_inptr(dev, EC_CMD_LDO_GET, 0, 102188364387SHung-ying Tyan ¶ms, sizeof(params), 10222ab83f0dSSimon Glass (uint8_t **)&resp, sizeof(*resp)) != sizeof(*resp)) 102388364387SHung-ying Tyan return -1; 102488364387SHung-ying Tyan 102588364387SHung-ying Tyan *state = resp->state; 102688364387SHung-ying Tyan 102788364387SHung-ying Tyan return 0; 102888364387SHung-ying Tyan } 102988364387SHung-ying Tyan 103084d6cbd3SSimon Glass #ifndef CONFIG_DM_CROS_EC 103188364387SHung-ying Tyan /** 1032836bb6e8SSimon Glass * Decode EC interface details from the device tree and allocate a suitable 1033836bb6e8SSimon Glass * device. 103488364387SHung-ying Tyan * 103588364387SHung-ying Tyan * @param blob Device tree blob 103688364387SHung-ying Tyan * @param node Node to decode from 103788364387SHung-ying Tyan * @param devp Returns a pointer to the new allocated device 103888364387SHung-ying Tyan * @return 0 if ok, -1 on error 103988364387SHung-ying Tyan */ 104088364387SHung-ying Tyan static int cros_ec_decode_fdt(const void *blob, int node, 104188364387SHung-ying Tyan struct cros_ec_dev **devp) 104288364387SHung-ying Tyan { 104388364387SHung-ying Tyan enum fdt_compat_id compat; 104488364387SHung-ying Tyan struct cros_ec_dev *dev; 104588364387SHung-ying Tyan int parent; 104688364387SHung-ying Tyan 104788364387SHung-ying Tyan /* See what type of parent we are inside (this is expensive) */ 104888364387SHung-ying Tyan parent = fdt_parent_offset(blob, node); 104988364387SHung-ying Tyan if (parent < 0) { 105088364387SHung-ying Tyan debug("%s: Cannot find node parent\n", __func__); 105188364387SHung-ying Tyan return -1; 105288364387SHung-ying Tyan } 105388364387SHung-ying Tyan 105488364387SHung-ying Tyan dev = &static_dev; 105588364387SHung-ying Tyan dev->node = node; 105688364387SHung-ying Tyan dev->parent_node = parent; 105788364387SHung-ying Tyan 105888364387SHung-ying Tyan compat = fdtdec_lookup(blob, parent); 105988364387SHung-ying Tyan switch (compat) { 106088364387SHung-ying Tyan #ifdef CONFIG_CROS_EC_SPI 106188364387SHung-ying Tyan case COMPAT_SAMSUNG_EXYNOS_SPI: 106288364387SHung-ying Tyan dev->interface = CROS_EC_IF_SPI; 106388364387SHung-ying Tyan if (cros_ec_spi_decode_fdt(dev, blob)) 106488364387SHung-ying Tyan return -1; 106588364387SHung-ying Tyan break; 106688364387SHung-ying Tyan #endif 106788364387SHung-ying Tyan #ifdef CONFIG_CROS_EC_I2C 106888364387SHung-ying Tyan case COMPAT_SAMSUNG_S3C2440_I2C: 106988364387SHung-ying Tyan dev->interface = CROS_EC_IF_I2C; 107088364387SHung-ying Tyan if (cros_ec_i2c_decode_fdt(dev, blob)) 107188364387SHung-ying Tyan return -1; 107288364387SHung-ying Tyan break; 107388364387SHung-ying Tyan #endif 107488364387SHung-ying Tyan #ifdef CONFIG_CROS_EC_LPC 107588364387SHung-ying Tyan case COMPAT_INTEL_LPC: 107688364387SHung-ying Tyan dev->interface = CROS_EC_IF_LPC; 107788364387SHung-ying Tyan break; 107888364387SHung-ying Tyan #endif 1079df93d90aSSimon Glass #ifdef CONFIG_CROS_EC_SANDBOX 1080df93d90aSSimon Glass case COMPAT_SANDBOX_HOST_EMULATION: 1081df93d90aSSimon Glass dev->interface = CROS_EC_IF_SANDBOX; 1082df93d90aSSimon Glass break; 1083df93d90aSSimon Glass #endif 108488364387SHung-ying Tyan default: 108588364387SHung-ying Tyan debug("%s: Unknown compat id %d\n", __func__, compat); 108688364387SHung-ying Tyan return -1; 108788364387SHung-ying Tyan } 108888364387SHung-ying Tyan 108932f8a19fSSimon Glass gpio_request_by_name_nodev(blob, node, "ec-interrupt", 0, &dev->ec_int, 109032f8a19fSSimon Glass GPIOD_IS_IN); 109188364387SHung-ying Tyan dev->optimise_flash_write = fdtdec_get_bool(blob, node, 109288364387SHung-ying Tyan "optimise-flash-write"); 109388364387SHung-ying Tyan *devp = dev; 109488364387SHung-ying Tyan 109588364387SHung-ying Tyan return 0; 109688364387SHung-ying Tyan } 109784d6cbd3SSimon Glass #endif 109888364387SHung-ying Tyan 109984d6cbd3SSimon Glass #ifdef CONFIG_DM_CROS_EC 110084d6cbd3SSimon Glass int cros_ec_register(struct udevice *dev) 110184d6cbd3SSimon Glass { 1102e564f054SSimon Glass struct cros_ec_dev *cdev = dev_get_uclass_priv(dev); 110384d6cbd3SSimon Glass const void *blob = gd->fdt_blob; 110484d6cbd3SSimon Glass int node = dev->of_offset; 110584d6cbd3SSimon Glass char id[MSG_BYTES]; 110684d6cbd3SSimon Glass 110784d6cbd3SSimon Glass cdev->dev = dev; 110832f8a19fSSimon Glass gpio_request_by_name(dev, "ec-interrupt", 0, &cdev->ec_int, 110932f8a19fSSimon Glass GPIOD_IS_IN); 111084d6cbd3SSimon Glass cdev->optimise_flash_write = fdtdec_get_bool(blob, node, 111184d6cbd3SSimon Glass "optimise-flash-write"); 111284d6cbd3SSimon Glass 111384d6cbd3SSimon Glass if (cros_ec_check_version(cdev)) { 111484d6cbd3SSimon Glass debug("%s: Could not detect CROS-EC version\n", __func__); 111584d6cbd3SSimon Glass return -CROS_EC_ERR_CHECK_VERSION; 111684d6cbd3SSimon Glass } 111784d6cbd3SSimon Glass 111884d6cbd3SSimon Glass if (cros_ec_read_id(cdev, id, sizeof(id))) { 111984d6cbd3SSimon Glass debug("%s: Could not read KBC ID\n", __func__); 112084d6cbd3SSimon Glass return -CROS_EC_ERR_READ_ID; 112184d6cbd3SSimon Glass } 112284d6cbd3SSimon Glass 112384d6cbd3SSimon Glass /* Remember this device for use by the cros_ec command */ 112484d6cbd3SSimon Glass debug("Google Chrome EC CROS-EC driver ready, id '%s'\n", id); 112584d6cbd3SSimon Glass 112684d6cbd3SSimon Glass return 0; 112784d6cbd3SSimon Glass } 112884d6cbd3SSimon Glass #else 112988364387SHung-ying Tyan int cros_ec_init(const void *blob, struct cros_ec_dev **cros_ecp) 113088364387SHung-ying Tyan { 113188364387SHung-ying Tyan struct cros_ec_dev *dev; 113284d6cbd3SSimon Glass char id[MSG_BYTES]; 113384d6cbd3SSimon Glass #ifdef CONFIG_DM_CROS_EC 113484d6cbd3SSimon Glass struct udevice *udev; 113584d6cbd3SSimon Glass int ret; 113684d6cbd3SSimon Glass 113784d6cbd3SSimon Glass ret = uclass_find_device(UCLASS_CROS_EC, 0, &udev); 113884d6cbd3SSimon Glass if (!ret) 113984d6cbd3SSimon Glass device_remove(udev); 114084d6cbd3SSimon Glass ret = uclass_get_device(UCLASS_CROS_EC, 0, &udev); 114184d6cbd3SSimon Glass if (ret) 114284d6cbd3SSimon Glass return ret; 1143e564f054SSimon Glass dev = dev_get_uclass_priv(udev); 114484d6cbd3SSimon Glass return 0; 114584d6cbd3SSimon Glass #else 114688364387SHung-ying Tyan int node = 0; 114788364387SHung-ying Tyan 114888364387SHung-ying Tyan *cros_ecp = NULL; 114988364387SHung-ying Tyan do { 115088364387SHung-ying Tyan node = fdtdec_next_compatible(blob, node, 115188364387SHung-ying Tyan COMPAT_GOOGLE_CROS_EC); 115288364387SHung-ying Tyan if (node < 0) { 115388364387SHung-ying Tyan debug("%s: Node not found\n", __func__); 115488364387SHung-ying Tyan return 0; 115588364387SHung-ying Tyan } 115688364387SHung-ying Tyan } while (!fdtdec_get_is_enabled(blob, node)); 115788364387SHung-ying Tyan 115888364387SHung-ying Tyan if (cros_ec_decode_fdt(blob, node, &dev)) { 115988364387SHung-ying Tyan debug("%s: Failed to decode device.\n", __func__); 116088364387SHung-ying Tyan return -CROS_EC_ERR_FDT_DECODE; 116188364387SHung-ying Tyan } 116288364387SHung-ying Tyan 116388364387SHung-ying Tyan switch (dev->interface) { 116488364387SHung-ying Tyan #ifdef CONFIG_CROS_EC_SPI 116588364387SHung-ying Tyan case CROS_EC_IF_SPI: 116688364387SHung-ying Tyan if (cros_ec_spi_init(dev, blob)) { 116788364387SHung-ying Tyan debug("%s: Could not setup SPI interface\n", __func__); 116888364387SHung-ying Tyan return -CROS_EC_ERR_DEV_INIT; 116988364387SHung-ying Tyan } 117088364387SHung-ying Tyan break; 117188364387SHung-ying Tyan #endif 117288364387SHung-ying Tyan #ifdef CONFIG_CROS_EC_I2C 117388364387SHung-ying Tyan case CROS_EC_IF_I2C: 117488364387SHung-ying Tyan if (cros_ec_i2c_init(dev, blob)) 117588364387SHung-ying Tyan return -CROS_EC_ERR_DEV_INIT; 117688364387SHung-ying Tyan break; 117788364387SHung-ying Tyan #endif 117888364387SHung-ying Tyan #ifdef CONFIG_CROS_EC_LPC 117988364387SHung-ying Tyan case CROS_EC_IF_LPC: 118088364387SHung-ying Tyan if (cros_ec_lpc_init(dev, blob)) 118188364387SHung-ying Tyan return -CROS_EC_ERR_DEV_INIT; 118288364387SHung-ying Tyan break; 118388364387SHung-ying Tyan #endif 1184df93d90aSSimon Glass #ifdef CONFIG_CROS_EC_SANDBOX 1185df93d90aSSimon Glass case CROS_EC_IF_SANDBOX: 1186df93d90aSSimon Glass if (cros_ec_sandbox_init(dev, blob)) 1187df93d90aSSimon Glass return -CROS_EC_ERR_DEV_INIT; 1188df93d90aSSimon Glass break; 1189df93d90aSSimon Glass #endif 119088364387SHung-ying Tyan case CROS_EC_IF_NONE: 119188364387SHung-ying Tyan default: 119288364387SHung-ying Tyan return 0; 119388364387SHung-ying Tyan } 119484d6cbd3SSimon Glass #endif 119588364387SHung-ying Tyan 119688364387SHung-ying Tyan if (cros_ec_check_version(dev)) { 119788364387SHung-ying Tyan debug("%s: Could not detect CROS-EC version\n", __func__); 119888364387SHung-ying Tyan return -CROS_EC_ERR_CHECK_VERSION; 119988364387SHung-ying Tyan } 120088364387SHung-ying Tyan 120188364387SHung-ying Tyan if (cros_ec_read_id(dev, id, sizeof(id))) { 120288364387SHung-ying Tyan debug("%s: Could not read KBC ID\n", __func__); 120388364387SHung-ying Tyan return -CROS_EC_ERR_READ_ID; 120488364387SHung-ying Tyan } 120588364387SHung-ying Tyan 120688364387SHung-ying Tyan /* Remember this device for use by the cros_ec command */ 120784d6cbd3SSimon Glass *cros_ecp = dev; 120884d6cbd3SSimon Glass #ifndef CONFIG_DM_CROS_EC 120984d6cbd3SSimon Glass last_dev = dev; 121084d6cbd3SSimon Glass #endif 121188364387SHung-ying Tyan debug("Google Chrome EC CROS-EC driver ready, id '%s'\n", id); 121288364387SHung-ying Tyan 121388364387SHung-ying Tyan return 0; 121488364387SHung-ying Tyan } 121584d6cbd3SSimon Glass #endif 121688364387SHung-ying Tyan 121788364387SHung-ying Tyan int cros_ec_decode_region(int argc, char * const argv[]) 121888364387SHung-ying Tyan { 121988364387SHung-ying Tyan if (argc > 0) { 122088364387SHung-ying Tyan if (0 == strcmp(*argv, "rw")) 122188364387SHung-ying Tyan return EC_FLASH_REGION_RW; 122288364387SHung-ying Tyan else if (0 == strcmp(*argv, "ro")) 122388364387SHung-ying Tyan return EC_FLASH_REGION_RO; 122488364387SHung-ying Tyan 122588364387SHung-ying Tyan debug("%s: Invalid region '%s'\n", __func__, *argv); 122688364387SHung-ying Tyan } else { 122788364387SHung-ying Tyan debug("%s: Missing region parameter\n", __func__); 122888364387SHung-ying Tyan } 122988364387SHung-ying Tyan 123088364387SHung-ying Tyan return -1; 123188364387SHung-ying Tyan } 123288364387SHung-ying Tyan 123384d6cbd3SSimon Glass int cros_ec_decode_ec_flash(const void *blob, int node, 123484d6cbd3SSimon Glass struct fdt_cros_ec *config) 1235d7f25f35SSimon Glass { 123684d6cbd3SSimon Glass int flash_node; 1237d7f25f35SSimon Glass 1238d7f25f35SSimon Glass flash_node = fdt_subnode_offset(blob, node, "flash"); 1239d7f25f35SSimon Glass if (flash_node < 0) { 1240d7f25f35SSimon Glass debug("Failed to find flash node\n"); 1241d7f25f35SSimon Glass return -1; 1242d7f25f35SSimon Glass } 1243d7f25f35SSimon Glass 1244d7f25f35SSimon Glass if (fdtdec_read_fmap_entry(blob, flash_node, "flash", 1245d7f25f35SSimon Glass &config->flash)) { 1246d7f25f35SSimon Glass debug("Failed to decode flash node in chrome-ec'\n"); 1247d7f25f35SSimon Glass return -1; 1248d7f25f35SSimon Glass } 1249d7f25f35SSimon Glass 1250d7f25f35SSimon Glass config->flash_erase_value = fdtdec_get_int(blob, flash_node, 1251d7f25f35SSimon Glass "erase-value", -1); 1252d7f25f35SSimon Glass for (node = fdt_first_subnode(blob, flash_node); node >= 0; 1253d7f25f35SSimon Glass node = fdt_next_subnode(blob, node)) { 1254d7f25f35SSimon Glass const char *name = fdt_get_name(blob, node, NULL); 1255d7f25f35SSimon Glass enum ec_flash_region region; 1256d7f25f35SSimon Glass 1257d7f25f35SSimon Glass if (0 == strcmp(name, "ro")) { 1258d7f25f35SSimon Glass region = EC_FLASH_REGION_RO; 1259d7f25f35SSimon Glass } else if (0 == strcmp(name, "rw")) { 1260d7f25f35SSimon Glass region = EC_FLASH_REGION_RW; 1261d7f25f35SSimon Glass } else if (0 == strcmp(name, "wp-ro")) { 1262d7f25f35SSimon Glass region = EC_FLASH_REGION_WP_RO; 1263d7f25f35SSimon Glass } else { 1264d7f25f35SSimon Glass debug("Unknown EC flash region name '%s'\n", name); 1265d7f25f35SSimon Glass return -1; 1266d7f25f35SSimon Glass } 1267d7f25f35SSimon Glass 1268d7f25f35SSimon Glass if (fdtdec_read_fmap_entry(blob, node, "reg", 1269d7f25f35SSimon Glass &config->region[region])) { 1270d7f25f35SSimon Glass debug("Failed to decode flash region in chrome-ec'\n"); 1271d7f25f35SSimon Glass return -1; 1272d7f25f35SSimon Glass } 1273d7f25f35SSimon Glass } 1274d7f25f35SSimon Glass 1275d7f25f35SSimon Glass return 0; 1276d7f25f35SSimon Glass } 1277d7f25f35SSimon Glass 1278b2a668b5SSimon Glass int cros_ec_i2c_xfer(struct cros_ec_dev *dev, uchar chip, uint addr, 1279b2a668b5SSimon Glass int alen, uchar *buffer, int len, int is_read) 1280b2a668b5SSimon Glass { 1281b2a668b5SSimon Glass union { 1282b2a668b5SSimon Glass struct ec_params_i2c_passthru p; 1283b2a668b5SSimon Glass uint8_t outbuf[EC_PROTO2_MAX_PARAM_SIZE]; 1284b2a668b5SSimon Glass } params; 1285b2a668b5SSimon Glass union { 1286b2a668b5SSimon Glass struct ec_response_i2c_passthru r; 1287b2a668b5SSimon Glass uint8_t inbuf[EC_PROTO2_MAX_PARAM_SIZE]; 1288b2a668b5SSimon Glass } response; 1289b2a668b5SSimon Glass struct ec_params_i2c_passthru *p = ¶ms.p; 1290b2a668b5SSimon Glass struct ec_response_i2c_passthru *r = &response.r; 1291b2a668b5SSimon Glass struct ec_params_i2c_passthru_msg *msg = p->msg; 1292b2a668b5SSimon Glass uint8_t *pdata; 1293b2a668b5SSimon Glass int read_len, write_len; 1294b2a668b5SSimon Glass int size; 1295b2a668b5SSimon Glass int rv; 1296b2a668b5SSimon Glass 1297b2a668b5SSimon Glass p->port = 0; 1298b2a668b5SSimon Glass 1299b2a668b5SSimon Glass if (alen != 1) { 1300b2a668b5SSimon Glass printf("Unsupported address length %d\n", alen); 1301b2a668b5SSimon Glass return -1; 1302b2a668b5SSimon Glass } 1303b2a668b5SSimon Glass if (is_read) { 1304b2a668b5SSimon Glass read_len = len; 1305b2a668b5SSimon Glass write_len = alen; 1306b2a668b5SSimon Glass p->num_msgs = 2; 1307b2a668b5SSimon Glass } else { 1308b2a668b5SSimon Glass read_len = 0; 1309b2a668b5SSimon Glass write_len = alen + len; 1310b2a668b5SSimon Glass p->num_msgs = 1; 1311b2a668b5SSimon Glass } 1312b2a668b5SSimon Glass 1313b2a668b5SSimon Glass size = sizeof(*p) + p->num_msgs * sizeof(*msg); 1314b2a668b5SSimon Glass if (size + write_len > sizeof(params)) { 1315b2a668b5SSimon Glass puts("Params too large for buffer\n"); 1316b2a668b5SSimon Glass return -1; 1317b2a668b5SSimon Glass } 1318b2a668b5SSimon Glass if (sizeof(*r) + read_len > sizeof(response)) { 1319b2a668b5SSimon Glass puts("Read length too big for buffer\n"); 1320b2a668b5SSimon Glass return -1; 1321b2a668b5SSimon Glass } 1322b2a668b5SSimon Glass 1323b2a668b5SSimon Glass /* Create a message to write the register address and optional data */ 1324b2a668b5SSimon Glass pdata = (uint8_t *)p + size; 1325b2a668b5SSimon Glass msg->addr_flags = chip; 1326b2a668b5SSimon Glass msg->len = write_len; 1327b2a668b5SSimon Glass pdata[0] = addr; 1328b2a668b5SSimon Glass if (!is_read) 1329b2a668b5SSimon Glass memcpy(pdata + 1, buffer, len); 1330b2a668b5SSimon Glass msg++; 1331b2a668b5SSimon Glass 1332b2a668b5SSimon Glass if (read_len) { 1333b2a668b5SSimon Glass msg->addr_flags = chip | EC_I2C_FLAG_READ; 1334b2a668b5SSimon Glass msg->len = read_len; 1335b2a668b5SSimon Glass } 1336b2a668b5SSimon Glass 1337b2a668b5SSimon Glass rv = ec_command(dev, EC_CMD_I2C_PASSTHRU, 0, p, size + write_len, 1338b2a668b5SSimon Glass r, sizeof(*r) + read_len); 1339b2a668b5SSimon Glass if (rv < 0) 1340b2a668b5SSimon Glass return rv; 1341b2a668b5SSimon Glass 1342b2a668b5SSimon Glass /* Parse response */ 1343b2a668b5SSimon Glass if (r->i2c_status & EC_I2C_STATUS_ERROR) { 1344b2a668b5SSimon Glass printf("Transfer failed with status=0x%x\n", r->i2c_status); 1345b2a668b5SSimon Glass return -1; 1346b2a668b5SSimon Glass } 1347b2a668b5SSimon Glass 1348b2a668b5SSimon Glass if (rv < sizeof(*r) + read_len) { 1349b2a668b5SSimon Glass puts("Truncated read response\n"); 1350b2a668b5SSimon Glass return -1; 1351b2a668b5SSimon Glass } 1352b2a668b5SSimon Glass 1353b2a668b5SSimon Glass if (read_len) 1354b2a668b5SSimon Glass memcpy(buffer, r->data, read_len); 1355b2a668b5SSimon Glass 1356b2a668b5SSimon Glass return 0; 1357b2a668b5SSimon Glass } 1358b2a668b5SSimon Glass 13591c266b92SSimon Glass #ifdef CONFIG_CMD_CROS_EC 13601c266b92SSimon Glass 136188364387SHung-ying Tyan /** 136288364387SHung-ying Tyan * Perform a flash read or write command 136388364387SHung-ying Tyan * 136488364387SHung-ying Tyan * @param dev CROS-EC device to read/write 136588364387SHung-ying Tyan * @param is_write 1 do to a write, 0 to do a read 136688364387SHung-ying Tyan * @param argc Number of arguments 136788364387SHung-ying Tyan * @param argv Arguments (2 is region, 3 is address) 136888364387SHung-ying Tyan * @return 0 for ok, 1 for a usage error or -ve for ec command error 136988364387SHung-ying Tyan * (negative EC_RES_...) 137088364387SHung-ying Tyan */ 137188364387SHung-ying Tyan static int do_read_write(struct cros_ec_dev *dev, int is_write, int argc, 137288364387SHung-ying Tyan char * const argv[]) 137388364387SHung-ying Tyan { 137488364387SHung-ying Tyan uint32_t offset, size = -1U, region_size; 137588364387SHung-ying Tyan unsigned long addr; 137688364387SHung-ying Tyan char *endp; 137788364387SHung-ying Tyan int region; 137888364387SHung-ying Tyan int ret; 137988364387SHung-ying Tyan 138088364387SHung-ying Tyan region = cros_ec_decode_region(argc - 2, argv + 2); 138188364387SHung-ying Tyan if (region == -1) 138288364387SHung-ying Tyan return 1; 138388364387SHung-ying Tyan if (argc < 4) 138488364387SHung-ying Tyan return 1; 138588364387SHung-ying Tyan addr = simple_strtoul(argv[3], &endp, 16); 138688364387SHung-ying Tyan if (*argv[3] == 0 || *endp != 0) 138788364387SHung-ying Tyan return 1; 138888364387SHung-ying Tyan if (argc > 4) { 138988364387SHung-ying Tyan size = simple_strtoul(argv[4], &endp, 16); 139088364387SHung-ying Tyan if (*argv[4] == 0 || *endp != 0) 139188364387SHung-ying Tyan return 1; 139288364387SHung-ying Tyan } 139388364387SHung-ying Tyan 139488364387SHung-ying Tyan ret = cros_ec_flash_offset(dev, region, &offset, ®ion_size); 139588364387SHung-ying Tyan if (ret) { 139688364387SHung-ying Tyan debug("%s: Could not read region info\n", __func__); 139788364387SHung-ying Tyan return ret; 139888364387SHung-ying Tyan } 139988364387SHung-ying Tyan if (size == -1U) 140088364387SHung-ying Tyan size = region_size; 140188364387SHung-ying Tyan 140288364387SHung-ying Tyan ret = is_write ? 140388364387SHung-ying Tyan cros_ec_flash_write(dev, (uint8_t *)addr, offset, size) : 140488364387SHung-ying Tyan cros_ec_flash_read(dev, (uint8_t *)addr, offset, size); 140588364387SHung-ying Tyan if (ret) { 140688364387SHung-ying Tyan debug("%s: Could not %s region\n", __func__, 140788364387SHung-ying Tyan is_write ? "write" : "read"); 140888364387SHung-ying Tyan return ret; 140988364387SHung-ying Tyan } 141088364387SHung-ying Tyan 141188364387SHung-ying Tyan return 0; 141288364387SHung-ying Tyan } 141388364387SHung-ying Tyan 1414b2a668b5SSimon Glass /** 1415b2a668b5SSimon Glass * get_alen() - Small parser helper function to get address length 1416b2a668b5SSimon Glass * 1417b2a668b5SSimon Glass * Returns the address length. 1418b2a668b5SSimon Glass */ 1419b2a668b5SSimon Glass static uint get_alen(char *arg) 1420b2a668b5SSimon Glass { 1421b2a668b5SSimon Glass int j; 1422b2a668b5SSimon Glass int alen; 1423b2a668b5SSimon Glass 1424b2a668b5SSimon Glass alen = 1; 1425b2a668b5SSimon Glass for (j = 0; j < 8; j++) { 1426b2a668b5SSimon Glass if (arg[j] == '.') { 1427b2a668b5SSimon Glass alen = arg[j+1] - '0'; 1428b2a668b5SSimon Glass break; 1429b2a668b5SSimon Glass } else if (arg[j] == '\0') { 1430b2a668b5SSimon Glass break; 1431b2a668b5SSimon Glass } 1432b2a668b5SSimon Glass } 1433b2a668b5SSimon Glass return alen; 1434b2a668b5SSimon Glass } 1435b2a668b5SSimon Glass 1436b2a668b5SSimon Glass #define DISP_LINE_LEN 16 1437b2a668b5SSimon Glass 1438b2a668b5SSimon Glass /* 1439b2a668b5SSimon Glass * TODO(sjg@chromium.org): This code copied almost verbatim from cmd_i2c.c 1440b2a668b5SSimon Glass * so we can remove it later. 1441b2a668b5SSimon Glass */ 1442b2a668b5SSimon Glass static int cros_ec_i2c_md(struct cros_ec_dev *dev, int flag, int argc, 1443b2a668b5SSimon Glass char * const argv[]) 1444b2a668b5SSimon Glass { 1445b2a668b5SSimon Glass u_char chip; 1446b2a668b5SSimon Glass uint addr, alen, length = 0x10; 1447b2a668b5SSimon Glass int j, nbytes, linebytes; 1448b2a668b5SSimon Glass 1449b2a668b5SSimon Glass if (argc < 2) 1450b2a668b5SSimon Glass return CMD_RET_USAGE; 1451b2a668b5SSimon Glass 1452b2a668b5SSimon Glass if (1 || (flag & CMD_FLAG_REPEAT) == 0) { 1453b2a668b5SSimon Glass /* 1454b2a668b5SSimon Glass * New command specified. 1455b2a668b5SSimon Glass */ 1456b2a668b5SSimon Glass 1457b2a668b5SSimon Glass /* 1458b2a668b5SSimon Glass * I2C chip address 1459b2a668b5SSimon Glass */ 1460b2a668b5SSimon Glass chip = simple_strtoul(argv[0], NULL, 16); 1461b2a668b5SSimon Glass 1462b2a668b5SSimon Glass /* 1463b2a668b5SSimon Glass * I2C data address within the chip. This can be 1 or 1464b2a668b5SSimon Glass * 2 bytes long. Some day it might be 3 bytes long :-). 1465b2a668b5SSimon Glass */ 1466b2a668b5SSimon Glass addr = simple_strtoul(argv[1], NULL, 16); 1467b2a668b5SSimon Glass alen = get_alen(argv[1]); 1468b2a668b5SSimon Glass if (alen > 3) 1469b2a668b5SSimon Glass return CMD_RET_USAGE; 1470b2a668b5SSimon Glass 1471b2a668b5SSimon Glass /* 1472b2a668b5SSimon Glass * If another parameter, it is the length to display. 1473b2a668b5SSimon Glass * Length is the number of objects, not number of bytes. 1474b2a668b5SSimon Glass */ 1475b2a668b5SSimon Glass if (argc > 2) 1476b2a668b5SSimon Glass length = simple_strtoul(argv[2], NULL, 16); 1477b2a668b5SSimon Glass } 1478b2a668b5SSimon Glass 1479b2a668b5SSimon Glass /* 1480b2a668b5SSimon Glass * Print the lines. 1481b2a668b5SSimon Glass * 1482b2a668b5SSimon Glass * We buffer all read data, so we can make sure data is read only 1483b2a668b5SSimon Glass * once. 1484b2a668b5SSimon Glass */ 1485b2a668b5SSimon Glass nbytes = length; 1486b2a668b5SSimon Glass do { 1487b2a668b5SSimon Glass unsigned char linebuf[DISP_LINE_LEN]; 1488b2a668b5SSimon Glass unsigned char *cp; 1489b2a668b5SSimon Glass 1490b2a668b5SSimon Glass linebytes = (nbytes > DISP_LINE_LEN) ? DISP_LINE_LEN : nbytes; 1491b2a668b5SSimon Glass 1492b2a668b5SSimon Glass if (cros_ec_i2c_xfer(dev, chip, addr, alen, linebuf, linebytes, 1493b2a668b5SSimon Glass 1)) 1494b2a668b5SSimon Glass puts("Error reading the chip.\n"); 1495b2a668b5SSimon Glass else { 1496b2a668b5SSimon Glass printf("%04x:", addr); 1497b2a668b5SSimon Glass cp = linebuf; 1498b2a668b5SSimon Glass for (j = 0; j < linebytes; j++) { 1499b2a668b5SSimon Glass printf(" %02x", *cp++); 1500b2a668b5SSimon Glass addr++; 1501b2a668b5SSimon Glass } 1502b2a668b5SSimon Glass puts(" "); 1503b2a668b5SSimon Glass cp = linebuf; 1504b2a668b5SSimon Glass for (j = 0; j < linebytes; j++) { 1505b2a668b5SSimon Glass if ((*cp < 0x20) || (*cp > 0x7e)) 1506b2a668b5SSimon Glass puts("."); 1507b2a668b5SSimon Glass else 1508b2a668b5SSimon Glass printf("%c", *cp); 1509b2a668b5SSimon Glass cp++; 1510b2a668b5SSimon Glass } 1511b2a668b5SSimon Glass putc('\n'); 1512b2a668b5SSimon Glass } 1513b2a668b5SSimon Glass nbytes -= linebytes; 1514b2a668b5SSimon Glass } while (nbytes > 0); 1515b2a668b5SSimon Glass 1516b2a668b5SSimon Glass return 0; 1517b2a668b5SSimon Glass } 1518b2a668b5SSimon Glass 1519b2a668b5SSimon Glass static int cros_ec_i2c_mw(struct cros_ec_dev *dev, int flag, int argc, 1520b2a668b5SSimon Glass char * const argv[]) 1521b2a668b5SSimon Glass { 1522b2a668b5SSimon Glass uchar chip; 1523b2a668b5SSimon Glass ulong addr; 1524b2a668b5SSimon Glass uint alen; 1525b2a668b5SSimon Glass uchar byte; 1526b2a668b5SSimon Glass int count; 1527b2a668b5SSimon Glass 1528b2a668b5SSimon Glass if ((argc < 3) || (argc > 4)) 1529b2a668b5SSimon Glass return CMD_RET_USAGE; 1530b2a668b5SSimon Glass 1531b2a668b5SSimon Glass /* 1532b2a668b5SSimon Glass * Chip is always specified. 1533b2a668b5SSimon Glass */ 1534b2a668b5SSimon Glass chip = simple_strtoul(argv[0], NULL, 16); 1535b2a668b5SSimon Glass 1536b2a668b5SSimon Glass /* 1537b2a668b5SSimon Glass * Address is always specified. 1538b2a668b5SSimon Glass */ 1539b2a668b5SSimon Glass addr = simple_strtoul(argv[1], NULL, 16); 1540b2a668b5SSimon Glass alen = get_alen(argv[1]); 1541b2a668b5SSimon Glass if (alen > 3) 1542b2a668b5SSimon Glass return CMD_RET_USAGE; 1543b2a668b5SSimon Glass 1544b2a668b5SSimon Glass /* 1545b2a668b5SSimon Glass * Value to write is always specified. 1546b2a668b5SSimon Glass */ 1547b2a668b5SSimon Glass byte = simple_strtoul(argv[2], NULL, 16); 1548b2a668b5SSimon Glass 1549b2a668b5SSimon Glass /* 1550b2a668b5SSimon Glass * Optional count 1551b2a668b5SSimon Glass */ 1552b2a668b5SSimon Glass if (argc == 4) 1553b2a668b5SSimon Glass count = simple_strtoul(argv[3], NULL, 16); 1554b2a668b5SSimon Glass else 1555b2a668b5SSimon Glass count = 1; 1556b2a668b5SSimon Glass 1557b2a668b5SSimon Glass while (count-- > 0) { 1558b2a668b5SSimon Glass if (cros_ec_i2c_xfer(dev, chip, addr++, alen, &byte, 1, 0)) 1559b2a668b5SSimon Glass puts("Error writing the chip.\n"); 1560b2a668b5SSimon Glass /* 1561b2a668b5SSimon Glass * Wait for the write to complete. The write can take 1562b2a668b5SSimon Glass * up to 10mSec (we allow a little more time). 1563b2a668b5SSimon Glass */ 1564b2a668b5SSimon Glass /* 1565b2a668b5SSimon Glass * No write delay with FRAM devices. 1566b2a668b5SSimon Glass */ 1567b2a668b5SSimon Glass #if !defined(CONFIG_SYS_I2C_FRAM) 1568b2a668b5SSimon Glass udelay(11000); 1569b2a668b5SSimon Glass #endif 1570b2a668b5SSimon Glass } 1571b2a668b5SSimon Glass 1572b2a668b5SSimon Glass return 0; 1573b2a668b5SSimon Glass } 1574b2a668b5SSimon Glass 1575b2a668b5SSimon Glass /* Temporary code until we have driver model and can use the i2c command */ 1576b2a668b5SSimon Glass static int cros_ec_i2c_passthrough(struct cros_ec_dev *dev, int flag, 1577b2a668b5SSimon Glass int argc, char * const argv[]) 1578b2a668b5SSimon Glass { 1579b2a668b5SSimon Glass const char *cmd; 1580b2a668b5SSimon Glass 1581b2a668b5SSimon Glass if (argc < 1) 1582b2a668b5SSimon Glass return CMD_RET_USAGE; 1583b2a668b5SSimon Glass cmd = *argv++; 1584b2a668b5SSimon Glass argc--; 1585b2a668b5SSimon Glass if (0 == strcmp("md", cmd)) 1586b2a668b5SSimon Glass cros_ec_i2c_md(dev, flag, argc, argv); 1587b2a668b5SSimon Glass else if (0 == strcmp("mw", cmd)) 1588b2a668b5SSimon Glass cros_ec_i2c_mw(dev, flag, argc, argv); 1589b2a668b5SSimon Glass else 1590b2a668b5SSimon Glass return CMD_RET_USAGE; 1591b2a668b5SSimon Glass 1592b2a668b5SSimon Glass return 0; 1593b2a668b5SSimon Glass } 1594b2a668b5SSimon Glass 159588364387SHung-ying Tyan static int do_cros_ec(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]) 159688364387SHung-ying Tyan { 159784d6cbd3SSimon Glass struct cros_ec_dev *dev; 159884d6cbd3SSimon Glass #ifdef CONFIG_DM_CROS_EC 159984d6cbd3SSimon Glass struct udevice *udev; 160084d6cbd3SSimon Glass #endif 160188364387SHung-ying Tyan const char *cmd; 160288364387SHung-ying Tyan int ret = 0; 160388364387SHung-ying Tyan 160488364387SHung-ying Tyan if (argc < 2) 160588364387SHung-ying Tyan return CMD_RET_USAGE; 160688364387SHung-ying Tyan 160788364387SHung-ying Tyan cmd = argv[1]; 160888364387SHung-ying Tyan if (0 == strcmp("init", cmd)) { 1609*e96fc7dfSSimon Glass #ifdef CONFIG_DM_CROS_EC 1610*e96fc7dfSSimon Glass /* Remove any existing device */ 1611*e96fc7dfSSimon Glass ret = uclass_find_device(UCLASS_CROS_EC, 0, &udev); 1612*e96fc7dfSSimon Glass if (!ret) 1613*e96fc7dfSSimon Glass device_remove(udev); 1614*e96fc7dfSSimon Glass ret = uclass_get_device(UCLASS_CROS_EC, 0, &udev); 1615*e96fc7dfSSimon Glass #else 161688364387SHung-ying Tyan ret = cros_ec_init(gd->fdt_blob, &dev); 1617*e96fc7dfSSimon Glass #endif 161888364387SHung-ying Tyan if (ret) { 161988364387SHung-ying Tyan printf("Could not init cros_ec device (err %d)\n", ret); 162088364387SHung-ying Tyan return 1; 162188364387SHung-ying Tyan } 162288364387SHung-ying Tyan return 0; 162388364387SHung-ying Tyan } 162488364387SHung-ying Tyan 162584d6cbd3SSimon Glass #ifdef CONFIG_DM_CROS_EC 162684d6cbd3SSimon Glass ret = uclass_get_device(UCLASS_CROS_EC, 0, &udev); 162784d6cbd3SSimon Glass if (ret) { 162884d6cbd3SSimon Glass printf("Cannot get cros-ec device (err=%d)\n", ret); 162984d6cbd3SSimon Glass return 1; 163084d6cbd3SSimon Glass } 1631e564f054SSimon Glass dev = dev_get_uclass_priv(udev); 163284d6cbd3SSimon Glass #else 163388364387SHung-ying Tyan /* Just use the last allocated device; there should be only one */ 163488364387SHung-ying Tyan if (!last_dev) { 163588364387SHung-ying Tyan printf("No CROS-EC device available\n"); 163688364387SHung-ying Tyan return 1; 163788364387SHung-ying Tyan } 163884d6cbd3SSimon Glass dev = last_dev; 163984d6cbd3SSimon Glass #endif 164088364387SHung-ying Tyan if (0 == strcmp("id", cmd)) { 164188364387SHung-ying Tyan char id[MSG_BYTES]; 164288364387SHung-ying Tyan 164388364387SHung-ying Tyan if (cros_ec_read_id(dev, id, sizeof(id))) { 164488364387SHung-ying Tyan debug("%s: Could not read KBC ID\n", __func__); 164588364387SHung-ying Tyan return 1; 164688364387SHung-ying Tyan } 164788364387SHung-ying Tyan printf("%s\n", id); 164888364387SHung-ying Tyan } else if (0 == strcmp("info", cmd)) { 1649836bb6e8SSimon Glass struct ec_response_mkbp_info info; 165088364387SHung-ying Tyan 165188364387SHung-ying Tyan if (cros_ec_info(dev, &info)) { 165288364387SHung-ying Tyan debug("%s: Could not read KBC info\n", __func__); 165388364387SHung-ying Tyan return 1; 165488364387SHung-ying Tyan } 165588364387SHung-ying Tyan printf("rows = %u\n", info.rows); 165688364387SHung-ying Tyan printf("cols = %u\n", info.cols); 165788364387SHung-ying Tyan printf("switches = %#x\n", info.switches); 165888364387SHung-ying Tyan } else if (0 == strcmp("curimage", cmd)) { 165988364387SHung-ying Tyan enum ec_current_image image; 166088364387SHung-ying Tyan 166188364387SHung-ying Tyan if (cros_ec_read_current_image(dev, &image)) { 166288364387SHung-ying Tyan debug("%s: Could not read KBC image\n", __func__); 166388364387SHung-ying Tyan return 1; 166488364387SHung-ying Tyan } 166588364387SHung-ying Tyan printf("%d\n", image); 166688364387SHung-ying Tyan } else if (0 == strcmp("hash", cmd)) { 166788364387SHung-ying Tyan struct ec_response_vboot_hash hash; 166888364387SHung-ying Tyan int i; 166988364387SHung-ying Tyan 167088364387SHung-ying Tyan if (cros_ec_read_hash(dev, &hash)) { 167188364387SHung-ying Tyan debug("%s: Could not read KBC hash\n", __func__); 167288364387SHung-ying Tyan return 1; 167388364387SHung-ying Tyan } 167488364387SHung-ying Tyan 167588364387SHung-ying Tyan if (hash.hash_type == EC_VBOOT_HASH_TYPE_SHA256) 167688364387SHung-ying Tyan printf("type: SHA-256\n"); 167788364387SHung-ying Tyan else 167888364387SHung-ying Tyan printf("type: %d\n", hash.hash_type); 167988364387SHung-ying Tyan 168088364387SHung-ying Tyan printf("offset: 0x%08x\n", hash.offset); 168188364387SHung-ying Tyan printf("size: 0x%08x\n", hash.size); 168288364387SHung-ying Tyan 168388364387SHung-ying Tyan printf("digest: "); 168488364387SHung-ying Tyan for (i = 0; i < hash.digest_size; i++) 168588364387SHung-ying Tyan printf("%02x", hash.hash_digest[i]); 168688364387SHung-ying Tyan printf("\n"); 168788364387SHung-ying Tyan } else if (0 == strcmp("reboot", cmd)) { 168888364387SHung-ying Tyan int region; 168988364387SHung-ying Tyan enum ec_reboot_cmd cmd; 169088364387SHung-ying Tyan 169188364387SHung-ying Tyan if (argc >= 3 && !strcmp(argv[2], "cold")) 169288364387SHung-ying Tyan cmd = EC_REBOOT_COLD; 169388364387SHung-ying Tyan else { 169488364387SHung-ying Tyan region = cros_ec_decode_region(argc - 2, argv + 2); 169588364387SHung-ying Tyan if (region == EC_FLASH_REGION_RO) 169688364387SHung-ying Tyan cmd = EC_REBOOT_JUMP_RO; 169788364387SHung-ying Tyan else if (region == EC_FLASH_REGION_RW) 169888364387SHung-ying Tyan cmd = EC_REBOOT_JUMP_RW; 169988364387SHung-ying Tyan else 170088364387SHung-ying Tyan return CMD_RET_USAGE; 170188364387SHung-ying Tyan } 170288364387SHung-ying Tyan 170388364387SHung-ying Tyan if (cros_ec_reboot(dev, cmd, 0)) { 170488364387SHung-ying Tyan debug("%s: Could not reboot KBC\n", __func__); 170588364387SHung-ying Tyan return 1; 170688364387SHung-ying Tyan } 170788364387SHung-ying Tyan } else if (0 == strcmp("events", cmd)) { 170888364387SHung-ying Tyan uint32_t events; 170988364387SHung-ying Tyan 171088364387SHung-ying Tyan if (cros_ec_get_host_events(dev, &events)) { 171188364387SHung-ying Tyan debug("%s: Could not read host events\n", __func__); 171288364387SHung-ying Tyan return 1; 171388364387SHung-ying Tyan } 171488364387SHung-ying Tyan printf("0x%08x\n", events); 171588364387SHung-ying Tyan } else if (0 == strcmp("clrevents", cmd)) { 171688364387SHung-ying Tyan uint32_t events = 0x7fffffff; 171788364387SHung-ying Tyan 171888364387SHung-ying Tyan if (argc >= 3) 171988364387SHung-ying Tyan events = simple_strtol(argv[2], NULL, 0); 172088364387SHung-ying Tyan 172188364387SHung-ying Tyan if (cros_ec_clear_host_events(dev, events)) { 172288364387SHung-ying Tyan debug("%s: Could not clear host events\n", __func__); 172388364387SHung-ying Tyan return 1; 172488364387SHung-ying Tyan } 172588364387SHung-ying Tyan } else if (0 == strcmp("read", cmd)) { 172688364387SHung-ying Tyan ret = do_read_write(dev, 0, argc, argv); 172788364387SHung-ying Tyan if (ret > 0) 172888364387SHung-ying Tyan return CMD_RET_USAGE; 172988364387SHung-ying Tyan } else if (0 == strcmp("write", cmd)) { 173088364387SHung-ying Tyan ret = do_read_write(dev, 1, argc, argv); 173188364387SHung-ying Tyan if (ret > 0) 173288364387SHung-ying Tyan return CMD_RET_USAGE; 173388364387SHung-ying Tyan } else if (0 == strcmp("erase", cmd)) { 173488364387SHung-ying Tyan int region = cros_ec_decode_region(argc - 2, argv + 2); 173588364387SHung-ying Tyan uint32_t offset, size; 173688364387SHung-ying Tyan 173788364387SHung-ying Tyan if (region == -1) 173888364387SHung-ying Tyan return CMD_RET_USAGE; 173988364387SHung-ying Tyan if (cros_ec_flash_offset(dev, region, &offset, &size)) { 174088364387SHung-ying Tyan debug("%s: Could not read region info\n", __func__); 174188364387SHung-ying Tyan ret = -1; 174288364387SHung-ying Tyan } else { 174388364387SHung-ying Tyan ret = cros_ec_flash_erase(dev, offset, size); 174488364387SHung-ying Tyan if (ret) { 174588364387SHung-ying Tyan debug("%s: Could not erase region\n", 174688364387SHung-ying Tyan __func__); 174788364387SHung-ying Tyan } 174888364387SHung-ying Tyan } 174988364387SHung-ying Tyan } else if (0 == strcmp("regioninfo", cmd)) { 175088364387SHung-ying Tyan int region = cros_ec_decode_region(argc - 2, argv + 2); 175188364387SHung-ying Tyan uint32_t offset, size; 175288364387SHung-ying Tyan 175388364387SHung-ying Tyan if (region == -1) 175488364387SHung-ying Tyan return CMD_RET_USAGE; 175588364387SHung-ying Tyan ret = cros_ec_flash_offset(dev, region, &offset, &size); 175688364387SHung-ying Tyan if (ret) { 175788364387SHung-ying Tyan debug("%s: Could not read region info\n", __func__); 175888364387SHung-ying Tyan } else { 175988364387SHung-ying Tyan printf("Region: %s\n", region == EC_FLASH_REGION_RO ? 176088364387SHung-ying Tyan "RO" : "RW"); 176188364387SHung-ying Tyan printf("Offset: %x\n", offset); 176288364387SHung-ying Tyan printf("Size: %x\n", size); 176388364387SHung-ying Tyan } 176488364387SHung-ying Tyan } else if (0 == strcmp("vbnvcontext", cmd)) { 176588364387SHung-ying Tyan uint8_t block[EC_VBNV_BLOCK_SIZE]; 176688364387SHung-ying Tyan char buf[3]; 176788364387SHung-ying Tyan int i, len; 176888364387SHung-ying Tyan unsigned long result; 176988364387SHung-ying Tyan 177088364387SHung-ying Tyan if (argc <= 2) { 177188364387SHung-ying Tyan ret = cros_ec_read_vbnvcontext(dev, block); 177288364387SHung-ying Tyan if (!ret) { 177388364387SHung-ying Tyan printf("vbnv_block: "); 177488364387SHung-ying Tyan for (i = 0; i < EC_VBNV_BLOCK_SIZE; i++) 177588364387SHung-ying Tyan printf("%02x", block[i]); 177688364387SHung-ying Tyan putc('\n'); 177788364387SHung-ying Tyan } 177888364387SHung-ying Tyan } else { 177988364387SHung-ying Tyan /* 178088364387SHung-ying Tyan * TODO(clchiou): Move this to a utility function as 178188364387SHung-ying Tyan * cmd_spi might want to call it. 178288364387SHung-ying Tyan */ 178388364387SHung-ying Tyan memset(block, 0, EC_VBNV_BLOCK_SIZE); 178488364387SHung-ying Tyan len = strlen(argv[2]); 178588364387SHung-ying Tyan buf[2] = '\0'; 178688364387SHung-ying Tyan for (i = 0; i < EC_VBNV_BLOCK_SIZE; i++) { 178788364387SHung-ying Tyan if (i * 2 >= len) 178888364387SHung-ying Tyan break; 178988364387SHung-ying Tyan buf[0] = argv[2][i * 2]; 179088364387SHung-ying Tyan if (i * 2 + 1 >= len) 179188364387SHung-ying Tyan buf[1] = '0'; 179288364387SHung-ying Tyan else 179388364387SHung-ying Tyan buf[1] = argv[2][i * 2 + 1]; 179488364387SHung-ying Tyan strict_strtoul(buf, 16, &result); 179588364387SHung-ying Tyan block[i] = result; 179688364387SHung-ying Tyan } 179788364387SHung-ying Tyan ret = cros_ec_write_vbnvcontext(dev, block); 179888364387SHung-ying Tyan } 179988364387SHung-ying Tyan if (ret) { 180088364387SHung-ying Tyan debug("%s: Could not %s VbNvContext\n", __func__, 180188364387SHung-ying Tyan argc <= 2 ? "read" : "write"); 180288364387SHung-ying Tyan } 180388364387SHung-ying Tyan } else if (0 == strcmp("test", cmd)) { 180488364387SHung-ying Tyan int result = cros_ec_test(dev); 180588364387SHung-ying Tyan 180688364387SHung-ying Tyan if (result) 180788364387SHung-ying Tyan printf("Test failed with error %d\n", result); 180888364387SHung-ying Tyan else 180988364387SHung-ying Tyan puts("Test passed\n"); 181088364387SHung-ying Tyan } else if (0 == strcmp("version", cmd)) { 181188364387SHung-ying Tyan struct ec_response_get_version *p; 181288364387SHung-ying Tyan char *build_string; 181388364387SHung-ying Tyan 181488364387SHung-ying Tyan ret = cros_ec_read_version(dev, &p); 181588364387SHung-ying Tyan if (!ret) { 181688364387SHung-ying Tyan /* Print versions */ 181788364387SHung-ying Tyan printf("RO version: %1.*s\n", 18182ab83f0dSSimon Glass (int)sizeof(p->version_string_ro), 181988364387SHung-ying Tyan p->version_string_ro); 182088364387SHung-ying Tyan printf("RW version: %1.*s\n", 18212ab83f0dSSimon Glass (int)sizeof(p->version_string_rw), 182288364387SHung-ying Tyan p->version_string_rw); 182388364387SHung-ying Tyan printf("Firmware copy: %s\n", 182488364387SHung-ying Tyan (p->current_image < 182588364387SHung-ying Tyan ARRAY_SIZE(ec_current_image_name) ? 182688364387SHung-ying Tyan ec_current_image_name[p->current_image] : 182788364387SHung-ying Tyan "?")); 182888364387SHung-ying Tyan ret = cros_ec_read_build_info(dev, &build_string); 182988364387SHung-ying Tyan if (!ret) 183088364387SHung-ying Tyan printf("Build info: %s\n", build_string); 183188364387SHung-ying Tyan } 183288364387SHung-ying Tyan } else if (0 == strcmp("ldo", cmd)) { 183388364387SHung-ying Tyan uint8_t index, state; 183488364387SHung-ying Tyan char *endp; 183588364387SHung-ying Tyan 183688364387SHung-ying Tyan if (argc < 3) 183788364387SHung-ying Tyan return CMD_RET_USAGE; 183888364387SHung-ying Tyan index = simple_strtoul(argv[2], &endp, 10); 183988364387SHung-ying Tyan if (*argv[2] == 0 || *endp != 0) 184088364387SHung-ying Tyan return CMD_RET_USAGE; 184188364387SHung-ying Tyan if (argc > 3) { 184288364387SHung-ying Tyan state = simple_strtoul(argv[3], &endp, 10); 184388364387SHung-ying Tyan if (*argv[3] == 0 || *endp != 0) 184488364387SHung-ying Tyan return CMD_RET_USAGE; 184588364387SHung-ying Tyan ret = cros_ec_set_ldo(dev, index, state); 184688364387SHung-ying Tyan } else { 184788364387SHung-ying Tyan ret = cros_ec_get_ldo(dev, index, &state); 184888364387SHung-ying Tyan if (!ret) { 184988364387SHung-ying Tyan printf("LDO%d: %s\n", index, 185088364387SHung-ying Tyan state == EC_LDO_STATE_ON ? 185188364387SHung-ying Tyan "on" : "off"); 185288364387SHung-ying Tyan } 185388364387SHung-ying Tyan } 185488364387SHung-ying Tyan 185588364387SHung-ying Tyan if (ret) { 185688364387SHung-ying Tyan debug("%s: Could not access LDO%d\n", __func__, index); 185788364387SHung-ying Tyan return ret; 185888364387SHung-ying Tyan } 1859b2a668b5SSimon Glass } else if (0 == strcmp("i2c", cmd)) { 1860b2a668b5SSimon Glass ret = cros_ec_i2c_passthrough(dev, flag, argc - 2, argv + 2); 186188364387SHung-ying Tyan } else { 186288364387SHung-ying Tyan return CMD_RET_USAGE; 186388364387SHung-ying Tyan } 186488364387SHung-ying Tyan 186588364387SHung-ying Tyan if (ret < 0) { 186688364387SHung-ying Tyan printf("Error: CROS-EC command failed (error %d)\n", ret); 186788364387SHung-ying Tyan ret = 1; 186888364387SHung-ying Tyan } 186988364387SHung-ying Tyan 187088364387SHung-ying Tyan return ret; 187188364387SHung-ying Tyan } 187288364387SHung-ying Tyan 187388364387SHung-ying Tyan U_BOOT_CMD( 1874b2a668b5SSimon Glass crosec, 6, 1, do_cros_ec, 187588364387SHung-ying Tyan "CROS-EC utility command", 187688364387SHung-ying Tyan "init Re-init CROS-EC (done on startup automatically)\n" 187788364387SHung-ying Tyan "crosec id Read CROS-EC ID\n" 187888364387SHung-ying Tyan "crosec info Read CROS-EC info\n" 187988364387SHung-ying Tyan "crosec curimage Read CROS-EC current image\n" 188088364387SHung-ying Tyan "crosec hash Read CROS-EC hash\n" 188188364387SHung-ying Tyan "crosec reboot [rw | ro | cold] Reboot CROS-EC\n" 188288364387SHung-ying Tyan "crosec events Read CROS-EC host events\n" 188388364387SHung-ying Tyan "crosec clrevents [mask] Clear CROS-EC host events\n" 188488364387SHung-ying Tyan "crosec regioninfo <ro|rw> Read image info\n" 188588364387SHung-ying Tyan "crosec erase <ro|rw> Erase EC image\n" 188688364387SHung-ying Tyan "crosec read <ro|rw> <addr> [<size>] Read EC image\n" 188788364387SHung-ying Tyan "crosec write <ro|rw> <addr> [<size>] Write EC image\n" 188888364387SHung-ying Tyan "crosec vbnvcontext [hexstring] Read [write] VbNvContext from EC\n" 188988364387SHung-ying Tyan "crosec ldo <idx> [<state>] Switch/Read LDO state\n" 189088364387SHung-ying Tyan "crosec test run tests on cros_ec\n" 1891b2a668b5SSimon Glass "crosec version Read CROS-EC version\n" 1892b2a668b5SSimon Glass "crosec i2c md chip address[.0, .1, .2] [# of objects] - read from I2C passthru\n" 1893b2a668b5SSimon Glass "crosec i2c mw chip address[.0, .1, .2] value [count] - write to I2C passthru (fill)" 189488364387SHung-ying Tyan ); 189588364387SHung-ying Tyan #endif 189684d6cbd3SSimon Glass 189784d6cbd3SSimon Glass #ifdef CONFIG_DM_CROS_EC 189884d6cbd3SSimon Glass UCLASS_DRIVER(cros_ec) = { 189984d6cbd3SSimon Glass .id = UCLASS_CROS_EC, 190084d6cbd3SSimon Glass .name = "cros_ec", 190184d6cbd3SSimon Glass .per_device_auto_alloc_size = sizeof(struct cros_ec_dev), 190284d6cbd3SSimon Glass }; 190384d6cbd3SSimon Glass #endif 1904