Visible to Intel only — GUID: fnk1655476758605
Ixiasoft
Visible to Intel only — GUID: fnk1655476758605
Ixiasoft
33.5. Genlock Signal Router IP Software API
intel_vvp_genlock_router_init
- prototype:
-
int intel_vvp_genlock_router_init(intel_vvp_genlock_router_instance* instance, intel_vvp_core_base base);description:
- Description:
-
Initialization function for a VVP Genlock Router instance.
Attempts to initialize the fields of the Genlock Router and its base core
- argument:
-
instance, pointer to the intel_vvp_ genlock_router _instance to initialize
base, the accessor for the core (on Nios this is a pointer to the base address of the core)
- return value:
-
kIntelVvpCoreOk success
kIntelVvpCoreVidErr if the vendor id of the core is not the IntelFPGA vendor ID.
kIntelVvpCorePidErr if the product id of the core is not the genlock_router product id
kIntelVvpCoreInstanceErr if the instance parameter is zero (null pointer)
intel_vvp_genlock_router_get_param_vid_pid
- prototype:
-
int intel_vvp_ genlock_router_get_param_vid_pid(intel_vvp_genlock_router_instance* instance);
- argument:
-
instance, pointer to the intel_vvp_genlock_router_instance
- return value:
-
The product ID number
intel_vvp_genlock_router_get_param_version_number
- prototype:
-
int intel_vvp_ genlock_router_get_param_version_number(intel_vvp_genlock_router_instance* instance);
- argument:
-
instance, pointer to the intel_vvp_genlock_router_instance
- return value:
-
The IP version number
intel_vvp_genlock_router_get_param_pulse_length
- prototype:
-
int intel_vvp_ genlock_router_get_param_pulse_length(intel_vvp_genlock_router_instance* instance);
- argument:
-
instance, pointer to the intel_vvp_genlock_router_instance
- return value:
-
The number of clock cycles the start of frame output pulse remains active-high
intel_vvp_genlock_router_get_param_number_of_genlock_inputs
- prototype:
-
int intel_vvp_genlock_router_get_param_number_of_genlock_inputs(intel_vvp_genlock_router_instance*instance);
- argument:
-
instance, pointer to the intel_vvp_genlock_router_instance
- return value:
-
The number of input ports that were selected during build time configuration
intel_vvp_genlock_router_get_param_number_of_genlock_outputs
- prototype:
-
int intel_vvp_genlock_router_get_param_number_of_genlock_outputs(intel_vvp_genlock_router_instance*instance);
- argument:
-
instance, pointer to the intel_vvp_genlock_router_instance
- return value:
-
The number of output ports that were selected during build time configuration
intel_vvp_genlock_router_get_param_genlock_output_type
- prototype:
-
int intel_vvp_genlock_router_get_param_genlock_output_type(intel_vvp_genlock_router_instance*instance);
- argument:
-
instance, pointer to the intel_vvp_genlock_router_instance
- return value:
-
The type of output interface that was selected during build time configuration
intel_vvp_genlock_router_get_param_genlock_input_type
- prototype:
-
int intel_vvp_genlock_router_get_param_genlock_input_type(intel_vvp_genlock_router_instance*instance , uint16_t in_val);
- argument:
-
instance, pointer to the intel_vvp_genlock_router_instance
in_val, the index of the input port
- return value:
-
The type of input interface that was selected during build time configuration for a particular input port
intel_vvp_genlock_router_get_gpio_input
- prototype:
-
int intel_vvp_genlock_router_get_gpio_input(intel_vvp_genlock_router_instance* instance);
- argument:
-
instance, pointer to the intel_vvp_genlock_router_instance
- return value:
-
The data on the general-purpose input register
intel_vvp_genlock_router_get_gpio_output
- prototype:
-
int intel_vvp_genlock_router_get_gpio_output(intel_vvp_genlock_router_instance* instance);
- argument:
-
instance, pointer to the intel_vvp_genlock_router_instance
- return value:
-
The data on the general-purpose output register
intel_vvp_genlock_router_set_gpio_output
- prototype:
-
int intel_vvp_genlock_router_set_gpio_output(intel_vvp_genlock_router_instance* instance, uint32_t out_val);
- argument:
-
instance, pointer to the intel_vvp_genlock_router _instance
out_val, the value that is stored in the general-purpose output register.
- return value:
-
if successful kIntelVvpGenlockRouterOk, otherwise kIntelVvpGenlockRouterInstanceErr
intel_vvp_genlock_router_enable_output_intf
- prototype:
-
int intel_vvp_genlock_router_enable_output_intf(intel_vvp_genlock_router_instance* instance, uint16_t out_port);
- argument:
-
instance, pointer to the intel_vvp_genlock_router_instance
out_port, the index value associated with the output port.
- return value:
-
if successful kIntelVvpGenlockRouterOk, otherwise kIntelVvpGenlockRouterInstanceErr
intel_vvp_genlock_router_disable_output_intf
- prototype:
-
int intel_vvp_genlock_router_disable_output_intf(intel_vvp_genlock_router_instance* instance, uint16_t out_port);
- argument:
-
instance, pointer to the intel_vvp_genlock_router_instance
out_port, the index value associated with the output port.
- return value:
-
if successful kIntelVvpGenlockRouterOk, otherwise kIntelVvpGenlockRouterInstanceErr
intel_vvp_genlock_router_sel_inout_pair
- prototype:
-
intel_vvp_genlock_router_sel_inout_pair(intel_vvp_genlock_router_instance* instance, uint16_t in_port, uint16_t out_port);
- argument:
-
instance, pointer to the intel_vvp_genlock_router_instance
in_port, the index value associated with the input port.
out_port, the index value associated with the output port.
- return value:
-
if successful kIntelVvpGenlockRouterOk, otherwise kIntelVvpGenlockRouterInstanceErr
intel_vvp_genlock_router_get_out_cfg
- prototype:
-
int intel_vvp_genlock_router_get_out_cfg (intel_vvp_genlock_router_instance* instance, uint16_t out_port);
- argument:
-
instance, pointer to the intel_vvp_genlock_router_instance
out_port, the index value associated with the output port.
- return value:
-
The configuration value stored on a particular output register