MfpgaHookFunction

Specifies the identifier of the system that has the required Processing FPGA.

Specifies the Processing FPGA on the system which has the required PU. This parameter must be set to the following value:

For specifying the rank of the Processing FPGA
Value	Description	MIL system-specific tooltip (‡)
M_DEVn	Specifies the rank of the Processing FPGA on the board, where n can be a value between 0 and the total number of Processing FPGAs-1.	‡						j	k M10	l	m		p	r U27					y U75		aa

Specifies the function identifier of the PU. The function identifier is specified in the header of the target PU's FPGA register file. For the function identifiers of Matrox PUs, see the Matrox FPGA Component Reference. Note that the range of custom PU function identifiers is between 0xFC00 and 0xFDFF, inclusive. This parameter can be set to one of the following values:

For specifying the function identifier
Value	Description	MIL system-specific tooltip (‡)
M_DEFAULT	Specifies the default function identifier. You can specify M_DEFAULT if the HookType parameter is set to M_INTERRUPT_OVERRUN. (summarize) Specifies the default function identifier. (more details...)	‡						j	k M10	l	m		p	r U27					y U75		aa
Value > 0	Specifies the function identifier of the required PU.	‡						j	k M10	l	m		p	r U27					y U75		aa

Specifies the subfunction identifier of the PU. Several different Matrox PUs can exist, each with slightly different optimizations, functionalities, or restrictions. Each variation is given a number called a subfunction identifier that uniquely identifies the variation. The subfunction identifier is specified in the header of the target PU's FPGA register file. You can set this parameter to one of the following:

For specifying the subfunction identifier
Value	Description	MIL system-specific tooltip (‡)
M_DEFAULT	Specifies the default subfunction identifier. Use this setting if the instances of the PU with the specified function identifier in your FPGA configuration all have the same subfunction identifier. You should also use this setting if you are using a custom PU. (summarize) Specifies the default subfunction identifier. (more details...)	‡						j	k M10	l	m		p	r U27					y U75		aa
Value > 0	Specifies the subfunction identifier of the required PU. For the subfunction identifiers of Matrox PUs, see the Matrox FPGA Component Reference. (summarize) Specifies the subfunction identifier of the required PU. (more details...)	‡						j	k M10	l	m		p	r U27					y U75		aa

Specifies the specific PU instance on which to hook a function if two or more instances are present in the FPGA configuration, loaded on the Processing FPGA. This parameter can be set to the following value:

For specifying the rank of a PU
Value	Description	MIL system-specific tooltip (‡)
M_DEFAULT	Specifies the default instance of a PU on which to hook a function. You can specify M_DEFAULT if you have selected M_INTERRUPT_OVERRUN as your HookType. (summarize) Specifies the default instance of a PU on which to hook a function. (more details...)	‡						j	k M10	l	m		p	r U27					y U75		aa
M_DEVn	Specifies the rank of the PU in the FPGA configuration loaded on the Processing FPGA, where n represents the specific PU instance and starts at 0. The higher the instance's base address, the higher the index. (summarize) Specifies the rank of the PU in the FPGA configuration loaded on the Processing FPGA, where n represents the specific PU instance and starts at 0. (more details...)	‡						j	k M10	l	m		p	r U27					y U75		aa

Specifies the Processing FPGA event type. Note that the event type count starts at 0x1, whereas interrupts are numbered starting at 0.

This parameter can be set to one of the following:

For specifying the Processing FPGA event type
Value	Description	MIL system-specific tooltip (‡)
M_END_OF_PROCESSING +	Calls the hook-handler function whenever the specified PU generates an end-of-processing interrupt (or an interrupt on interrupt 0).	‡						j	k M10	l	m		p	r U27					y U75		aa
M_INTERRUPT_OVERRUN +	Calls the hook-handler function if the end-of-processing interrupt is signaled before the previous one is serviced by the driver.	‡						j	k M10	l	m		p	r U27					y U75		aa
0x01 +	Calls the hook-handler function if the PU's interrupt 0 is raised. Same as M_END_OF_PROCESSING. (summarize) Calls the hook-handler function if the PU's interrupt 0 is raised. (more details...)	‡						j	k M10	l	m		p	r U27					y U75		aa
0x02 +	Calls the hook-handler function if the PU's interrupt 1 is raised.	‡						j	k M10	l	m		p	r U27					y U75		aa
0x04 +	Calls the hook-handler function if the PU's interrupt 2 is raised.	‡						j	k M10	l	m		p	r U27					y U75		aa
0x08 +	Calls the hook-handler function if the PU's interrupt 3 is raised.	‡						j	k M10	l	m		p	r U27					y U75		aa
0x10 +	Calls the hook-handler function if the PU's interrupt 4 is raised.	‡						j	k M10	l	m		p	r U27					y U75		aa
0x20 +	Calls the hook-handler function if the PU's interrupt 5 is raised.	‡						j	k M10	l	m		p	r U27					y U75		aa
0x40 +	Calls the hook-handler function if the PU's interrupt 6 is raised.	‡						j	k M10	l	m		p	r U27					y U75		aa

Combination value for the values listed in For specifying the Processing FPGA event type.

You can add the following value to the above-mentioned values to specify to unhook a function.

For unhooking a function
Combination value	Description	MIL system-specific tooltip (‡)
M_UNHOOK	Unhooks a hooked function from the specified event.	‡						j	k M10	l	m		p	r U27					y U75		aa

Specifies the address of the function that should be called when an event occurs.

The hook-handler function, pointed to by HookHandlerPtr, must be declared as follows:

Note that the HookHandlerPtr function can have any name.

Upon successful completion, the hook-handler function should return M_NULL. Note, MFTYPE and MFPGAHOOKFCTPTR are reserved MIL predefined types for functions and data pointers, respectively.

Specifies the address of the user data that you want to make available to the hook-handler function. This address is passed to the hook-handler function, through its UserDataPtr parameter, when the specified event occurs. Set this parameter to M_NULL if not used.