Domain Functions

Functions
ocs_hal_rtn_e	ocs_hal_domain_alloc (ocs_hal_t *hal, ocs_domain_t *domain, uint32_t fcf, uint32_t vlan)
	Allocate a fabric domain object. More...
ocs_hal_rtn_e	ocs_hal_domain_attach (ocs_hal_t *hal, ocs_domain_t *domain, uint32_t fc_id)
	Attach a SLI port to a domain. More...
ocs_hal_rtn_e	ocs_hal_domain_free (ocs_hal_t *hal, ocs_domain_t *domain)
	Free a fabric domain object. More...
ocs_hal_rtn_e	ocs_hal_domain_force_free (ocs_hal_t *hal, ocs_domain_t *domain)
	Free a fabric domain object. More...

Function Details

ocs_hal_rtn_e ocs_hal_domain_alloc	(	ocs_hal_t *	hal,
		ocs_domain_t *	domain,
		uint32_t	fcf,
		uint32_t	vlan
	)

Allocate a fabric domain object.

Description

This function starts a series of commands needed to connect to the domain, including

• REG_FCFI
• INIT_VFI
• READ_SPARMS

Note: Not all SLI interface types use all of the above commands.

Upon successful allocation, the HAL generates a OCS_HAL_DOMAIN_ALLOC_OK event. On failure, it generates a OCS_HAL_DOMAIN_ALLOC_FAIL event.

Parameters

hal	Hardware context.
domain	Pointer to the domain object.
fcf	FCF index.
vlan	VLAN ID.

Returns

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

Definition at line 3217 of file ocs_hal.c.

ocs_hal_rtn_e ocs_hal_domain_attach	(	ocs_hal_t *	hal,
		ocs_domain_t *	domain,
		uint32_t	fc_id
	)

Attach a SLI port to a domain.

Parameters

hal	Hardware context.
domain	Pointer to the domain object.
fc_id	Fibre Channel ID to associate with this port.

Returns

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

Definition at line 3280 of file ocs_hal.c.

ocs_hal_rtn_e ocs_hal_domain_force_free	(	ocs_hal_t *	hal,
		ocs_domain_t *	domain
	)

Free a fabric domain object.

Description

Free the driver resources associated with the domain. The difference between this call and ocs_hal_domain_free() is that this call assumes resources no longer exist on the SLI port, due to a reset or after some error conditions.

Parameters

hal	Hardware context.
domain	Pointer to the domain object.

Returns

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

Definition at line 3362 of file ocs_hal.c.

ocs_hal_rtn_e ocs_hal_domain_free	(	ocs_hal_t *	hal,
		ocs_domain_t *	domain
	)

Free a fabric domain object.

Description

Free both the driver and SLI port resources associated with the domain.

Parameters

hal	Hardware context.
domain	Pointer to the domain object.

Returns

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

Definition at line 3324 of file ocs_hal.c.