Functions
ocs_hal_rtn_e	ocs_hal_command (ocs_hal_t hal, uint8_t cmd, uint32_t opts, void cb, void arg)
	Issue a SLI command. More...

static ocs_hal_io_t *	_ocs_hal_io_alloc (ocs_hal_t *hal)
	Lockless allocate a HAL IO object. More...

ocs_hal_io_t *	ocs_hal_io_alloc (ocs_hal_t *hal)
	Allocate a HAL IO object. More...

ocs_hal_io_t *	ocs_hal_io_activate_port_owned (ocs_hal_t hal, ocs_hal_io_t io)
	Allocate/Activate a port owned HAL IO object. More...

static void	ocs_hal_io_free_move_correct_list (ocs_hal_t hal, ocs_hal_io_t io)
	When an IO is freed, depending on the exchange busy flag, and other workarounds, move it to the correct list. More...

static void	ocs_hal_io_free_common (ocs_hal_t hal, ocs_hal_io_t io)
	Free a HAL IO object. Perform cleanup common to port and host-owned IOs. More...

static void	ocs_hal_io_free_port_owned (void *arg)
	Free a HAL IO object associated with a port-owned XRI. More...

static void	ocs_hal_io_free_internal (void *arg)
	Free a previously-allocated HAL IO object. Called when IO refcount goes to zero (host-owned IOs only). More...

int32_t	ocs_hal_io_free (ocs_hal_t hal, ocs_hal_io_t io)
	Free a previously-allocated HAL IO object. More...

uint8_t	ocs_hal_io_inuse (ocs_hal_t hal, ocs_hal_io_t io)
	Check if given HAL IO is in-use. More...

ocs_hal_rtn_e	ocs_hal_srrs_send (ocs_hal_t hal, ocs_hal_io_type_e type, ocs_hal_io_t io, ocs_dma_t send, uint32_t len, ocs_dma_t receive, ocs_remote_node_t rnode, ocs_hal_io_param_t iparam, ocs_hal_srrs_cb_t cb, void *arg)
	Send a Single Request/Response Sequence (SRRS). More...

ocs_hal_rtn_e	ocs_hal_io_send (ocs_hal_t hal, ocs_hal_io_type_e type, ocs_hal_io_t io, uint32_t len, ocs_hal_io_param_t iparam, ocs_remote_node_t rnode, void cb, void arg)
	Send a read, write, or response IO. More...

ocs_hal_rtn_e	ocs_hal_io_init_sges (ocs_hal_t hal, ocs_hal_io_t io, ocs_hal_io_type_e type)
	Initialize the scatter gather list entries of an IO. More...

ocs_hal_rtn_e	ocs_hal_io_add_seed_sge (ocs_hal_t hal, ocs_hal_io_t io, ocs_hal_dif_info_t *dif_info)
	Add a T10 PI seed scatter gather list entry. More...

ocs_hal_rtn_e	ocs_hal_io_add_sge (ocs_hal_t hal, ocs_hal_io_t io, uintptr_t addr, uint32_t length)
	Add a scatter gather list entry to an IO. More...

ocs_hal_rtn_e	ocs_hal_io_add_dif_sge (ocs_hal_t hal, ocs_hal_io_t io, uintptr_t addr)
	Add a T10 DIF scatter gather list entry to an IO. More...

ocs_hal_rtn_e	ocs_hal_io_abort (ocs_hal_t hal, ocs_hal_io_t io_to_abort, uint32_t send_abts, void cb, void arg)
	Abort a previously-started IO. More...

int32_t	ocs_hal_io_get_xid (ocs_hal_t hal, ocs_hal_io_t io)
	Return the OX_ID/RX_ID of the IO. More...

ocs_hal_rtn_e	ocs_hal_get_sfp (ocs_hal_t hal, uint16_t page, ocs_hal_sfp_cb_t cb, void arg)
	Function to retrieve the SFP information. More...

ocs_hal_rtn_e	ocs_hal_get_port_protocol (ocs_hal_t hal, uint32_t pci_func, ocs_get_port_protocol_cb_t cb, void ul_arg)
	Get the current port protocol. More...

ocs_hal_rtn_e	ocs_hal_set_port_protocol (ocs_hal_t hal, ocs_hal_port_protocol_e new_protocol, uint32_t pci_func, ocs_set_port_protocol_cb_t cb, void ul_arg)
	Set the port protocol. More...

ocs_hal_rtn_e	ocs_hal_get_profile_list (ocs_hal_t hal, ocs_get_profile_list_cb_t cb, void ul_arg)
	Get a list of available profiles. More...

int32_t	ocs_hal_get_active_profile (ocs_hal_t hal, ocs_get_active_profile_cb_t cb, void ul_arg)
	Get the currently active profile. More...

int32_t	ocs_hal_get_nvparms (ocs_hal_t hal, ocs_get_nvparms_cb_t cb, void ul_arg)
	Read non-volatile parms. More...

int32_t	ocs_hal_set_nvparms (ocs_hal_t hal, ocs_set_nvparms_cb_t cb, uint8_t wwpn, uint8_t wwnn, uint8_t hard_alpa, uint32_t preferred_d_id, void ul_arg)
	Write non-volatile parms. More...

int32_t	ocs_hal_set_active_profile (ocs_hal_t hal, ocs_set_active_profile_cb_t cb, uint32_t profile_id, void ul_arg)
	Set the currently active profile. More...

Function Details

static ocs_hal_io_t* _ocs_hal_io_alloc ( ocs_hal_t * hal )

inlinestatic

Lockless allocate a HAL IO object.

Description: Assume that hal->ocs_lock is held. This function is only used if use_dif_sec_xri workaround is being used.

Parameters

hal	Hardware context.

Returns: Returns a pointer to an object on success, or NULL on failure.

Definition at line 3806 of file ocs_hal.c.

ocs_hal_rtn_e ocs_hal_command	(	ocs_hal_t *	hal,
		uint8_t *	cmd,
		uint32_t	opts,
		void *	cb,
		void *	arg
	)

Issue a SLI command.

Description: Send a mailbox command to the hardware, and either wait for a completion (OCS_CMD_POLL) or get an optional asynchronous completion (OCS_CMD_NOWAIT).

Parameters

hal	Hardware context.
cmd	Buffer containing a formatted command and results.
opts	Command options: OCS_CMD_POLL - Command executes synchronously and busy-waits for the completion. OCS_CMD_NOWAIT - Command executes asynchronously. Uses callback.
cb	Function callback used for asynchronous mode. May be NULL. Prototype is `(cb)(void arg, uint8_t cmd)`. Note:* If the callback function pointer is NULL, the results of the command are silently discarded, allowing this pointer to exist solely on the stack.
arg	Argument passed to an asynchronous callback.

Returns: Returns 0 on success, or a non-zero value on failure.

Definition at line 2731 of file ocs_hal.c.

int32_t ocs_hal_get_active_profile	(	ocs_hal_t *	hal,
		ocs_get_active_profile_cb_t	cb,
		void *	ul_arg
	)

Get the currently active profile.

Description: Issues a SLI-4 COMMON_GET_ACTIVE_PROFILE mailbox. When the command completes the provided mgmt callback function is called.

Parameters

hal	Hardware context.
cb	Callback function to be called when the command completes.
ul_arg	An argument that is passed to the callback function.

Returns

OCS_HAL_RTN_SUCCESS on success.
OCS_HAL_RTN_NO_MEMORY if a malloc fails.
OCS_HAL_RTN_NO_RESOURCES if unable to get a command context.
OCS_HAL_RTN_ERROR on any other error.

Definition at line 9077 of file ocs_hal.c.

int32_t ocs_hal_get_nvparms	(	ocs_hal_t *	hal,
		ocs_get_nvparms_cb_t	cb,
		void *	ul_arg
	)

Read non-volatile parms.

Description: Issues a SLI-4 READ_NVPARMS mailbox. When the command completes the provided mgmt callback function is called.

Parameters

hal	Hardware context.
cb	Callback function to be called when the command completes.
ul_arg	An argument that is passed to the callback function.

Returns

OCS_HAL_RTN_SUCCESS on success.
OCS_HAL_RTN_NO_MEMORY if a malloc fails.
OCS_HAL_RTN_NO_RESOURCES if unable to get a command context.
OCS_HAL_RTN_ERROR on any other error.

Definition at line 9178 of file ocs_hal.c.

ocs_hal_rtn_e ocs_hal_get_port_protocol	(	ocs_hal_t *	hal,
		uint32_t	pci_func,
		ocs_get_port_protocol_cb_t	cb,
		void *	ul_arg
	)

Get the current port protocol.

Description: Issues a SLI4 COMMON_GET_PROFILE_CONFIG mailbox. When the command completes the provided mgmt callback function is called.

Parameters

hal	Hardware context.
pci_func	PCI function to query for current protocol.
cb	Callback function to be called when the command completes.
ul_arg	An argument that is passed to the callback function.

Returns

OCS_HAL_RTN_SUCCESS on success.
OCS_HAL_RTN_NO_MEMORY if a malloc fails.
OCS_HAL_RTN_NO_RESOURCES if unable to get a command context.
OCS_HAL_RTN_ERROR on any other error.

Definition at line 8498 of file ocs_hal.c.

ocs_hal_rtn_e ocs_hal_get_profile_list	(	ocs_hal_t *	hal,
		ocs_get_profile_list_cb_t	cb,
		void *	ul_arg
	)

Get a list of available profiles.

Description: Issues a SLI-4 COMMON_GET_PROFILE_LIST mailbox. When the command completes the provided mgmt callback function is called.

Parameters

hal	Hardware context.
cb	Callback function to be called when the command completes.
ul_arg	An argument that is passed to the callback function.

Returns

OCS_HAL_RTN_SUCCESS on success.
OCS_HAL_RTN_NO_MEMORY if a malloc fails.
OCS_HAL_RTN_NO_RESOURCES if unable to get a command context.
OCS_HAL_RTN_ERROR on any other error.

Definition at line 8955 of file ocs_hal.c.

ocs_hal_rtn_e ocs_hal_get_sfp	(	ocs_hal_t *	hal,
		uint16_t	page,
		ocs_hal_sfp_cb_t	cb,
		void *	arg
	)

Function to retrieve the SFP information.

Parameters

hal	Hardware context.
page	The page of SFP data to retrieve (0xa0 or 0xa2).
cb	Function call upon completion of sending the data (may be NULL).
arg	Argument to pass to IO completion function.

Returns: Returns OCS_HAL_RTN_SUCCESS, OCS_HAL_RTN_ERROR, or OCS_HAL_RTN_NO_MEMORY.

Definition at line 5759 of file ocs_hal.c.

ocs_hal_rtn_e ocs_hal_io_abort	(	ocs_hal_t *	hal,
		ocs_hal_io_t *	io_to_abort,
		uint32_t	send_abts,
		void *	cb,
		void *	arg
	)

Abort a previously-started IO.

Parameters

hal	Hardware context.
io_to_abort	The IO to abort.
send_abts	Boolean to have the hardware automatically generate an ABTS.
cb	Function call upon completion of the abort (may be NULL).
arg	Argument to pass to abort completion function.

Returns: Returns 0 on success, or a non-zero value on failure.

Definition at line 5343 of file ocs_hal.c.

ocs_hal_io_t* ocs_hal_io_activate_port_owned	(	ocs_hal_t *	hal,
		ocs_hal_io_t *	io
	)

Allocate/Activate a port owned HAL IO object.

Description: This function is called by the transport layer when an XRI is allocated by the SLI-Port. This will "activate" the HAL IO associated with the XRI received from the SLI-Port to mirror the state of the XRI.

Note: This function applies to port owned XRIs only.

Parameters

hal	Hardware context.
io	Pointer HAL IO to activate/allocate.

Returns: Returns a pointer to an object on success, or NULL on failure.

Definition at line 3867 of file ocs_hal.c.

ocs_hal_rtn_e ocs_hal_io_add_dif_sge	(	ocs_hal_t *	hal,
		ocs_hal_io_t *	io,
		uintptr_t	addr
	)

Add a T10 DIF scatter gather list entry to an IO.

Parameters

hal	Hardware context.
io	Previously-allocated HAL IO object.
addr	DIF physical address.

Returns: Returns 0 on success, or a non-zero value on failure.

Definition at line 5283 of file ocs_hal.c.

ocs_hal_rtn_e ocs_hal_io_add_seed_sge	(	ocs_hal_t *	hal,
		ocs_hal_io_t *	io,
		ocs_hal_dif_info_t *	dif_info
	)

Add a T10 PI seed scatter gather list entry.

Parameters

hal	Hardware context.
io	Previously-allocated HAL IO object.
dif_info	Pointer to T10 DIF fields, or NULL if no DIF.

Returns: Returns 0 on success, or a non-zero value on failure.

Definition at line 5029 of file ocs_hal.c.

ocs_hal_rtn_e ocs_hal_io_add_sge	(	ocs_hal_t *	hal,
		ocs_hal_io_t *	io,
		uintptr_t	addr,
		uint32_t	length
	)

Add a scatter gather list entry to an IO.

Parameters

hal	Hardware context.
io	Previously-allocated HAL IO object.
addr	Physical address.
length	Length of memory pointed to by `addr`.

Returns: Returns 0 on success, or a non-zero value on failure.

Definition at line 5214 of file ocs_hal.c.

ocs_hal_io_t* ocs_hal_io_alloc ( ocs_hal_t * hal )

Allocate a HAL IO object.

Description: Note: This function applies to non-port owned XRIs only.

Parameters

hal	Hardware context.

Returns: Returns a pointer to an object on success, or NULL on failure.

Definition at line 3839 of file ocs_hal.c.

int32_t ocs_hal_io_free	(	ocs_hal_t *	hal,
		ocs_hal_io_t *	io
	)

Free a previously-allocated HAL IO object.

Description: Note: This function applies to port and host owned XRIs.

Parameters

hal	Hardware context.
io	Pointer to the HAL IO object.

Returns: Returns a non-zero value if HAL IO was freed, 0 if references on the IO still exist, or a negative value if an error occurred.

Definition at line 4001 of file ocs_hal.c.

static void ocs_hal_io_free_common	(	ocs_hal_t *	hal,
		ocs_hal_io_t *	io
	)

inlinestatic

Free a HAL IO object. Perform cleanup common to port and host-owned IOs.

Parameters

hal	Hardware context.
io	Pointer to the HAL IO object.

Definition at line 3925 of file ocs_hal.c.

static void ocs_hal_io_free_internal ( void * arg )

static

Free a previously-allocated HAL IO object. Called when IO refcount goes to zero (host-owned IOs only).

Parameters

arg	Pointer to the HAL IO object.

Definition at line 3970 of file ocs_hal.c.

static void ocs_hal_io_free_move_correct_list	(	ocs_hal_t *	hal,
		ocs_hal_io_t *	io
	)

static

When an IO is freed, depending on the exchange busy flag, and other workarounds, move it to the correct list.

Description: Note: Assumes that the hal->io_lock is held and the item has been removed from the busy or wait_free list.

Parameters

hal	Hardware context.
io	Pointer to the IO object to move.

Definition at line 3898 of file ocs_hal.c.

static void ocs_hal_io_free_port_owned ( void * arg )

static

Free a HAL IO object associated with a port-owned XRI.

Parameters

arg	Pointer to the HAL IO object.

Definition at line 3941 of file ocs_hal.c.

int32_t ocs_hal_io_get_xid	(	ocs_hal_t *	hal,
		ocs_hal_io_t *	io
	)

Return the OX_ID/RX_ID of the IO.

Parameters

hal	Hardware context.
io	HAL IO object.

Returns: Returns X_ID on success, or -1 on failure.

Definition at line 5488 of file ocs_hal.c.

ocs_hal_rtn_e ocs_hal_io_init_sges	(	ocs_hal_t *	hal,
		ocs_hal_io_t *	io,
		ocs_hal_io_type_e	type
	)

Initialize the scatter gather list entries of an IO.

Parameters

hal	Hardware context.
io	Previously-allocated HAL IO object.
type	Type of IO (target read, target response, and so on).

Returns: Returns 0 on success, or a non-zero value on failure.

Definition at line 4917 of file ocs_hal.c.

uint8_t ocs_hal_io_inuse	(	ocs_hal_t *	hal,
		ocs_hal_io_t *	io
	)

Check if given HAL IO is in-use.

Description: This function returns TRUE if the given HAL IO has been allocated and is in-use, and FALSE otherwise. It applies to port and host owned XRIs.

Parameters

hal	Hardware context.
io	Pointer to the HAL IO object.

Returns: TRUE if an IO is in use, or FALSE otherwise.

Definition at line 4029 of file ocs_hal.c.

ocs_hal_rtn_e ocs_hal_io_send	(	ocs_hal_t *	hal,
		ocs_hal_io_type_e	type,
		ocs_hal_io_t *	io,
		uint32_t	len,
		ocs_hal_io_param_t *	iparam,
		ocs_remote_node_t *	rnode,
		void *	cb,
		void *	arg
	)

Send a read, write, or response IO.

Description

This routine supports sending a higher-level IO (for example, FCP) between two endpoints as a target or initiator. Examples include:

Sending read data and good response (target).
Sending a response (target with no data or after receiving write data).

This routine assumes all IOs use the SGL associated with the HAL IO. Prior to calling this routine, the data should be loaded using ocs_hal_io_add_sge().

Parameters

hal	Hardware context.
type	Type of IO (target read, target response, and so on).
io	Previously-allocated HAL IO object.
len	Length, in bytes, of data to send.
iparam	IO parameters.
rnode	Destination of data (that is, a remote node).
cb	Function call upon completion of sending data (may be NULL).
arg	Argument to pass to IO completion function.

Returns: Returns 0 on success, or a non-zero value on failure.

Definition at line 4507 of file ocs_hal.c.

int32_t ocs_hal_set_active_profile	(	ocs_hal_t *	hal,
		ocs_set_active_profile_cb_t	cb,
		uint32_t	profile_id,
		void *	ul_arg
	)

Set the currently active profile.

Description: Issues a SLI4 COMMON_GET_ACTIVE_PROFILE mailbox. When the command completes the provided mgmt callback function is called.

Parameters

hal	Hardware context.
profile_id	Profile ID to activate.
cb	Callback function to be called when the command completes.
ul_arg	An argument that is passed to the callback function.

Returns

OCS_HAL_RTN_SUCCESS on success.
OCS_HAL_RTN_NO_MEMORY if a malloc fails.
OCS_HAL_RTN_NO_RESOURCES if unable to get a command context.
OCS_HAL_RTN_ERROR on any other error.

Definition at line 9484 of file ocs_hal.c.

int32_t ocs_hal_set_nvparms	(	ocs_hal_t *	hal,
		ocs_set_nvparms_cb_t	cb,
		uint8_t *	wwpn,
		uint8_t *	wwnn,
		uint8_t	hard_alpa,
		uint32_t	preferred_d_id,
		void *	ul_arg
	)

Write non-volatile parms.

Description: Issues a SLI-4 WRITE_NVPARMS mailbox. When the command completes the provided mgmt callback function is called.

Parameters

hal	Hardware context.
cb	Callback function to be called when the command completes.
wwpn	Port's WWPN in big-endian order, or NULL to use default.
wwnn	Port's WWNN in big-endian order, or NULL to use default.
hard_alpa	A hard AL_PA address setting used during loop initialization. If no hard AL_PA is required, set to 0.
preferred_d_id	A preferred D_ID address setting that may be overridden with the CONFIG_LINK mailbox command. If there is no preference, set to 0.
ul_arg	An argument that is passed to the callback function.

Returns

OCS_HAL_RTN_SUCCESS on success.
OCS_HAL_RTN_NO_MEMORY if a malloc fails.
OCS_HAL_RTN_NO_RESOURCES if unable to get a command context.
OCS_HAL_RTN_ERROR on any other error.

Definition at line 9280 of file ocs_hal.c.

ocs_hal_rtn_e ocs_hal_set_port_protocol	(	ocs_hal_t *	hal,
		ocs_hal_port_protocol_e	new_protocol,
		uint32_t	pci_func,
		ocs_set_port_protocol_cb_t	cb,
		void *	ul_arg
	)

Set the port protocol.

Description: Setting the port protocol is a read-modify-write operation. This function submits a GET_PROFILE_CONFIG command to read the current settings. The callback function will modify the settings and issue the write.

On successful completion this function will have allocated two regular memory areas and one dma area which will need to get freed later in the callbacks.

Parameters

hal	Hardware context.
new_protocol	New protocol to use.
pci_func	PCI function to configure.
cb	Callback function to be called when the command completes.
ul_arg	An argument that is passed to the callback function.

Returns

OCS_HAL_RTN_SUCCESS on success.
OCS_HAL_RTN_NO_MEMORY if a malloc fails.
OCS_HAL_RTN_NO_RESOURCES if unable to get a command context.
OCS_HAL_RTN_ERROR on any other error.

Definition at line 8803 of file ocs_hal.c.

ocs_hal_rtn_e ocs_hal_srrs_send	(	ocs_hal_t *	hal,
		ocs_hal_io_type_e	type,
		ocs_hal_io_t *	io,
		ocs_dma_t *	send,
		uint32_t	len,
		ocs_dma_t *	receive,
		ocs_remote_node_t *	rnode,
		ocs_hal_io_param_t *	iparam,
		ocs_hal_srrs_cb_t	cb,
		void *	arg
	)

Send a Single Request/Response Sequence (SRRS).

Description

This routine supports communication sequences consisting of a single request and single response between two endpoints. Examples include:

Sending an ELS request.
Sending an ELS response - To send an ELS reponse, the caller must provide the OX_ID from the received request.
Sending a FC Common Transport (FC-CT) request - To send a FC-CT request, the caller must provide the R_CTL, TYPE, and DF_CTL values to place in the FC frame header.

Note: The caller is expected to provide both send and receive buffers for requests. In the case of sending a response, no receive buffer is necessary and the caller may pass in a NULL pointer.

Parameters

hal	Hardware context.
type	Type of sequence (ELS request/response, FC-CT).
io	Previously-allocated HAL IO object.
send	DMA memory holding data to send (for example, ELS request, BLS response).
len	Length, in bytes, of data to send.
receive	Optional DMA memory to hold a response.
rnode	Destination of data (that is, a remote node).
iparam	IO parameters (ELS response and FC-CT).
cb	Function call upon completion of sending the data (may be NULL).
arg	Argument to pass to IO completion function.

Returns: Returns 0 on success, or a non-zero on failure.

Definition at line 4295 of file ocs_hal.c.

Functions

Function Details