diff options
| author | Sridhar Siricilla <sridhar.siricilla@intel.com> | 2022-08-15 21:10:58 +0530 |
|---|---|---|
| committer | Tim Wawrzynczak <twawrzynczak@chromium.org> | 2022-08-17 19:45:41 +0000 |
| commit | c760e41a414d2c1aec31982530944bae62c828f0 (patch) | |
| tree | cb036d063d2d40d1205c7c0bf4c2d252739a08b2 /src | |
| parent | 957fde633b6ed1fd698018b1d34c01ebbc6d4178 (diff) | |
soc/intel/common: Update the comments for CSE RX and TX functions
The patch updates the comments on return values and heci_reset()
triggering during error scenarios of heci_receive() and heci_send()
functions to reflect the current implementation.
Test=Build the code for Gimble
Signed-off-by: Sridhar Siricilla <sridhar.siricilla@intel.com>
Change-Id: I6c6c3312602c772147cb315db9ea1753d84a0fb3
Reviewed-on: https://review.coreboot.org/c/coreboot/+/66755
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Angel Pons <th3fanbus@gmail.com>
Reviewed-by: Tim Wawrzynczak <twawrzynczak@chromium.org>
Diffstat (limited to 'src')
| -rw-r--r-- | src/soc/intel/common/block/cse/cse.c | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/src/soc/intel/common/block/cse/cse.c b/src/soc/intel/common/block/cse/cse.c index 8af3d9e00e..a68c98261f 100644 --- a/src/soc/intel/common/block/cse/cse.c +++ b/src/soc/intel/common/block/cse/cse.c @@ -412,8 +412,8 @@ send_one_message(uint32_t hdr, const void *buff) /* * Send message msg of size len to host from host_addr to cse_addr. - * Returns 1 on success and 0 otherwise. - * In case of error heci_reset() may be required. + * Returns CSE_TX_RX_SUCCESS on success and other enum values on failure scenarios. + * Also, in case of errors, heci_reset() is triggered. */ static enum cse_tx_rx_status heci_send(const void *msg, size_t len, uint8_t host_addr, uint8_t client_addr) @@ -524,9 +524,9 @@ recv_one_message(uint32_t *hdr, void *buff, size_t maxlen, size_t *recv_len) * Receive message into buff not exceeding maxlen. Message is considered * successfully received if a 'complete' indication is read from ME side * and there was enough space in the buffer to fit that message. maxlen - * is updated with size of message that was received. Returns 0 on failure - * and 1 on success. - * In case of error heci_reset() may be required. + * is updated with size of message that was received. + * Returns CSE_TX_RX_SUCCESS on success and other enum values on failure scenarios. + * Also, in case of errors, heci_reset() is triggered. */ static enum cse_tx_rx_status heci_receive(void *buff, size_t *maxlen) { |