External Bus Interface

Detailed Description

Interface for external bus communication.

Summary

The External bus interface provides APIs and definitions for external bus communication.

Data Structures
struct	external_bus_cfg_t
struct	external_bus_api_t

Typedefs
typedef void	external_bus_ctrl_t

Enumerations
enum	external_bus_chip_select_t
enum	external_bus_data_bus_width_t
enum	external_bus_external_wait_t

---

Data Structure Documentation

external_bus_cfg_t

struct external_bus_cfg_t

External bus configuration

Data Fields
external_bus_chip_select_t	chip_select	Select which device to use.
external_bus_data_bus_width_t	data_width	Select data bus width.
external_bus_external_wait_t	external_wait_en	External wait function setting.
void const *	p_extend	External bus hardware dependent configuration.

external_bus_api_t

struct external_bus_api_t

External bus implementations follow this API.

Data Fields
fsp_err_t(*	open )(external_bus_ctrl_t *p_ctrl, external_bus_cfg_t const *const p_cfg)
fsp_err_t(*	close )(external_bus_ctrl_t *p_ctrl)

Field Documentation

open

fsp_err_t(* external_bus_api_t::open) (external_bus_ctrl_t *p_ctrl, external_bus_cfg_t const *const p_cfg)

Open the External bus driver module.

Parameters

[in]	p_ctrl	Pointer to a driver handle
[in]	p_cfg	Pointer to a configuration structure

close

fsp_err_t(* external_bus_api_t::close) (external_bus_ctrl_t *p_ctrl)

Close the External bus driver module.

Parameters

[in]

p_ctrl

Pointer to a driver handle

Typedef Documentation

external_bus_ctrl_t

typedef void external_bus_ctrl_t

External bus control block. Allocate an instance specific control block to pass into the External bus API calls.

Enumeration Type Documentation

external_bus_chip_select_t

enum external_bus_chip_select_t

External bus chip select.

Enumerator
EXTERNAL_BUS_CHIP_SELECT_0	Device connected to Chip-Select 0.
EXTERNAL_BUS_CHIP_SELECT_1	Device connected to Chip-Select 1.
EXTERNAL_BUS_CHIP_SELECT_2	Device connected to Chip-Select 2.
EXTERNAL_BUS_CHIP_SELECT_3	Device connected to Chip-Select 3.
EXTERNAL_BUS_CHIP_SELECT_4	Device connected to Chip-Select 4.
EXTERNAL_BUS_CHIP_SELECT_5	Device connected to Chip-Select 5.
EXTERNAL_BUS_CHIP_SELECT_6	Device connected to Chip-Select 6.
EXTERNAL_BUS_CHIP_SELECT_7	Device connected to Chip-Select 7.

external_bus_data_bus_width_t

enum external_bus_data_bus_width_t

External bus width.

Enumerator
EXTERNAL_BUS_DATA_BUS_WIDTH_8BIT	Data bus width 8bit.
EXTERNAL_BUS_DATA_BUS_WIDTH_16BIT	Data bus width 16bit.
EXTERNAL_BUS_DATA_BUS_WIDTH_32BIT	Data bus width 32bit.

external_bus_external_wait_t

enum external_bus_external_wait_t

External wait function configuration.

Enumerator
EXTERNAL_BUS_EXTERNAL_WAIT_ENABLE	Enable external wait function.
EXTERNAL_BUS_EXTERNAL_WAIT_DISABLE	Disable external wait function.