Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit f632fed3 authored by Bruce Allan's avatar Bruce Allan Committed by Jeff Kirsher
Browse files

fm10k: cleanup mailbox code comments etc 



Cleanup a number of issues with function header comments, lower-case
acronyms (i.e. FIFO, TLV), duplicate comments and a stubbed-out header
comment for fm10k_sm_mbx_init.

Signed-off-by: default avatarBruce Allan <bruce.w.allan@intel.com>
Tested-by: default avatarKrishneil Singh <Krishneil.k.singh@intel.com>
Signed-off-by: default avatarJeff Kirsher <jeffrey.t.kirsher@intel.com>
parent f355bb51

drivers/net/ethernet/intel/fm10k/fm10k_mbx.c

+30 −20
Original line number Diff line number Diff line
@@ -57,7 +57,7 @@ static u16 fm10k_fifo_unused(struct fm10k_mbx_fifo *fifo) 
}



/**

 *  fm10k_fifo_empty - Test to verify if fifo is empty

 *  fm10k_fifo_empty - Test to verify if FIFO is empty

 *  @fifo: pointer to FIFO

 *

 *  This function returns true if the FIFO is empty, else false
@@ -72,7 +72,7 @@ static bool fm10k_fifo_empty(struct fm10k_mbx_fifo *fifo) 
 *  @fifo: pointer to FIFO

 *  @offset: offset to add to head

 *

 *  This function returns the indices into the fifo based on head + offset

 *  This function returns the indices into the FIFO based on head + offset

 **/

static u16 fm10k_fifo_head_offset(struct fm10k_mbx_fifo *fifo, u16 offset)

{
@@ -84,7 +84,7 @@ static u16 fm10k_fifo_head_offset(struct fm10k_mbx_fifo *fifo, u16 offset) 
 *  @fifo: pointer to FIFO

 *  @offset: offset to add to tail

 *

 *  This function returns the indices into the fifo based on tail + offset

 *  This function returns the indices into the FIFO based on tail + offset

 **/

static u16 fm10k_fifo_tail_offset(struct fm10k_mbx_fifo *fifo, u16 offset)

{
@@ -160,7 +160,7 @@ static u16 fm10k_mbx_index_len(struct fm10k_mbx_info *mbx, u16 head, u16 tail) 
/**

 *  fm10k_mbx_tail_add - Determine new tail value with added offset

 *  @mbx: pointer to mailbox

 *  @offset: length to add to head offset

 *  @offset: length to add to tail offset

 *

 *  This function takes the local tail index and recomputes it for

 *  a given length added as an offset.
@@ -176,7 +176,7 @@ static u16 fm10k_mbx_tail_add(struct fm10k_mbx_info *mbx, u16 offset) 
/**

 *  fm10k_mbx_tail_sub - Determine new tail value with subtracted offset

 *  @mbx: pointer to mailbox

 *  @offset: length to add to head offset

 *  @offset: length to add to tail offset

 *

 *  This function takes the local tail index and recomputes it for

 *  a given length added as an offset.
@@ -240,7 +240,7 @@ static u16 fm10k_mbx_pushed_tail_len(struct fm10k_mbx_info *mbx) 
}



/**

 *  fm10k_fifo_write_copy - pulls data off of msg and places it in fifo

 *  fm10k_fifo_write_copy - pulls data off of msg and places it in FIFO

 *  @fifo: pointer to FIFO

 *  @msg: message array to populate

 *  @tail_offset: additional offset to add to tail pointer
@@ -336,6 +336,7 @@ static u16 fm10k_mbx_validate_msg_size(struct fm10k_mbx_info *mbx, u16 len) 


/**

 *  fm10k_mbx_write_copy - pulls data off of Tx FIFO and places it in mbmem

 *  @hw: pointer to hardware structure

 *  @mbx: pointer to mailbox

 *

 *  This function will take a section of the Tx FIFO and copy it into the
@@ -711,7 +712,7 @@ static bool fm10k_mbx_tx_complete(struct fm10k_mbx_info *mbx) 
 *  @hw: pointer to hardware structure

 *  @mbx: pointer to mailbox

 *

 *  This function dequeues messages and hands them off to the tlv parser.

 *  This function dequeues messages and hands them off to the TLV parser.

 *  It will return the number of messages processed when called.

 **/

static u16 fm10k_mbx_dequeue_rx(struct fm10k_hw *hw,
@@ -924,7 +925,7 @@ static void fm10k_mbx_create_fake_disconnect_hdr(struct fm10k_mbx_info *mbx) 
}



/**

 *  fm10k_mbx_create_error_msg - Generate a error message

 *  fm10k_mbx_create_error_msg - Generate an error message

 *  @mbx: pointer to mailbox

 *  @err: local error encountered

 *
@@ -957,7 +958,6 @@ static void fm10k_mbx_create_error_msg(struct fm10k_mbx_info *mbx, s32 err) 
/**

 *  fm10k_mbx_validate_msg_hdr - Validate common fields in the message header

 *  @mbx: pointer to mailbox

 *  @msg: message array to read

 *

 *  This function will parse up the fields in the mailbox header and return

 *  an error if the header contains any of a number of invalid configurations
@@ -1021,11 +1021,12 @@ static s32 fm10k_mbx_validate_msg_hdr(struct fm10k_mbx_info *mbx) 


/**

 *  fm10k_mbx_create_reply - Generate reply based on state and remote head

 *  @hw: pointer to hardware structure

 *  @mbx: pointer to mailbox

 *  @head: acknowledgement number

 *

 *  This function will generate an outgoing message based on the current

 *  mailbox state and the remote fifo head.  It will return the length

 *  mailbox state and the remote FIFO head.  It will return the length

 *  of the outgoing message excluding header on success, and a negative value

 *  on error.

 **/
@@ -1151,8 +1152,8 @@ static void fm10k_mbx_connect_reset(struct fm10k_mbx_info *mbx) 


/**

 *  fm10k_mbx_process_connect - Process connect header

 *  @hw: pointer to hardware structure

 *  @mbx: pointer to mailbox

 *  @msg: message array to process

 *

 *  This function will read an incoming connect header and reply with the

 *  appropriate message.  It will return a value indicating the number of
@@ -1198,6 +1199,7 @@ static s32 fm10k_mbx_process_connect(struct fm10k_hw *hw, 


/**

 *  fm10k_mbx_process_data - Process data header

 *  @hw: pointer to hardware structure

 *  @mbx: pointer to mailbox

 *

 *  This function will read an incoming data header and reply with the
@@ -1239,6 +1241,7 @@ static s32 fm10k_mbx_process_data(struct fm10k_hw *hw, 


/**

 *  fm10k_mbx_process_disconnect - Process disconnect header

 *  @hw: pointer to hardware structure

 *  @mbx: pointer to mailbox

 *

 *  This function will read an incoming disconnect header and reply with the
@@ -1291,6 +1294,7 @@ static s32 fm10k_mbx_process_disconnect(struct fm10k_hw *hw, 


/**

 *  fm10k_mbx_process_error - Process error header

 *  @hw: pointer to hardware structure

 *  @mbx: pointer to mailbox

 *

 *  This function will read an incoming error header and reply with the
@@ -1560,7 +1564,7 @@ static s32 fm10k_mbx_register_handlers(struct fm10k_mbx_info *mbx, 
 *  @id: ID reference for PF as it supports up to 64 PF/VF mailboxes

 *

 *  This function initializes the mailbox for use.  It will split the

 *  buffer provided an use that th populate both the Tx and Rx FIFO by

 *  buffer provided and use that to populate both the Tx and Rx FIFO by

 *  evenly splitting it.  In order to allow for easy masking of head/tail

 *  the value reported in size must be a power of 2 and is reported in

 *  DWORDs, not bytes.  Any invalid values will cause the mailbox to return
@@ -1637,7 +1641,7 @@ s32 fm10k_pfvf_mbx_init(struct fm10k_hw *hw, struct fm10k_mbx_info *mbx, 
 *  fm10k_sm_mbx_create_data_hdr - Generate a mailbox header for local FIFO

 *  @mbx: pointer to mailbox

 *

 *  This function returns a connection mailbox header

 *  This function returns a data mailbox header

 **/

static void fm10k_sm_mbx_create_data_hdr(struct fm10k_mbx_info *mbx)

{
@@ -1730,8 +1734,6 @@ static s32 fm10k_sm_mbx_connect(struct fm10k_hw *hw, struct fm10k_mbx_info *mbx) 
	fm10k_sm_mbx_create_connect_hdr(mbx, 0);

	fm10k_mbx_write(hw, mbx);



	/* enable interrupt and notify other party of new message */



	return 0;

}
@@ -1775,7 +1777,7 @@ static void fm10k_sm_mbx_disconnect(struct fm10k_hw *hw, 
}



/**

 *  fm10k_mbx_validate_fifo_hdr - Validate fields in the remote FIFO header

 *  fm10k_sm_mbx_validate_fifo_hdr - Validate fields in the remote FIFO header

 *  @mbx: pointer to mailbox

 *

 *  This function will parse up the fields in the mailbox header and return
@@ -1853,7 +1855,7 @@ static void fm10k_sm_mbx_process_error(struct fm10k_mbx_info *mbx) 
}



/**

 *  fm10k_sm_mbx_create_error_message - Process an error in FIFO hdr

 *  fm10k_sm_mbx_create_error_msg - Process an error in FIFO header

 *  @mbx: pointer to mailbox

 *  @err: local error encountered

 *
@@ -1883,6 +1885,7 @@ static void fm10k_sm_mbx_create_error_msg(struct fm10k_mbx_info *mbx, s32 err) 
 *  fm10k_sm_mbx_receive - Take message from Rx mailbox FIFO and put it in Rx

 *  @hw: pointer to hardware structure

 *  @mbx: pointer to mailbox

 *  @tail: tail index of message

 *

 *  This function will dequeue one message from the Rx switch manager mailbox

 *  FIFO and place it in the Rx mailbox FIFO for processing by software.
@@ -1922,6 +1925,7 @@ static s32 fm10k_sm_mbx_receive(struct fm10k_hw *hw, 
 *  fm10k_sm_mbx_transmit - Take message from Tx and put it in Tx mailbox FIFO

 *  @hw: pointer to hardware structure

 *  @mbx: pointer to mailbox

 *  @head: head index of message

 *

 *  This function will dequeue one message from the Tx mailbox FIFO and place

 *  it in the Tx switch manager mailbox FIFO for processing by hardware.
@@ -1961,11 +1965,12 @@ static void fm10k_sm_mbx_transmit(struct fm10k_hw *hw, 


/**

 *  fm10k_sm_mbx_create_reply - Generate reply based on state and remote head

 *  @hw: pointer to hardware structure

 *  @mbx: pointer to mailbox

 *  @head: acknowledgement number

 *

 *  This function will generate an outgoing message based on the current

 *  mailbox state and the remote fifo head.  It will return the length

 *  mailbox state and the remote FIFO head.  It will return the length

 *  of the outgoing message excluding header on success, and a negative value

 *  on error.

 **/
@@ -2077,7 +2082,7 @@ static s32 fm10k_sm_mbx_process_version_1(struct fm10k_hw *hw, 
}



/**

 *  fm10k_sm_mbx_process - Process mailbox switch mailbox interrupt

 *  fm10k_sm_mbx_process - Process switch manager mailbox interrupt

 *  @hw: pointer to hardware structure

 *  @mbx: pointer to mailbox

 *
@@ -2133,7 +2138,12 @@ static s32 fm10k_sm_mbx_process(struct fm10k_hw *hw, 
 *  @mbx: pointer to mailbox

 *  @msg_data: handlers for mailbox events

 *

 *  This function for now is used to stub out the PF/SM mailbox

 *  This function initializes the PF/SM mailbox for use.  It will split the

 *  buffer provided and use that to populate both the Tx and Rx FIFO by

 *  evenly splitting it.  In order to allow for easy masking of head/tail

 *  the value reported in size must be a power of 2 and is reported in

 *  DWORDs, not bytes.  Any invalid values will cause the mailbox to return

 *  error.

 **/

s32 fm10k_sm_mbx_init(struct fm10k_hw *hw, struct fm10k_mbx_info *mbx,

		      const struct fm10k_msg_data *msg_data)

drivers/net/ethernet/intel/fm10k/fm10k_mbx.h

+2 −2
Original line number Diff line number Diff line
@@ -128,11 +128,11 @@ enum fm10k_mbx_state { 
 *		The maximum message size is provided during connect to avoid

 *		jamming the mailbox with messages that do not fit.

 * Err_no: Error number - Applies only to error headers

 *		The error number provides a indication of the type of error

 *		The error number provides an indication of the type of error

 *		experienced.

 */



/* macros for retriving and setting header values */

/* macros for retrieving and setting header values */

#define FM10K_MSG_HDR_MASK(name) \

	((0x1u << FM10K_MSG_##name##_SIZE) - 1)

#define FM10K_MSG_HDR_FIELD_SET(value, name) \

drivers/net/ethernet/intel/fm10k/fm10k_tlv.h

+2 −2
Original line number Diff line number Diff line
@@ -38,9 +38,9 @@ struct fm10k_msg_data; 
 * mailbox size we will provide a message with the above header and it

 * will be segmented and transported to the mailbox to the other side where

 * it is reassembled.  It contains the following fields:

 * Len: Length of the message in bytes excluding the message header

 * Length: Length of the message in bytes excluding the message header

 * Flags: TBD

 * Rule: These will be the message/argument types we pass

 * Type/ID: These will be the message/argument types we pass

 */

/* message data header */

#define FM10K_TLV_ID_SHIFT		0