X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=include%2Fcros_ec.h;h=94c988a7d65226c58778b4088bec097c05c34818;hb=ddd39d0cc1a025a1e2e3c792cc8286dbdfa29b54;hp=4771e6b7d1c3b4e434737be26499b9e5e1e8cdee;hpb=e6cd05e5025bbab9723bbb09c506cbb5aa63bc53;p=platform%2Fkernel%2Fu-boot.git

diff --git a/include/cros_ec.h b/include/cros_ec.h
index 4771e6b..94c988a 100644
--- a/include/cros_ec.h
+++ b/include/cros_ec.h
@@ -67,7 +67,7 @@ struct fdt_cros_ec {
  * @param dev		CROS-EC device
  * @param id		Place to put the ID
  * @param maxlen	Maximum length of the ID field
- * @return 0 if ok, -1 on error
+ * Return: 0 if ok, -1 on error
  */
 int cros_ec_read_id(struct udevice *dev, char *id, int maxlen);
 
@@ -78,16 +78,27 @@ int cros_ec_read_id(struct udevice *dev, char *id, int maxlen);
  *
  * @param dev		CROS-EC device
  * @param scan		Place to put the scan results
- * @return 0 if ok, -1 on error
+ * Return: 0 if ok, -1 on error
  */
 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
  * @param image		Destination for image identifier
- * @return 0 if ok, <0 on error
+ * Return: 0 if ok, <0 on error
  */
 int cros_ec_read_current_image(struct udevice *dev,
 			       enum ec_current_image *image);
@@ -98,7 +109,7 @@ int cros_ec_read_current_image(struct udevice *dev,
  * @param dev		CROS-EC device
  * @param hash_offset	Offset in flash to read from
  * @param hash		Destination for hash information
- * @return 0 if ok, <0 on error
+ * Return: 0 if ok, <0 on error
  */
 int cros_ec_read_hash(struct udevice *dev, uint hash_offset,
 		      struct ec_response_vboot_hash *hash);
@@ -111,7 +122,7 @@ int cros_ec_read_hash(struct udevice *dev, uint hash_offset,
  * @param dev		CROS-EC device
  * @param cmd		Reboot command
  * @param flags         Flags for reboot command (EC_REBOOT_FLAG_*)
- * @return 0 if ok, <0 on error
+ * Return: 0 if ok, <0 on error
  */
 int cros_ec_reboot(struct udevice *dev, enum ec_reboot_cmd cmd, uint8_t flags);
 
@@ -122,7 +133,7 @@ int cros_ec_reboot(struct udevice *dev, enum ec_reboot_cmd cmd, uint8_t flags);
  * If no external interrupt is configured, this always returns 1.
  *
  * @param dev		CROS-EC device
- * @return 0 if no interrupt is pending
+ * Return: 0 if no interrupt is pending
  */
 int cros_ec_interrupt_pending(struct udevice *dev);
 
@@ -140,7 +151,7 @@ enum {
  *
  * @param blob		Device tree blob containing setup information
  * @param cros_ecp        Returns pointer to the cros_ec device, or NULL if none
- * @return 0 if we got an cros_ec device and all is well (or no cros_ec is
+ * Return: 0 if we got an cros_ec device and all is well (or no cros_ec is
  *	expected), -ve if we should have an cros_ec device but failed to find
  *	one, or init failed (-CROS_EC_ERR_...).
  */
@@ -159,7 +170,7 @@ int cros_ec_info(struct udevice *dev, struct ec_response_mkbp_info *info);
  *
  * @param dev		CROS-EC device
  * @param events_ptr	Destination for event flags.  Not changed on error.
- * @return 0 if ok, <0 on error
+ * Return: 0 if ok, <0 on error
  */
 int cros_ec_get_host_events(struct udevice *dev, uint32_t *events_ptr);
 
@@ -168,7 +179,7 @@ int cros_ec_get_host_events(struct udevice *dev, uint32_t *events_ptr);
  *
  * @param dev		CROS-EC device
  * @param events	Event flags to clear
- * @return 0 if ok, <0 on error
+ * Return: 0 if ok, <0 on error
  */
 int cros_ec_clear_host_events(struct udevice *dev, uint32_t events);
 
@@ -181,18 +192,17 @@ int cros_ec_clear_host_events(struct udevice *dev, uint32_t events);
  * @param set_flags	New flag values; only bits in set_mask are applied;
  *                      ignored if set_mask=0.
  * @param prot          Destination for updated protection state from EC.
- * @return 0 if ok, <0 on error
+ * Return: 0 if ok, <0 on error
  */
 int cros_ec_flash_protect(struct udevice *dev, uint32_t set_mask,
 			  uint32_t set_flags,
 			  struct ec_response_flash_protect *resp);
 
-
 /**
  * Run internal tests on the cros_ec interface.
  *
  * @param dev		CROS-EC device
- * @return 0 if ok, <0 if the test failed
+ * Return: 0 if ok, <0 if the test failed
  */
 int cros_ec_test(struct udevice *dev);
 
@@ -202,7 +212,7 @@ int cros_ec_test(struct udevice *dev);
  * @param dev		CROS-EC device
  * @param image		the content to write
  * @param imafge_size	content length
- * @return 0 if ok, <0 if the test failed
+ * Return: 0 if ok, <0 if the test failed
  */
 int cros_ec_flash_update_rw(struct udevice *dev, const uint8_t  *image,
 			    int image_size);
@@ -210,16 +220,66 @@ int cros_ec_flash_update_rw(struct udevice *dev, const uint8_t  *image,
 /**
  * Return a pointer to the board's CROS-EC device
  *
- * @return pointer to CROS-EC device, or NULL if none is available
+ * Return: pointer to CROS-EC device, or NULL if none is available
  */
 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) \
@@ -242,7 +302,7 @@ void cros_ec_dump_data(const char *name, int cmd, const uint8_t *data, int len);
  *
  * @param data	Data block to checksum
  * @param size	Size of data block in bytes
- * @return checksum value (0 to 255)
+ * Return: checksum value (0 to 255)
  */
 int cros_ec_calc_checksum(const uint8_t *data, int size);
 
@@ -261,7 +321,7 @@ int cros_ec_flash_erase(struct udevice *dev, uint32_t offset, uint32_t size);
  * @param data		Pointer to data buffer to read into
  * @param offset	Offset within flash to read from
  * @param size		Number of bytes to read
- * @return 0 if ok, -1 on error
+ * Return: 0 if ok, -1 on error
  */
 int cros_ec_flash_read(struct udevice *dev, uint8_t *data, uint32_t offset,
 		       uint32_t size);
@@ -293,7 +353,7 @@ int cros_ec_read_flashinfo(struct udevice *dev,
  * @param data		Pointer to data buffer to write
  * @param offset	Offset within flash to write to.
  * @param size		Number of bytes to write
- * @return 0 if ok, -1 on error
+ * Return: 0 if ok, -1 on error
  */
 int cros_ec_flash_write(struct udevice *dev, const uint8_t *data,
 			uint32_t offset, uint32_t size);
@@ -305,17 +365,25 @@ int cros_ec_flash_write(struct udevice *dev, const uint8_t *data,
  * @param region	Flash region to query
  * @param offset	Returns offset of flash region in EC flash
  * @param size		Returns size of flash region
- * @return 0 if ok, -1 on error
+ * Return: 0 if ok, -1 on error
  */
 int cros_ec_flash_offset(struct udevice *dev, enum ec_flash_region region,
 			 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
  * @param block		Buffer of VbNvContext to be read/write
- * @return 0 if ok, -1 on error
+ * Return: 0 if ok, -1 on error
  */
 int cros_ec_read_nvdata(struct udevice *dev, uint8_t *block, int size);
 int cros_ec_write_nvdata(struct udevice *dev, const uint8_t *block, int size);
@@ -325,7 +393,7 @@ int cros_ec_write_nvdata(struct udevice *dev, const uint8_t *block, int size);
  *
  * @param dev		CROS-EC device
  * @param versionp	This is set to point to the version information
- * @return 0 if ok, -1 on error
+ * Return: 0 if ok, -1 on error
  */
 int cros_ec_read_version(struct udevice *dev,
 			 struct ec_response_get_version **versionp);
@@ -335,7 +403,7 @@ int cros_ec_read_version(struct udevice *dev,
  *
  * @param dev		CROS-EC device
  * @param versionp	This is set to point to the build string
- * @return 0 if ok, -1 on error
+ * Return: 0 if ok, -1 on error
  */
 int cros_ec_read_build_info(struct udevice *dev, char **strp);
 
@@ -345,7 +413,7 @@ int cros_ec_read_build_info(struct udevice *dev, char **strp);
  * @param dev		CROS-EC device
  * @param index		index of the LDO/FET to switch
  * @param state		new state of the LDO/FET : EC_LDO_STATE_ON|OFF
- * @return 0 if ok, -1 on error
+ * Return: 0 if ok, -1 on error
  */
 int cros_ec_set_ldo(struct udevice *dev, uint8_t index, uint8_t state);
 
@@ -355,7 +423,7 @@ int cros_ec_set_ldo(struct udevice *dev, uint8_t index, uint8_t state);
  * @param dev		CROS-EC device
  * @param index		index of the LDO/FET to switch
  * @param state		current state of the LDO/FET : EC_LDO_STATE_ON|OFF
- * @return 0 if ok, -1 on error
+ * Return: 0 if ok, -1 on error
  */
 int cros_ec_get_ldo(struct udevice *dev, uint8_t index, uint8_t *state);
 
@@ -365,7 +433,7 @@ int cros_ec_get_ldo(struct udevice *dev, uint8_t index, uint8_t *state);
  * This permits delayed reporting of the EC error if it failed during
  * early init.
  *
- * @return error (0 if there was no error, -ve if there was an error)
+ * Return: error (0 if there was no error, -ve if there was an error)
  */
 int cros_ec_get_error(void);
 
@@ -397,4 +465,191 @@ struct i2c_msg;
 int cros_ec_i2c_tunnel(struct udevice *dev, int port, struct i2c_msg *msg,
 		       int nmsgs);
 
+/**
+ * cros_ec_get_events_b() - Get event mask B
+ *
+ * Return: value of event mask, default value of 0 if it could not be read
+ */
+uint64_t cros_ec_get_events_b(struct udevice *dev);
+
+/**
+ * cros_ec_clear_events_b() - Clear even mask B
+ *
+ * Any pending events in the B range are cleared
+ *
+ * Return: 0 if OK, -ve on error
+ */
+int cros_ec_clear_events_b(struct udevice *dev, uint64_t mask);
+
+/**
+ * cros_ec_efs_verify() - tell the EC to verify one of its images
+ *
+ * @param dev		CROS-EC device
+ * @param region	Flash region to query
+ * Return: 0 if OK, -ve on error
+ */
+int cros_ec_efs_verify(struct udevice *dev, enum ec_flash_region region);
+
+/**
+ * cros_ec_battery_cutoff() - Request that the battery be cut off
+ *
+ * This tells the battery to stop supplying power. This is used before shipping
+ * a device to ensure that the battery remains charged while the device is
+ * shipped or sitting on the shelf waiting to be purchased.
+ *
+ * @param dev		CROS-EC device
+ * @param flags		Flags to use (EC_BATTERY_CUTOFF_FLAG_...)
+ * Return: 0 if OK, -ve on error
+ */
+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
+ * that cannot supply much power.
+ *
+ * @param dev		CROS-EC device
+ * @param limit_powerp	Returns whether power is limited (0 or 1)
+ * Return: 0 if OK, -ENOSYS if the EC does not support this comment, -EINVAL
+ *		if the EC returned an invalid response
+ */
+int cros_ec_read_limit_power(struct udevice *dev, int *limit_powerp);
+
+/**
+ * cros_ec_config_powerbtn() - Configure the behaviour of the power button
+ *
+ * @param dev		CROS-EC device
+ * @param flags		Flags to use (EC_POWER_BUTTON_...)
+ * Return: 0 if OK, -ve on error
+ */
+int cros_ec_config_powerbtn(struct udevice *dev, uint32_t flags);
+
+/**
+ * cros_ec_get_lid_shutdown_mask() - Set the lid shutdown mask
+ *
+ * Determines whether a lid close event is reported
+ *
+ * @param dev		CROS-EC device
+ * Return: shufdown mas if OK, -ve on error
+ */
+int cros_ec_get_lid_shutdown_mask(struct udevice *dev);
+
+/**
+ * cros_ec_set_lid_shutdown_mask() - Set the lid shutdown mask
+ *
+ * Set whether a lid close event is reported
+ *
+ * @param dev		CROS-EC device
+ * @param enable	true to enable reporting, false to disable
+ * Return: shufdown mas if OK, -ve on error
+ */
+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
+ * Return: 0 if OK, -ve on error
+ */
+int cros_ec_read_batt_charge(struct udevice *dev, uint *chargep);
+
 #endif