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>
This commit is contained in:
Sridhar Siricilla 2022-08-15 21:10:58 +05:30 committed by Tim Wawrzynczak
parent 957fde633b
commit c760e41a41
1 changed files with 5 additions and 5 deletions

View File

@ -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. * Send message msg of size len to host from host_addr to cse_addr.
* Returns 1 on success and 0 otherwise. * Returns CSE_TX_RX_SUCCESS on success and other enum values on failure scenarios.
* In case of error heci_reset() may be required. * Also, in case of errors, heci_reset() is triggered.
*/ */
static enum cse_tx_rx_status static enum cse_tx_rx_status
heci_send(const void *msg, size_t len, uint8_t host_addr, uint8_t client_addr) 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 * Receive message into buff not exceeding maxlen. Message is considered
* successfully received if a 'complete' indication is read from ME side * successfully received if a 'complete' indication is read from ME side
* and there was enough space in the buffer to fit that message. maxlen * 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 * is updated with size of message that was received.
* and 1 on success. * Returns CSE_TX_RX_SUCCESS on success and other enum values on failure scenarios.
* In case of error heci_reset() may be required. * Also, in case of errors, heci_reset() is triggered.
*/ */
static enum cse_tx_rx_status heci_receive(void *buff, size_t *maxlen) static enum cse_tx_rx_status heci_receive(void *buff, size_t *maxlen)
{ {