int cros_ec_scan_keyboard(struct udevice *dev, struct mbkp_keyscan *scan);
/**
+ * Get the next pending MKBP event from the ChromeOS EC device.
+ *
+ * Send a message requesting the next event and return the result.
+ *
+ * @param event Place to put the event.
+ * @return 0 if ok, <0 on error.
+ */
+int cros_ec_get_next_event(struct udevice *dev,
+ struct ec_response_get_next_event *event);
+
+/**
* Read which image is currently running on the CROS-EC device.
*
* @param dev CROS-EC device
struct ec_response_flash_protect *resp);
/**
- * Notify EC of current boot mode
- *
- * @param dev CROS-EC device
- * @param vboot_mode Verified boot mode
- * @return 0 if ok, <0 on error
- */
-int cros_ec_entering_mode(struct udevice *dev, int mode);
-
-/**
* Run internal tests on the cros_ec interface.
*
* @param dev CROS-EC device
struct udevice *board_get_cros_ec_dev(void);
struct dm_cros_ec_ops {
+ /**
+ * check_version() - Check the protocol version being used (optional)
+ *
+ * If provided, this function should check that the EC can be supported
+ * by the driver. If not provided, HELLO messages will be sent to try
+ * to determine the protocol version.
+ *
+ * @dev: Device to check
+ * @return 0 if the protocol is valid, -ve if not supported
+ */
int (*check_version)(struct udevice *dev);
+
+ /**
+ * command() - Old-style command interface
+ *
+ * This sends a command and receives a response (deprecated, use
+ * packet())
+ *
+ * @dev: Device to use
+ * @cmd: Command to send (only supports 0-0xff)
+ * @cmd_version: Version of command to send (often 0)
+ * @dout: Output data (may be NULL If dout_len=0)
+ * @dout_len: Length of output data excluding 4-byte header
+ * @dinp: On input, set to point to input data, often struct
+ * cros_ec_dev->din - typically this is left alone but may be
+ * updated by the driver
+ * @din_len: Maximum length of response
+ * @return number of bytes in response, or -ve on error
+ */
int (*command)(struct udevice *dev, uint8_t cmd, int cmd_version,
const uint8_t *dout, int dout_len,
uint8_t **dinp, int din_len);
+
+ /**
+ * packet() - New-style command interface
+ *
+ * This interface is preferred over command(), since it is typically
+ * easier to implement.
+ *
+ * @dev: Device to use
+ * @out_bytes: Number of bytes to send (from struct cros_ec_dev->dout)
+ * @in_bytes: Maximum number of bytes to expect in response
+ * @return number of bytes in response, or -ve on error
+ */
int (*packet)(struct udevice *dev, int out_bytes, int in_bytes);
+
+ /**
+ * get_switches() - Get value of EC switches
+ *
+ * This is currently supported on the LPC EC.
+ *
+ * @dev: Device to use
+ * @return current switches value, or -ENOSYS if not supported
+ */
+ int (*get_switches)(struct udevice *dev);
};
#define dm_cros_ec_get_ops(dev) \
uint32_t *offset, uint32_t *size);
/**
+ * cros_ec_get_sku_id() - Read the SKU ID
+ *
+ * @dev: CROS-EC device
+ * return SKU ID, or -ve on error
+ */
+int cros_ec_get_sku_id(struct udevice *dev);
+
+/**
* Read/write non-volatile data from/to a CROS-EC device.
*
* @param dev CROS-EC device
int cros_ec_battery_cutoff(struct udevice *dev, uint8_t flags);
/**
+ * cros_ec_set_pwm_duty() - Set duty cycle of a generic pwm
+ *
+ * Note that duty value needs to be passed to the EC as a 16 bit number
+ * for increased precision.
+ *
+ * @param dev CROS-EC device
+ * @param index Index of the pwm
+ * @param duty Desired duty cycle, in 0..EC_PWM_MAX_DUTY range.
+ * @return 0 if OK, -ve on error
+ */
+int cros_ec_set_pwm_duty(struct udevice *dev, uint8_t index, uint16_t duty);
+
+/**
* cros_ec_read_limit_power() - Check if power is limited by batter/charger
*
* Sometimes the battery is low and / or the device is connected to a charger
*/
int cros_ec_set_lid_shutdown_mask(struct udevice *dev, int enable);
+/**
+ * cros_ec_hello() - Send a hello message
+ *
+ * Sends a message with a fixed input value and checks that the expected output
+ * value is received
+ *
+ * @dev: CROS-EC device
+ * @handshakep: If non-NULL, returns received handshake value on error
+ * @return 0 if OK, -ve on error
+ */
+int cros_ec_hello(struct udevice *dev, uint *handshakep);
+
+/**
+ * cros_ec_get_features() - Get the set of features provided by the EC
+ *
+ * See enum ec_feature_code for the list of available features
+ *
+ * @dev: CROS-EC device
+ * @featuresp: Returns a bitmask of supported features
+ * @return 0 if OK, -ve on error
+ */
+int cros_ec_get_features(struct udevice *dev, u64 *featuresp);
+
+/**
+ * cros_ec_check_feature() - Check if a feature is supported
+ *
+ * @dev: CROS-EC device
+ * @feature: Feature number to check (enum ec_feature_code)
+ * @return true if supported, false if not, -ve on error
+ */
+int cros_ec_check_feature(struct udevice *dev, uint feature);
+
+/**
+ * cros_ec_get_switches() - Get switches value
+ *
+ * @dev: CROS-EC device
+ * @return switches value, or -ENOSYS if not supported, or other -ve value on
+ * other error
+ */
+int cros_ec_get_switches(struct udevice *dev);
+
+/**
+ * cros_ec_vstore_supported() - Check if vstore is supported
+ *
+ * @dev: CROS-EC device
+ * @return false if not supported, true if supported, -ve on error
+ */
+int cros_ec_vstore_supported(struct udevice *dev);
+
+/**
+ * cros_ec_vstore_info() - Get vstore information
+ *
+ * @dev: CROS-EC device
+ * @lockedp: mask of locked slots
+ * @return number of vstore slots supported by the EC,, -ve on error
+ */
+int cros_ec_vstore_info(struct udevice *dev, u32 *lockedp);
+
+/**
+ * cros_ec_vstore_read() - Read data from EC vstore slot
+ *
+ * @dev: CROS-EC device
+ * @slot: vstore slot to read from
+ * @data: buffer to store read data, must be EC_VSTORE_SLOT_SIZE bytes
+ * @return 0 if OK, -ve on error
+ */
+int cros_ec_vstore_read(struct udevice *dev, int slot, uint8_t *data);
+
+/**
+ * cros_ec_vstore_write() - Save data into EC vstore slot
+ *
+ * The maximum size of data is EC_VSTORE_SLOT_SIZE. It is the caller's
+ * responsibility to check the number of implemented slots by querying the
+ * vstore info.
+ *
+ * @dev: CROS-EC device
+ * @slot: vstore slot to write into
+ * @data: data to write
+ * @size: size of data in bytes
+ * @return 0 if OK, -ve on error
+ */
+int cros_ec_vstore_write(struct udevice *dev, int slot, const uint8_t *data,
+ size_t size);
+
+/**
+ * cros_ec_read_batt_charge() - Read the battery-charge state
+ *
+ * @dev: CROS-EC device
+ * @chargep: Return battery-charge state as a percentage
+ */
+int cros_ec_read_batt_charge(struct udevice *dev, uint *chargep);
+
#endif
projects / platform / kernel / u-boot.git / blobdiff