NF Configuration

Introduction

This is NF Configuration file

Files
file	nf_cfg.h
	Defines the structures / control operations that could be used to configure / control NF of VPAC.

Data Structures
struct	Nf_Config
	Connfiguration parameters of NF. More...
struct	Nf_WgtTableConfig
	Weight table parameters of NF. More...
struct	Nf_ErrEventParams
	Structure for error event parameters Used to register callback for the given set of events. More...

Functions
static void	Nf_ConfigInit (Nf_Config *nfCfg)
	This function should be used to initialize variable of type Nf_Config. More...

Typedefs
typedef void(*	Nf_ErrEventCbFxn) (Fvid2_Handle handle, uint32_t errEvents, void *appData)
	Prototype for the Error Event for NF. The callback for the NF error events can be registered using Nf_ErrEventParams. One of the parameter in this is call back. Driver calls this callback when error occurs. More...

Macros
#define	NF_BL_LUT_SIZE   (5U*256U)
	NF Lut Size in bytes for in Bi-lateral filter mode. More...
#define	NF_BL_LUT_WORDS   (NF_BL_LUT_SIZE/4U)
	NF Lut Size in Words for in Bi-lateral filter mode. More...
#define	NF_GEN_LUT_SIZE   (24U)
	NF Lut Size in bytes for in Generic filter mode. More...
#define	NF_GEN_LUT_WORDS   (NF_GEN_LUT_SIZE/2U)
	NF Lut Size in Words for in Generic filter mode. More...

NF Error Events
Macro's to define NF Error events, for which NF callback could be registered. Caution: These macro values are directly used by driver for enabling events.
#define	VHWA_NF_RD_ERR   (0x400U)
	Error on NF VBUSM Read interface. More...
#define	VHWA_NF_WR_ERR   (0x200U)

Filter Modes
Macro's to define different filter mode.
#define	NF_FILTER_MODE_BILATERAL   (0x0u)
	Use Bilateral filtering. More...
#define	NF_FILTER_MODE_GENERIC_2D_FILTER   (0x1u)

Macro Definition Documentation

NF_BL_LUT_SIZE

#define NF_BL_LUT_SIZE   (5U*256U)

NF Lut Size in bytes for in Bi-lateral filter mode.

NF_BL_LUT_WORDS

#define NF_BL_LUT_WORDS   (NF_BL_LUT_SIZE/4U)

NF Lut Size in Words for in Bi-lateral filter mode.

NF_GEN_LUT_SIZE

#define NF_GEN_LUT_SIZE   (24U)

NF Lut Size in bytes for in Generic filter mode.

NF_GEN_LUT_WORDS

#define NF_GEN_LUT_WORDS   (NF_GEN_LUT_SIZE/2U)

NF Lut Size in Words for in Generic filter mode.

VHWA_NF_RD_ERR

#define VHWA_NF_RD_ERR   (0x400U)

Error on NF VBUSM Read interface.

<Error on NF SL2 VBSUM Write interface

VHWA_NF_WR_ERR

#define VHWA_NF_WR_ERR   (0x200U)

NF_FILTER_MODE_BILATERAL

#define NF_FILTER_MODE_BILATERAL   (0x0u)

Use Bilateral filtering.

<Use Generic 2D filtering

NF_FILTER_MODE_GENERIC_2D_FILTER

#define NF_FILTER_MODE_GENERIC_2D_FILTER   (0x1u)

Typedef Documentation

Nf_ErrEventCbFxn

typedef void(* Nf_ErrEventCbFxn) (Fvid2_Handle handle, uint32_t errEvents, void *appData)

Prototype for the Error Event for NF. The callback for the NF error events can be registered using Nf_ErrEventParams. One of the parameter in this is call back. Driver calls this callback when error occurs.

Parameters

handle	FVID2 driver handle, for which error has occurred.
errEvents	Error Events occured, Refer to Nf_ErrorEvents for valid values.

Returns

None.

Function Documentation

Nf_ConfigInit()

static void Nf_ConfigInit ( Nf_Config *  nfCfg )

inlinestatic

This function should be used to initialize variable of type Nf_Config.

Parameters

nfCfg

A pointer of type Nf_Config

Returns

None