diff options
author | Heinrich Schuchardt <heinrich.schuchardt@canonical.com> | 2022-01-19 20:05:50 +0300 |
---|---|---|
committer | Heinrich Schuchardt <heinrich.schuchardt@canonical.com> | 2022-01-19 20:11:34 +0300 |
commit | 185f812c419f1b4f0d10d9787d59cf9f11a2a600 (patch) | |
tree | 2fea02768d6005934547f075586c60ba7aca6253 /drivers/misc | |
parent | 6a685753ce8b6b02b67d64b239143bf19eda63c9 (diff) | |
download | u-boot-185f812c419f1b4f0d10d9787d59cf9f11a2a600.tar.xz |
doc: replace @return by Return:
Sphinx expects Return: and not @return to indicate a return value.
find . -name '*.c' -exec \
sed -i 's/^\(\s\)\*\(\s*\)@return\(\s\)/\1*\2Return:\3/' {} \;
find . -name '*.h' -exec \
sed -i 's/^\(\s\)\*\(\s*\)@return\(\s\)/\1*\2Return:\3/' {} \;
Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
Diffstat (limited to 'drivers/misc')
-rw-r--r-- | drivers/misc/cros_ec.c | 20 | ||||
-rw-r--r-- | drivers/misc/cros_ec_lpc.c | 2 | ||||
-rw-r--r-- | drivers/misc/cros_ec_sandbox.c | 8 | ||||
-rw-r--r-- | drivers/misc/cros_ec_spi.c | 2 |
4 files changed, 16 insertions, 16 deletions
diff --git a/drivers/misc/cros_ec.c b/drivers/misc/cros_ec.c index c627c1df6c..e131eccd28 100644 --- a/drivers/misc/cros_ec.c +++ b/drivers/misc/cros_ec.c @@ -117,7 +117,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) { @@ -138,7 +138,7 @@ int cros_ec_calc_checksum(const uint8_t *data, int size) * @param cmd_version Version of command to send (EC_VER_...) * @param dout Output data (may be NULL If dout_len=0) * @param dout_len Size of output data in bytes - * @return packet size in bytes, or <0 if error. + * Return: packet size in bytes, or <0 if error. */ static int create_proto3_request(struct cros_ec_dev *cdev, int cmd, int cmd_version, @@ -178,7 +178,7 @@ static int create_proto3_request(struct cros_ec_dev *cdev, * * @param dev CROS-EC device * @param din_len Maximum size of response in bytes - * @return maximum expected number of bytes in response, or <0 if error. + * Return: maximum expected number of bytes in response, or <0 if error. */ static int prepare_proto3_response_buffer(struct cros_ec_dev *cdev, int din_len) { @@ -202,7 +202,7 @@ static int prepare_proto3_response_buffer(struct cros_ec_dev *cdev, int din_len) * @param dev CROS-EC device * @param dinp Returns pointer to response data * @param din_len Maximum size of response in bytes - * @return number of bytes of response data, or <0 if error. Note that error + * Return: number of bytes of response data, or <0 if error. Note that error * codes can be from errno.h or -ve EC_RES_INVALID_CHECKSUM values (and they * overlap!) */ @@ -318,7 +318,7 @@ static int send_command(struct cros_ec_dev *dev, uint cmd, int cmd_version, * If not NULL, it will be updated to point to the data * and will always be double word aligned (64-bits) * @param din_len Maximum size of response in bytes - * @return number of bytes in response, or -ve on error + * Return: number of bytes in response, or -ve on error */ static int ec_command_inptr(struct udevice *dev, uint cmd, int cmd_version, const void *dout, int dout_len, @@ -385,7 +385,7 @@ static int ec_command_inptr(struct udevice *dev, uint cmd, * It not NULL, it is a place for ec_command() to copy the * data to. * @param din_len Maximum size of response in bytes - * @return number of bytes in response, or -ve on error + * Return: number of bytes in response, or -ve on error */ static int ec_command(struct udevice *dev, uint cmd, int cmd_version, const void *dout, int dout_len, @@ -872,7 +872,7 @@ int cros_ec_flash_erase(struct udevice *dev, uint32_t offset, uint32_t size) * @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 */ static int cros_ec_flash_write_block(struct udevice *dev, const uint8_t *data, uint32_t offset, uint32_t size) @@ -913,7 +913,7 @@ static int cros_ec_flash_write_burst_size(struct udevice *dev) * * @param data Pointer to data to check (must be word-aligned) * @param size Number of bytes to check (must be word-aligned) - * @return 0 if erased, non-zero if any word is not erased + * Return: 0 if erased, non-zero if any word is not erased */ static int cros_ec_data_is_erased(const uint32_t *data, int size) { @@ -985,7 +985,7 @@ int cros_ec_flash_write(struct udevice *dev, const uint8_t *data, * * @param me CrosEc instance * @param region Region to run verification on - * @return 0 if success or not applicable. Non-zero if verification failed. + * Return: 0 if success or not applicable. Non-zero if verification failed. */ int cros_ec_efs_verify(struct udevice *dev, enum ec_flash_region region) { @@ -1022,7 +1022,7 @@ int cros_ec_efs_verify(struct udevice *dev, enum ec_flash_region region) * @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 */ static int cros_ec_flash_read_block(struct udevice *dev, uint8_t *data, uint32_t offset, uint32_t size) diff --git a/drivers/misc/cros_ec_lpc.c b/drivers/misc/cros_ec_lpc.c index f40375978d..1a8a81349c 100644 --- a/drivers/misc/cros_ec_lpc.c +++ b/drivers/misc/cros_ec_lpc.c @@ -186,7 +186,7 @@ int cros_ec_lpc_command(struct udevice *udev, uint8_t cmd, int cmd_version, * * @param dev CROS_EC device * @param blob Device tree blob - * @return 0 if ok, -1 on error + * Return: 0 if ok, -1 on error */ int cros_ec_lpc_init(struct cros_ec_dev *dev, const void *blob) { diff --git a/drivers/misc/cros_ec_sandbox.c b/drivers/misc/cros_ec_sandbox.c index 2173517cff..8dbe0b188a 100644 --- a/drivers/misc/cros_ec_sandbox.c +++ b/drivers/misc/cros_ec_sandbox.c @@ -186,7 +186,7 @@ SANDBOX_STATE_IO(cros_ec, "google,cros-ec", cros_ec_read_state, * * @param ec Current emulated EC state * @param entry Flash map entry containing the image to check - * @return actual image size in bytes, 0 if the image contains no content or + * Return: actual image size in bytes, 0 if the image contains no content or * error. */ static int get_image_used(struct ec_state *ec, struct fmap_entry *entry) @@ -214,7 +214,7 @@ static int get_image_used(struct ec_state *ec, struct fmap_entry *entry) * * @param ec Current emulated EC state * @param node Keyboard node of device tree containing keyscan information - * @return 0 if ok, -1 on error + * Return: 0 if ok, -1 on error */ static int keyscan_read_fdt_matrix(struct ec_state *ec, ofnode node) { @@ -263,7 +263,7 @@ static int keyscan_read_fdt_matrix(struct ec_state *ec, ofnode node) * @param ec Current emulated EC state * @param scan Place to put keyscan bytes for the keyscan message (must hold * enough space for a full keyscan) - * @return number of bytes of valid scan data + * Return: number of bytes of valid scan data */ static int cros_ec_keyscan(struct ec_state *ec, uint8_t *scan) { @@ -305,7 +305,7 @@ static int cros_ec_keyscan(struct ec_state *ec, uint8_t *scan) * @param req_data Pointer to body of request * @param resp_hdr Pointer to place to put response header * @param resp_data Pointer to place to put response data, if any - * @return length of response data, or 0 for no response data, or -1 on error + * Return: length of response data, or 0 for no response data, or -1 on error */ static int process_cmd(struct ec_state *ec, struct ec_host_request *req_hdr, const void *req_data, diff --git a/drivers/misc/cros_ec_spi.c b/drivers/misc/cros_ec_spi.c index bbc96301ae..001f0a85ca 100644 --- a/drivers/misc/cros_ec_spi.c +++ b/drivers/misc/cros_ec_spi.c @@ -75,7 +75,7 @@ done: * @param dinp Returns pointer to response data. This will be * untouched unless we return a value > 0. * @param din_len Maximum size of response in bytes - * @return number of bytes in response, or -1 on error + * Return: number of bytes in response, or -1 on error */ int cros_ec_spi_command(struct udevice *udev, uint8_t cmd, int cmd_version, const uint8_t *dout, int dout_len, |