2014-06-24 16:45:01 +05:30
< html >
< head >
< meta http-equiv = "Content-Type" content = "text/html;charset=iso-8859-1" >
< title >
2014-08-21 15:30:26 +05:30
Xilinx Driver iomodule v2_1: xiomodule.c File Reference
2014-06-24 16:45:01 +05:30
< / title >
2014-08-21 15:30:26 +05:30
< link href = "doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel = "stylesheet" type = "text/css" >
2014-06-24 16:45:01 +05:30
< / head >
< h3 class = "PageHeader" > Xilinx Processor IP Library< / h3 >
< hl > Software Drivers< / hl >
< hr class = "whs1" >
2014-08-21 15:30:26 +05:30
<!-- Generated by Doxygen 1.6.1 -->
< div class = "navigation" id = "top" >
< div class = "tabs" >
< ul >
< li > < a href = "index.html" > < span > Main Page< / span > < / a > < / li >
< li > < a href = "annotated.html" > < span > Classes< / span > < / a > < / li >
< li class = "current" > < a href = "files.html" > < span > Files< / span > < / a > < / li >
< / ul >
< / div >
< div class = "tabs" >
< ul >
< li > < a href = "files.html" > < span > File List< / span > < / a > < / li >
< li > < a href = "globals.html" > < span > File Members< / span > < / a > < / li >
< / ul >
< / div >
< / div >
< div class = "contents" >
< h1 > xiomodule.c File Reference< / h1 > < code > #include " < a class = "el" href = "xiomodule_8h.html" > xiomodule.h< / a > " < / code > < br / >
< code > #include " < a class = "el" href = "xiomodule__l_8h.html" > xiomodule_l.h< / a > " < / code > < br / >
< code > #include " < a class = "el" href = "xiomodule__i_8h.html" > xiomodule_i.h< / a > " < / code > < br / >
< code > #include " < a class = "el" href = "xiomodule__io_8h.html" > xiomodule_io.h< / a > " < / code > < br / >
< code > #include " xil_types.h" < / code > < br / >
< code > #include " xil_assert.h" < / code > < br / >
< table border = "0" cellpadding = "0" cellspacing = "0" >
< tr > < td colspan = "2" > < h2 > Functions< / h2 > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > int < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "xiomodule_8c.html#a67914ab7abde581aa2214b997923938d" > XIOModule_Initialize< / a > (< a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > *InstancePtr, u16 DeviceId)< / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > int < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "xiomodule_8c.html#a7e2fb72f58ec51dd632b89a67beb515d" > XIOModule_Start< / a > (< a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > *InstancePtr)< / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > void < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "xiomodule_8c.html#a4cd1ece524eb5fd3d5d255027ad6a01a" > XIOModule_Stop< / a > (< a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > *InstancePtr)< / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > int < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "xiomodule_8c.html#a65efd62e9193f589aa82dfa26fc90142" > XIOModule_Connect< / a > (< a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > *InstancePtr, u8 Id, XInterruptHandler < a class = "el" href = "xiomodule__uart__intr_8c.html#a7c7eb802878944c1e915ea06e07679a2" > Handler< / a > , void *CallBackRef)< / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > void < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "xiomodule_8c.html#a241c2c08f867ee4d03e96248c4a133da" > XIOModule_Disconnect< / a > (< a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > *InstancePtr, u8 Id)< / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > void < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "xiomodule_8c.html#a0c2fe0ab1367af43b603cd896e306737" > XIOModule_Enable< / a > (< a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > *InstancePtr, u8 Id)< / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > void < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "xiomodule_8c.html#a2ab631d859f9fc7b00f3c8367d763c49" > XIOModule_Disable< / a > (< a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > *InstancePtr, u8 Id)< / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > void < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "xiomodule_8c.html#a036018140fd9f14af05eec37b3cb2e93" > XIOModule_Acknowledge< / a > (< a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > *InstancePtr, u8 Id)< / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "struct_x_i_o_module___config.html" > XIOModule_Config< / a > * < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "xiomodule_8c.html#ad4112b2d6d28300c5c687e9a8d80e22d" > XIOModule_LookupConfig< / a > (u16 DeviceId)< / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > int < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "xiomodule_8c.html#a41e9fc5bdcbf29ff8675104fdef91697" > XIOModule_ConnectFastHandler< / a > (< a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > *InstancePtr, u8 Id, < a class = "el" href = "xiomodule__l_8h.html#ab333e5826535071fe60f13b70b6e56dd" > XFastInterruptHandler< / a > < a class = "el" href = "xiomodule__uart__intr_8c.html#a7c7eb802878944c1e915ea06e07679a2" > Handler< / a > )< / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > void < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "xiomodule_8c.html#ab4ddcaf38d655ca70d916c1d5ba96240" > XIOModule_SetNormalIntrMode< / a > (< a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > *InstancePtr, u8 Id)< / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > u32 < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "xiomodule_8c.html#a9f2d50c168791e08aaf44d16ca5b26a9" > XIOModule_DiscreteRead< / a > (< a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > *InstancePtr, unsigned Channel)< / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > void < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "xiomodule_8c.html#aac4051b21a264e8a6ffa80581af54108" > XIOModule_DiscreteWrite< / a > (< a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > *InstancePtr, unsigned Channel, u32 Data)< / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > int < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "xiomodule_8c.html#ad0dad0abc10925039a42855110f8256f" > XIOModule_Timer_Initialize< / a > (< a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > *InstancePtr, u16 DeviceId)< / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > void < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "xiomodule_8c.html#a622c3a5cd4e43543cfb445071d01e7a9" > XIOModule_Timer_Start< / a > (< a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > *InstancePtr, u8 TimerNumber)< / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > void < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "xiomodule_8c.html#a60bd9ef270b0de7440206326ec1fe710" > XIOModule_Timer_Stop< / a > (< a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > *InstancePtr, u8 TimerNumber)< / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > u32 < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "xiomodule_8c.html#a826357a58aeda0b2d1bfc42efd6bb94c" > XIOModule_GetValue< / a > (< a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > *InstancePtr, u8 TimerNumber)< / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > void < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "xiomodule_8c.html#af9ed2111d2f53ac88626030d907f374a" > XIOModule_SetResetValue< / a > (< a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > *InstancePtr, u8 TimerNumber, u32 ResetValue)< / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > u32 < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "xiomodule_8c.html#af4281a3f3f5e5620d4e78dc904ab04cf" > XIOModule_GetCaptureValue< / a > (< a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > *InstancePtr, u8 TimerNumber)< / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > void < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "xiomodule_8c.html#ae5d1cb85ee2100003b7e2dcc160c47c0" > XIOModule_Reset< / a > (< a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > *InstancePtr, u8 TimerNumber)< / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > int < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "xiomodule_8c.html#a65c77543ddff932f4b07da1100af984f" > XIOModule_IsExpired< / a > (< a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > *InstancePtr, u8 TimerNumber)< / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > u32 < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "xiomodule_8c.html#a9939789b5819d1561bebc0eacac28b84" > XIOModule_IoReadWord< / a > (< a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > *InstancePtr, u32 ByteOffset)< / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > u16 < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "xiomodule_8c.html#a7ff8a4fabcb27bc42957503761602439" > XIOModule_IoReadHalfword< / a > (< a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > *InstancePtr, u32 ByteOffset)< / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > u8 < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "xiomodule_8c.html#ab5ec0ed139e0e9629ec1b542dfec3989" > XIOModule_IoReadByte< / a > (< a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > *InstancePtr, u32 ByteOffset)< / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > void < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "xiomodule_8c.html#af20cdadbf9d5197fd91076a76b7049f8" > XIOModule_IoWriteWord< / a > (< a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > *InstancePtr, u32 ByteOffset, u32 Data)< / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > void < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "xiomodule_8c.html#a3c9d9b8fc1d9accc3502b24db3770664" > XIOModule_IoWriteHalfword< / a > (< a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > *InstancePtr, u32 ByteOffset, u16 Data)< / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > void < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "xiomodule_8c.html#aae3b81b7f7e0ebf69c951b2fcf438e85" > XIOModule_IoWriteByte< / a > (< a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > *InstancePtr, u32 ByteOffset, u8 Data)< / td > < / tr >
< tr > < td colspan = "2" > < h2 > Variables< / h2 > < / td > < / tr >
< tr > < td class = "memItemLeft" align = "right" valign = "top" > u32 < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "xiomodule_8c.html#ab021984b27165498eb3edbc9e2cbc939" > XIOModule_BitPosMask< / a > [XPAR_IOMODULE_INTC_MAX_INTR_SIZE]< / td > < / tr >
< / table >
< hr / > < a name = "_details" > < / a > < h2 > Detailed Description< / h2 >
< p > Contains required functions for the XIomodule driver for the Xilinx IO Module Interrupt Controller. See < a class = "el" href = "xiomodule_8h.html" > xiomodule.h< / a > for a detailed description of the driver.< / p >
2014-06-24 16:45:01 +05:30
< pre >
2014-08-21 15:30:26 +05:30
MODIFICATION HISTORY:< / pre > < pre > Ver Who Date Changes
2014-06-24 16:45:01 +05:30
----- ---- -------- --------------------------------------------------------
1.00a sa 07/15/11 First release
1.01a sa 04/10/12 Updated with fast interrupt
2.1 bss 05/02/14 Modified XIOModule_IsExpired to check for all 1's instead
of 0 in CounterReg.(CR#794167)
2014-08-21 15:30:26 +05:30
< / pre > < hr / > < h2 > Function Documentation< / h2 >
< a class = "anchor" id = "a036018140fd9f14af05eec37b3cb2e93" > < / a > <!-- doxytag: member="xiomodule.c::XIOModule_Acknowledge" ref="a036018140fd9f14af05eec37b3cb2e93" args="(XIOModule *InstancePtr, u8 Id)" -->
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
2014-06-24 16:45:01 +05:30
< tr >
2014-08-21 15:30:26 +05:30
< td class = "memname" > void XIOModule_Acknowledge < / td >
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > * < / td >
< td class = "paramname" > < em > InstancePtr< / em > , < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< tr >
2014-08-21 15:30:26 +05:30
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > u8 < / td >
< td class = "paramname" > < em > Id< / em > < / td > < td > < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< tr >
2014-08-21 15:30:26 +05:30
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td > < td > < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< / table >
2014-08-21 15:30:26 +05:30
< / div >
< div class = "memdoc" >
< p > Acknowledges the interrupt source provided as the argument Id. When the interrupt is acknowledged, it causes the interrupt controller to clear its interrupt condition.< / p >
< dl > < dt > < b > Parameters:< / b > < / dt > < dd >
2014-06-24 16:45:01 +05:30
< table border = "0" cellspacing = "2" cellpadding = "0" >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > InstancePtr< / em > < / td > < td > is a pointer to the < a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > instance to be worked on. < / td > < / tr >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > Id< / em > < / td > < td > contains the ID of the interrupt source and should be in the range of 0 to XPAR_IOMODULE_INTC_MAX_INTR_SIZE - 1 with 0 being the highest priority interrupt.< / td > < / tr >
< / table >
2014-08-21 15:30:26 +05:30
< / dd >
2014-06-24 16:45:01 +05:30
< / dl >
2014-08-21 15:30:26 +05:30
< dl class = "return" > < dt > < b > Returns:< / b > < / dt > < dd > None.< / dd > < / dl >
< dl class = "note" > < dt > < b > Note:< / b > < / dt > < dd > None. < / dd > < / dl >
< / div >
< / div >
< a class = "anchor" id = "a65efd62e9193f589aa82dfa26fc90142" > < / a > <!-- doxytag: member="xiomodule.c::XIOModule_Connect" ref="a65efd62e9193f589aa82dfa26fc90142" args="(XIOModule *InstancePtr, u8 Id, XInterruptHandler Handler, void *CallBackRef)" -->
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
2014-06-24 16:45:01 +05:30
< tr >
2014-08-21 15:30:26 +05:30
< td class = "memname" > int XIOModule_Connect < / td >
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > * < / td >
< td class = "paramname" > < em > InstancePtr< / em > , < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< tr >
2014-08-21 15:30:26 +05:30
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > u8 < / td >
< td class = "paramname" > < em > Id< / em > , < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< tr >
2014-08-21 15:30:26 +05:30
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > XInterruptHandler < / td >
< td class = "paramname" > < em > Handler< / em > , < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< tr >
2014-08-21 15:30:26 +05:30
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > void * < / td >
< td class = "paramname" > < em > CallBackRef< / em > < / td > < td > < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< tr >
2014-08-21 15:30:26 +05:30
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td > < td > < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< / table >
2014-08-21 15:30:26 +05:30
< / div >
< div class = "memdoc" >
< p > Makes the connection between the Id of the interrupt source and the associated handler that is to run when the interrupt is recognized. The argument provided in this call as the Callbackref is used as the argument for the handler when it is called.< / p >
< dl > < dt > < b > Parameters:< / b > < / dt > < dd >
2014-06-24 16:45:01 +05:30
< table border = "0" cellspacing = "2" cellpadding = "0" >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > InstancePtr< / em > < / td > < td > is a pointer to the < a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > instance to be worked on. < / td > < / tr >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > Id< / em > < / td > < td > contains the ID of the interrupt source and should be in the range of 0 to XPAR_IOMODULE_INTC_MAX_INTR_SIZE - 1 with 0 being the highest priority interrupt. < / td > < / tr >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > Handler< / em > < / td > < td > to the handler for that interrupt. < / td > < / tr >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > CallBackRef< / em > < / td > < td > is the callback reference, usually the instance pointer of the connecting driver.< / td > < / tr >
< / table >
2014-08-21 15:30:26 +05:30
< / dd >
2014-06-24 16:45:01 +05:30
< / dl >
2014-08-21 15:30:26 +05:30
< dl class = "return" > < dt > < b > Returns:< / b > < / dt > < dd > < ul >
< li > XST_SUCCESS if the handler was connected correctly.< / li >
< / ul >
2014-06-24 16:45:01 +05:30
< / dd > < / dl >
2014-08-21 15:30:26 +05:30
< dl class = "note" > < dt > < b > Note:< / b > < / dt > < dd > Only used with normal interrupt mode. Does not restore normal interrupt mode.< / dd > < / dl >
< p > WARNING: The handler provided as an argument will overwrite any handler that was previously connected. < / p >
< / div >
< / div >
< a class = "anchor" id = "a41e9fc5bdcbf29ff8675104fdef91697" > < / a > <!-- doxytag: member="xiomodule.c::XIOModule_ConnectFastHandler" ref="a41e9fc5bdcbf29ff8675104fdef91697" args="(XIOModule *InstancePtr, u8 Id, XFastInterruptHandler Handler)" -->
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
2014-06-24 16:45:01 +05:30
< tr >
2014-08-21 15:30:26 +05:30
< td class = "memname" > int XIOModule_ConnectFastHandler < / td >
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > * < / td >
< td class = "paramname" > < em > InstancePtr< / em > , < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< tr >
2014-08-21 15:30:26 +05:30
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > u8 < / td >
< td class = "paramname" > < em > Id< / em > , < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< tr >
2014-08-21 15:30:26 +05:30
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > < a class = "el" href = "xiomodule__l_8h.html#ab333e5826535071fe60f13b70b6e56dd" > XFastInterruptHandler< / a > < / td >
< td class = "paramname" > < em > Handler< / em > < / td > < td > < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< tr >
2014-08-21 15:30:26 +05:30
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td > < td > < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< / table >
2014-08-21 15:30:26 +05:30
< / div >
< div class = "memdoc" >
< p > Makes the connection between the Id of the interrupt source and the associated handler that is to run when the interrupt is recognized.< / p >
< dl > < dt > < b > Parameters:< / b > < / dt > < dd >
2014-06-24 16:45:01 +05:30
< table border = "0" cellspacing = "2" cellpadding = "0" >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > InstancePtr< / em > < / td > < td > is a pointer to the < a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > instance. < / td > < / tr >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > Id< / em > < / td > < td > contains the ID of the interrupt source and should be in the range of 0 to XPAR_INTC_MAX_NUM_INTR_INPUTS - 1 with 0 being the highest priority interrupt. < / td > < / tr >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > Handler< / em > < / td > < td > to the handler for that interrupt.< / td > < / tr >
< / table >
2014-08-21 15:30:26 +05:30
< / dd >
2014-06-24 16:45:01 +05:30
< / dl >
2014-08-21 15:30:26 +05:30
< dl class = "return" > < dt > < b > Returns:< / b > < / dt > < dd > < ul >
< li > XST_SUCCESS if the handler was connected correctly.< / li >
< / ul >
2014-06-24 16:45:01 +05:30
< / dd > < / dl >
2014-08-21 15:30:26 +05:30
< dl class = "note" > < dt > < b > Note:< / b > < / dt > < dd > Only used with fast interrupt mode.< / dd > < / dl >
< p > WARNING: The handler provided as an argument will overwrite any handler that was previously connected. < / p >
< / div >
< / div >
< a class = "anchor" id = "a2ab631d859f9fc7b00f3c8367d763c49" > < / a > <!-- doxytag: member="xiomodule.c::XIOModule_Disable" ref="a2ab631d859f9fc7b00f3c8367d763c49" args="(XIOModule *InstancePtr, u8 Id)" -->
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
2014-06-24 16:45:01 +05:30
< tr >
2014-08-21 15:30:26 +05:30
< td class = "memname" > void XIOModule_Disable < / td >
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > * < / td >
< td class = "paramname" > < em > InstancePtr< / em > , < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< tr >
2014-08-21 15:30:26 +05:30
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > u8 < / td >
< td class = "paramname" > < em > Id< / em > < / td > < td > < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< tr >
2014-08-21 15:30:26 +05:30
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td > < td > < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< / table >
2014-08-21 15:30:26 +05:30
< / div >
< div class = "memdoc" >
< p > Disables the interrupt source provided as the argument Id such that the interrupt controller will not cause interrupts for the specified Id. The interrupt controller will continue to hold an interrupt condition for the Id, but will not cause an interrupt.< / p >
< dl > < dt > < b > Parameters:< / b > < / dt > < dd >
2014-06-24 16:45:01 +05:30
< table border = "0" cellspacing = "2" cellpadding = "0" >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > InstancePtr< / em > < / td > < td > is a pointer to the < a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > instance to be worked on. < / td > < / tr >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > Id< / em > < / td > < td > contains the ID of the interrupt source and should be in the range of 0 to XPAR_IOMODULE_INTC_MAX_INTR_SIZE - 1 with 0 being the highest priority interrupt.< / td > < / tr >
< / table >
2014-08-21 15:30:26 +05:30
< / dd >
2014-06-24 16:45:01 +05:30
< / dl >
2014-08-21 15:30:26 +05:30
< dl class = "return" > < dt > < b > Returns:< / b > < / dt > < dd > None.< / dd > < / dl >
< dl class = "note" > < dt > < b > Note:< / b > < / dt > < dd > None. < / dd > < / dl >
< / div >
< / div >
< a class = "anchor" id = "a241c2c08f867ee4d03e96248c4a133da" > < / a > <!-- doxytag: member="xiomodule.c::XIOModule_Disconnect" ref="a241c2c08f867ee4d03e96248c4a133da" args="(XIOModule *InstancePtr, u8 Id)" -->
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
2014-06-24 16:45:01 +05:30
< tr >
2014-08-21 15:30:26 +05:30
< td class = "memname" > void XIOModule_Disconnect < / td >
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > * < / td >
< td class = "paramname" > < em > InstancePtr< / em > , < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< tr >
2014-08-21 15:30:26 +05:30
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > u8 < / td >
< td class = "paramname" > < em > Id< / em > < / td > < td > < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< tr >
2014-08-21 15:30:26 +05:30
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td > < td > < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< / table >
2014-08-21 15:30:26 +05:30
< / div >
< div class = "memdoc" >
< p > Updates the interrupt table with the Null Handler and NULL arguments at the location pointed at by the Id. This effectively disconnects that interrupt source from any handler. The interrupt is disabled also.< / p >
< dl > < dt > < b > Parameters:< / b > < / dt > < dd >
2014-06-24 16:45:01 +05:30
< table border = "0" cellspacing = "2" cellpadding = "0" >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > InstancePtr< / em > < / td > < td > is a pointer to the < a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > instance to be worked on. < / td > < / tr >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > Id< / em > < / td > < td > contains the ID of the interrupt source and should be in the range of 0 to XPAR_IOMODULE_INTC_MAX_INTR_SIZE - 1 with 0 being the highest priority interrupt.< / td > < / tr >
< / table >
2014-08-21 15:30:26 +05:30
< / dd >
2014-06-24 16:45:01 +05:30
< / dl >
2014-08-21 15:30:26 +05:30
< dl class = "return" > < dt > < b > Returns:< / b > < / dt > < dd > None.< / dd > < / dl >
< dl class = "note" > < dt > < b > Note:< / b > < / dt > < dd > None. < / dd > < / dl >
< / div >
< / div >
< a class = "anchor" id = "a9f2d50c168791e08aaf44d16ca5b26a9" > < / a > <!-- doxytag: member="xiomodule.c::XIOModule_DiscreteRead" ref="a9f2d50c168791e08aaf44d16ca5b26a9" args="(XIOModule *InstancePtr, unsigned Channel)" -->
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
2014-06-24 16:45:01 +05:30
< tr >
2014-08-21 15:30:26 +05:30
< td class = "memname" > u32 XIOModule_DiscreteRead < / td >
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > * < / td >
< td class = "paramname" > < em > InstancePtr< / em > , < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< tr >
2014-08-21 15:30:26 +05:30
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > unsigned < / td >
< td class = "paramname" > < em > Channel< / em > < / td > < td > < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< tr >
2014-08-21 15:30:26 +05:30
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td > < td > < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< / table >
2014-08-21 15:30:26 +05:30
< / div >
< div class = "memdoc" >
< p > Read state of discretes for the specified GPI channnel.< / p >
< dl > < dt > < b > Parameters:< / b > < / dt > < dd >
2014-06-24 16:45:01 +05:30
< table border = "0" cellspacing = "2" cellpadding = "0" >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > InstancePtr< / em > < / td > < td > is a pointer to an < a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > instance to be worked on. < / td > < / tr >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > Channel< / em > < / td > < td > contains the channel of the GPI (1, 2, 3 or 4) to operate on.< / td > < / tr >
< / table >
2014-08-21 15:30:26 +05:30
< / dd >
2014-06-24 16:45:01 +05:30
< / dl >
2014-08-21 15:30:26 +05:30
< dl class = "return" > < dt > < b > Returns:< / b > < / dt > < dd > Current copy of the discretes register. < / dd > < / dl >
< / div >
< / div >
< a class = "anchor" id = "aac4051b21a264e8a6ffa80581af54108" > < / a > <!-- doxytag: member="xiomodule.c::XIOModule_DiscreteWrite" ref="aac4051b21a264e8a6ffa80581af54108" args="(XIOModule *InstancePtr, unsigned Channel, u32 Data)" -->
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
2014-06-24 16:45:01 +05:30
< tr >
2014-08-21 15:30:26 +05:30
< td class = "memname" > void XIOModule_DiscreteWrite < / td >
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > * < / td >
< td class = "paramname" > < em > InstancePtr< / em > , < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< tr >
2014-08-21 15:30:26 +05:30
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > unsigned < / td >
< td class = "paramname" > < em > Channel< / em > , < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< tr >
2014-08-21 15:30:26 +05:30
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > u32 < / td >
< td class = "paramname" > < em > Data< / em > < / td > < td > < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< tr >
2014-08-21 15:30:26 +05:30
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td > < td > < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< / table >
2014-08-21 15:30:26 +05:30
< / div >
< div class = "memdoc" >
< p > Write to discretes register for the specified GPO channel.< / p >
< dl > < dt > < b > Parameters:< / b > < / dt > < dd >
2014-06-24 16:45:01 +05:30
< table border = "0" cellspacing = "2" cellpadding = "0" >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > InstancePtr< / em > < / td > < td > is a pointer to an < a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > instance to be worked on. < / td > < / tr >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > Channel< / em > < / td > < td > contains the channel of the GPO (1, 2, 3 or 4) to operate on. < / td > < / tr >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > Data< / em > < / td > < td > is the value to be written to the discretes register.< / td > < / tr >
< / table >
2014-08-21 15:30:26 +05:30
< / dd >
2014-06-24 16:45:01 +05:30
< / dl >
2014-08-21 15:30:26 +05:30
< dl class = "return" > < dt > < b > Returns:< / b > < / dt > < dd > None. < / dd > < / dl >
< / div >
< / div >
< a class = "anchor" id = "a0c2fe0ab1367af43b603cd896e306737" > < / a > <!-- doxytag: member="xiomodule.c::XIOModule_Enable" ref="a0c2fe0ab1367af43b603cd896e306737" args="(XIOModule *InstancePtr, u8 Id)" -->
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
2014-06-24 16:45:01 +05:30
< tr >
2014-08-21 15:30:26 +05:30
< td class = "memname" > void XIOModule_Enable < / td >
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > * < / td >
< td class = "paramname" > < em > InstancePtr< / em > , < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< tr >
2014-08-21 15:30:26 +05:30
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > u8 < / td >
< td class = "paramname" > < em > Id< / em > < / td > < td > < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< tr >
2014-08-21 15:30:26 +05:30
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td > < td > < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< / table >
2014-08-21 15:30:26 +05:30
< / div >
< div class = "memdoc" >
< p > Enables the interrupt source provided as the argument Id. Any pending interrupt condition for the specified Id will occur after this function is called.< / p >
< dl > < dt > < b > Parameters:< / b > < / dt > < dd >
2014-06-24 16:45:01 +05:30
< table border = "0" cellspacing = "2" cellpadding = "0" >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > InstancePtr< / em > < / td > < td > is a pointer to the < a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > instance to be worked on. < / td > < / tr >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > Id< / em > < / td > < td > contains the ID of the interrupt source and should be in the range of 0 to XPAR_IOMODULE_INTC_MAX_INTR_SIZE - 1 with 0 being the highest priority interrupt.< / td > < / tr >
< / table >
2014-08-21 15:30:26 +05:30
< / dd >
2014-06-24 16:45:01 +05:30
< / dl >
2014-08-21 15:30:26 +05:30
< dl class = "return" > < dt > < b > Returns:< / b > < / dt > < dd > None.< / dd > < / dl >
< dl class = "note" > < dt > < b > Note:< / b > < / dt > < dd > None. < / dd > < / dl >
< / div >
< / div >
< a class = "anchor" id = "af4281a3f3f5e5620d4e78dc904ab04cf" > < / a > <!-- doxytag: member="xiomodule.c::XIOModule_GetCaptureValue" ref="af4281a3f3f5e5620d4e78dc904ab04cf" args="(XIOModule *InstancePtr, u8 TimerNumber)" -->
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
2014-06-24 16:45:01 +05:30
< tr >
2014-08-21 15:30:26 +05:30
< td class = "memname" > u32 XIOModule_GetCaptureValue < / td >
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > * < / td >
< td class = "paramname" > < em > InstancePtr< / em > , < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< tr >
2014-08-21 15:30:26 +05:30
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > u8 < / td >
< td class = "paramname" > < em > TimerNumber< / em > < / td > < td > < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< tr >
2014-08-21 15:30:26 +05:30
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td > < td > < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< / table >
2014-08-21 15:30:26 +05:30
< / div >
< div class = "memdoc" >
< p > Returns the timer counter value that was captured the last time the external capture input was asserted.< / p >
< dl > < dt > < b > Parameters:< / b > < / dt > < dd >
2014-06-24 16:45:01 +05:30
< table border = "0" cellspacing = "2" cellpadding = "0" >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > InstancePtr< / em > < / td > < td > is a pointer to the < a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > instance. < / td > < / tr >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > TimerNumber< / em > < / td > < td > is the timer counter of the device to operate on. Each device may contain multiple timer counters. The timer number is a zero based number with a range of 0 to (XTC_DEVICE_TIMER_COUNT - 1).< / td > < / tr >
< / table >
2014-08-21 15:30:26 +05:30
< / dd >
2014-06-24 16:45:01 +05:30
< / dl >
2014-08-21 15:30:26 +05:30
< dl class = "return" > < dt > < b > Returns:< / b > < / dt > < dd > The current capture value for the indicated timer counter.< / dd > < / dl >
< dl class = "note" > < dt > < b > Note:< / b > < / dt > < dd > None. < / dd > < / dl >
< / div >
< / div >
< a class = "anchor" id = "a826357a58aeda0b2d1bfc42efd6bb94c" > < / a > <!-- doxytag: member="xiomodule.c::XIOModule_GetValue" ref="a826357a58aeda0b2d1bfc42efd6bb94c" args="(XIOModule *InstancePtr, u8 TimerNumber)" -->
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
2014-06-24 16:45:01 +05:30
< tr >
2014-08-21 15:30:26 +05:30
< td class = "memname" > u32 XIOModule_GetValue < / td >
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > * < / td >
< td class = "paramname" > < em > InstancePtr< / em > , < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< tr >
2014-08-21 15:30:26 +05:30
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > u8 < / td >
< td class = "paramname" > < em > TimerNumber< / em > < / td > < td > < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< tr >
2014-08-21 15:30:26 +05:30
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td > < td > < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< / table >
2014-08-21 15:30:26 +05:30
< / div >
< div class = "memdoc" >
< p > Get the current value of the specified timer counter. The timer counter may be either incrementing or decrementing based upon the current mode of operation.< / p >
< dl > < dt > < b > Parameters:< / b > < / dt > < dd >
2014-06-24 16:45:01 +05:30
< table border = "0" cellspacing = "2" cellpadding = "0" >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > InstancePtr< / em > < / td > < td > is a pointer to the < a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > instance. < / td > < / tr >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > TimerNumber< / em > < / td > < td > is the timer counter of the device to operate on. Each device may contain multiple timer counters. The timer number is a zero based number with a range of 0 to (XTC_DEVICE_TIMER_COUNT - 1).< / td > < / tr >
< / table >
2014-08-21 15:30:26 +05:30
< / dd >
2014-06-24 16:45:01 +05:30
< / dl >
2014-08-21 15:30:26 +05:30
< dl class = "return" > < dt > < b > Returns:< / b > < / dt > < dd > The current value for the timer counter.< / dd > < / dl >
< dl class = "note" > < dt > < b > Note:< / b > < / dt > < dd > None. < / dd > < / dl >
< / div >
< / div >
< a class = "anchor" id = "a67914ab7abde581aa2214b997923938d" > < / a > <!-- doxytag: member="xiomodule.c::XIOModule_Initialize" ref="a67914ab7abde581aa2214b997923938d" args="(XIOModule *InstancePtr, u16 DeviceId)" -->
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
2014-06-24 16:45:01 +05:30
< tr >
2014-08-21 15:30:26 +05:30
< td class = "memname" > int XIOModule_Initialize < / td >
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > * < / td >
< td class = "paramname" > < em > InstancePtr< / em > , < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< tr >
2014-08-21 15:30:26 +05:30
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > u16 < / td >
< td class = "paramname" > < em > DeviceId< / em > < / td > < td > < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< tr >
2014-08-21 15:30:26 +05:30
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td > < td > < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< / table >
2014-08-21 15:30:26 +05:30
< / div >
< div class = "memdoc" >
< p > Initialize a specific interrupt controller instance/driver. The initialization entails:< / p >
2014-06-24 16:45:01 +05:30
< ul >
2014-08-21 15:30:26 +05:30
< li > Initialize fields of the < a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > structure< / li >
< li > Initial vector table with stub function calls< / li >
< li > All interrupt sources are disabled< / li >
< li > Interrupt output is disabled< / li >
< li > All timers are initialized< / li >
< / ul >
< dl > < dt > < b > Parameters:< / b > < / dt > < dd >
2014-06-24 16:45:01 +05:30
< table border = "0" cellspacing = "2" cellpadding = "0" >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > InstancePtr< / em > < / td > < td > is a pointer to the < a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > instance to be worked on. < / td > < / tr >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > DeviceId< / em > < / td > < td > is the unique id of the device controlled by this < a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > instance. Passing in a device id associates the generic < a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > instance to a specific device, as chosen by the caller or application developer.< / td > < / tr >
< / table >
2014-08-21 15:30:26 +05:30
< / dd >
2014-06-24 16:45:01 +05:30
< / dl >
2014-08-21 15:30:26 +05:30
< dl class = "return" > < dt > < b > Returns:< / b > < / dt > < dd > < ul >
< li > XST_SUCCESS if initialization was successful< / li >
< li > XST_DEVICE_IS_STARTED if the device has already been started< / li >
< li > XST_DEVICE_NOT_FOUND if device configuration information was not found for a device with the supplied device ID.< / li >
< / ul >
2014-06-24 16:45:01 +05:30
< / dd > < / dl >
2014-08-21 15:30:26 +05:30
< dl class = "note" > < dt > < b > Note:< / b > < / dt > < dd > None. < / dd > < / dl >
< / div >
< / div >
< a class = "anchor" id = "ab5ec0ed139e0e9629ec1b542dfec3989" > < / a > <!-- doxytag: member="xiomodule.c::XIOModule_IoReadByte" ref="ab5ec0ed139e0e9629ec1b542dfec3989" args="(XIOModule *InstancePtr, u32 ByteOffset)" -->
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
2014-06-24 16:45:01 +05:30
< tr >
2014-08-21 15:30:26 +05:30
< td class = "memname" > u8 XIOModule_IoReadByte < / td >
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > * < / td >
< td class = "paramname" > < em > InstancePtr< / em > , < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< tr >
2014-08-21 15:30:26 +05:30
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > u32 < / td >
< td class = "paramname" > < em > ByteOffset< / em > < / td > < td > < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< tr >
2014-08-21 15:30:26 +05:30
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td > < td > < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< / table >
2014-08-21 15:30:26 +05:30
< / div >
< div class = "memdoc" >
< p > Read byte from the IO Bus memory mapped IO< / p >
< dl > < dt > < b > Parameters:< / b > < / dt > < dd >
2014-06-24 16:45:01 +05:30
< table border = "0" cellspacing = "2" cellpadding = "0" >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > InstancePtr< / em > < / td > < td > is a pointer to an < a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > instance to be worked on. < / td > < / tr >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > ByteOffset< / em > < / td > < td > is a byte offset from the beginning of the IO Bus address area< / td > < / tr >
< / table >
2014-08-21 15:30:26 +05:30
< / dd >
2014-06-24 16:45:01 +05:30
< / dl >
2014-08-21 15:30:26 +05:30
< dl class = "return" > < dt > < b > Returns:< / b > < / dt > < dd > Value read from the IO Bus - 8-bit byte < / dd > < / dl >
< / div >
< / div >
< a class = "anchor" id = "a7ff8a4fabcb27bc42957503761602439" > < / a > <!-- doxytag: member="xiomodule.c::XIOModule_IoReadHalfword" ref="a7ff8a4fabcb27bc42957503761602439" args="(XIOModule *InstancePtr, u32 ByteOffset)" -->
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
2014-06-24 16:45:01 +05:30
< tr >
2014-08-21 15:30:26 +05:30
< td class = "memname" > u16 XIOModule_IoReadHalfword < / td >
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > * < / td >
< td class = "paramname" > < em > InstancePtr< / em > , < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< tr >
2014-08-21 15:30:26 +05:30
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > u32 < / td >
< td class = "paramname" > < em > ByteOffset< / em > < / td > < td > < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< tr >
2014-08-21 15:30:26 +05:30
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td > < td > < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< / table >
2014-08-21 15:30:26 +05:30
< / div >
< div class = "memdoc" >
< p > Read 16-bit halfword from the IO Bus memory mapped IO< / p >
< dl > < dt > < b > Parameters:< / b > < / dt > < dd >
2014-06-24 16:45:01 +05:30
< table border = "0" cellspacing = "2" cellpadding = "0" >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > InstancePtr< / em > < / td > < td > is a pointer to an < a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > instance to be worked on. < / td > < / tr >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > ByteOffset< / em > < / td > < td > is a byte offset from the beginning of the IO Bus address area< / td > < / tr >
< / table >
2014-08-21 15:30:26 +05:30
< / dd >
2014-06-24 16:45:01 +05:30
< / dl >
2014-08-21 15:30:26 +05:30
< dl class = "return" > < dt > < b > Returns:< / b > < / dt > < dd > Value read from the IO Bus - 16-bit halfword < / dd > < / dl >
< / div >
< / div >
< a class = "anchor" id = "a9939789b5819d1561bebc0eacac28b84" > < / a > <!-- doxytag: member="xiomodule.c::XIOModule_IoReadWord" ref="a9939789b5819d1561bebc0eacac28b84" args="(XIOModule *InstancePtr, u32 ByteOffset)" -->
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
2014-06-24 16:45:01 +05:30
< tr >
2014-08-21 15:30:26 +05:30
< td class = "memname" > u32 XIOModule_IoReadWord < / td >
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > * < / td >
< td class = "paramname" > < em > InstancePtr< / em > , < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< tr >
2014-08-21 15:30:26 +05:30
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > u32 < / td >
< td class = "paramname" > < em > ByteOffset< / em > < / td > < td > < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< tr >
2014-08-21 15:30:26 +05:30
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td > < td > < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< / table >
2014-08-21 15:30:26 +05:30
< / div >
< div class = "memdoc" >
< p > Read 32-bit word from the IO Bus memory mapped IO< / p >
< dl > < dt > < b > Parameters:< / b > < / dt > < dd >
2014-06-24 16:45:01 +05:30
< table border = "0" cellspacing = "2" cellpadding = "0" >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > InstancePtr< / em > < / td > < td > is a pointer to an < a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > instance to be worked on. < / td > < / tr >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > ByteOffset< / em > < / td > < td > is a byte offset from the beginning of the IO Bus address area< / td > < / tr >
< / table >
2014-08-21 15:30:26 +05:30
< / dd >
2014-06-24 16:45:01 +05:30
< / dl >
2014-08-21 15:30:26 +05:30
< dl class = "return" > < dt > < b > Returns:< / b > < / dt > < dd > Value read from the IO Bus - 32-bit word < / dd > < / dl >
< / div >
< / div >
< a class = "anchor" id = "aae3b81b7f7e0ebf69c951b2fcf438e85" > < / a > <!-- doxytag: member="xiomodule.c::XIOModule_IoWriteByte" ref="aae3b81b7f7e0ebf69c951b2fcf438e85" args="(XIOModule *InstancePtr, u32 ByteOffset, u8 Data)" -->
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
2014-06-24 16:45:01 +05:30
< tr >
2014-08-21 15:30:26 +05:30
< td class = "memname" > void XIOModule_IoWriteByte < / td >
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > * < / td >
< td class = "paramname" > < em > InstancePtr< / em > , < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< tr >
2014-08-21 15:30:26 +05:30
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > u32 < / td >
< td class = "paramname" > < em > ByteOffset< / em > , < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< tr >
2014-08-21 15:30:26 +05:30
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > u8 < / td >
< td class = "paramname" > < em > Data< / em > < / td > < td > < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< tr >
2014-08-21 15:30:26 +05:30
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td > < td > < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< / table >
2014-08-21 15:30:26 +05:30
< / div >
< div class = "memdoc" >
< p > Write 8-bit word to the IO Bus memory mapped IO< / p >
< dl > < dt > < b > Parameters:< / b > < / dt > < dd >
2014-06-24 16:45:01 +05:30
< table border = "0" cellspacing = "2" cellpadding = "0" >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > InstancePtr< / em > < / td > < td > is a pointer to an < a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > instance to be worked on. < / td > < / tr >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > ByteOffset< / em > < / td > < td > is a byte offset from the beginning of the IO Bus address area < / td > < / tr >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > Data< / em > < / td > < td > is the value to be written to the IO Bus - 8-bit< / td > < / tr >
< / table >
2014-08-21 15:30:26 +05:30
< / dd >
2014-06-24 16:45:01 +05:30
< / dl >
2014-08-21 15:30:26 +05:30
< dl class = "return" > < dt > < b > Returns:< / b > < / dt > < dd > None. < / dd > < / dl >
< / div >
< / div >
< a class = "anchor" id = "a3c9d9b8fc1d9accc3502b24db3770664" > < / a > <!-- doxytag: member="xiomodule.c::XIOModule_IoWriteHalfword" ref="a3c9d9b8fc1d9accc3502b24db3770664" args="(XIOModule *InstancePtr, u32 ByteOffset, u16 Data)" -->
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
2014-06-24 16:45:01 +05:30
< tr >
2014-08-21 15:30:26 +05:30
< td class = "memname" > void XIOModule_IoWriteHalfword < / td >
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > * < / td >
< td class = "paramname" > < em > InstancePtr< / em > , < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< tr >
2014-08-21 15:30:26 +05:30
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > u32 < / td >
< td class = "paramname" > < em > ByteOffset< / em > , < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< tr >
2014-08-21 15:30:26 +05:30
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > u16 < / td >
< td class = "paramname" > < em > Data< / em > < / td > < td > < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< tr >
2014-08-21 15:30:26 +05:30
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td > < td > < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< / table >
2014-08-21 15:30:26 +05:30
< / div >
< div class = "memdoc" >
< p > Write 16-bit word to the IO Bus memory mapped IO< / p >
< dl > < dt > < b > Parameters:< / b > < / dt > < dd >
2014-06-24 16:45:01 +05:30
< table border = "0" cellspacing = "2" cellpadding = "0" >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > InstancePtr< / em > < / td > < td > is a pointer to an < a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > instance to be worked on. < / td > < / tr >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > ByteOffset< / em > < / td > < td > is a byte offset from the beginning of the IO Bus address area < / td > < / tr >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > Data< / em > < / td > < td > is the value to be written to the IO Bus - 16-bit< / td > < / tr >
< / table >
2014-08-21 15:30:26 +05:30
< / dd >
2014-06-24 16:45:01 +05:30
< / dl >
2014-08-21 15:30:26 +05:30
< dl class = "return" > < dt > < b > Returns:< / b > < / dt > < dd > None. < / dd > < / dl >
< / div >
< / div >
< a class = "anchor" id = "af20cdadbf9d5197fd91076a76b7049f8" > < / a > <!-- doxytag: member="xiomodule.c::XIOModule_IoWriteWord" ref="af20cdadbf9d5197fd91076a76b7049f8" args="(XIOModule *InstancePtr, u32 ByteOffset, u32 Data)" -->
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
2014-06-24 16:45:01 +05:30
< tr >
2014-08-21 15:30:26 +05:30
< td class = "memname" > void XIOModule_IoWriteWord < / td >
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > * < / td >
< td class = "paramname" > < em > InstancePtr< / em > , < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< tr >
2014-08-21 15:30:26 +05:30
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > u32 < / td >
< td class = "paramname" > < em > ByteOffset< / em > , < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< tr >
2014-08-21 15:30:26 +05:30
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > u32 < / td >
< td class = "paramname" > < em > Data< / em > < / td > < td > < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< tr >
2014-08-21 15:30:26 +05:30
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td > < td > < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< / table >
2014-08-21 15:30:26 +05:30
< / div >
< div class = "memdoc" >
< p > Write 32-bit word to the IO Bus memory mapped IO< / p >
< dl > < dt > < b > Parameters:< / b > < / dt > < dd >
2014-06-24 16:45:01 +05:30
< table border = "0" cellspacing = "2" cellpadding = "0" >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > InstancePtr< / em > < / td > < td > is a pointer to an < a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > instance to be worked on. < / td > < / tr >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > ByteOffset< / em > < / td > < td > is a byte offset from the beginning of the IO Bus address area < / td > < / tr >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > Data< / em > < / td > < td > is the value to be written to the IO Bus - 32-bit< / td > < / tr >
< / table >
2014-08-21 15:30:26 +05:30
< / dd >
2014-06-24 16:45:01 +05:30
< / dl >
2014-08-21 15:30:26 +05:30
< dl class = "return" > < dt > < b > Returns:< / b > < / dt > < dd > None. < / dd > < / dl >
< / div >
< / div >
< a class = "anchor" id = "a65c77543ddff932f4b07da1100af984f" > < / a > <!-- doxytag: member="xiomodule.c::XIOModule_IsExpired" ref="a65c77543ddff932f4b07da1100af984f" args="(XIOModule *InstancePtr, u8 TimerNumber)" -->
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
2014-06-24 16:45:01 +05:30
< tr >
2014-08-21 15:30:26 +05:30
< td class = "memname" > int XIOModule_IsExpired < / td >
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > * < / td >
< td class = "paramname" > < em > InstancePtr< / em > , < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< tr >
2014-08-21 15:30:26 +05:30
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > u8 < / td >
< td class = "paramname" > < em > TimerNumber< / em > < / td > < td > < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< tr >
2014-08-21 15:30:26 +05:30
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td > < td > < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< / table >
2014-08-21 15:30:26 +05:30
< / div >
< div class = "memdoc" >
< p > Checks if the specified timer counter of the device has expired. In capture mode, expired is defined as a capture occurred. In compare mode, expired is defined as the timer counter rolled over/under for up/down counting.< / p >
< p > When interrupts are enabled, the expiration causes an interrupt. This function is typically used to poll a timer counter to determine when it has expired.< / p >
< dl > < dt > < b > Parameters:< / b > < / dt > < dd >
2014-06-24 16:45:01 +05:30
< table border = "0" cellspacing = "2" cellpadding = "0" >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > InstancePtr< / em > < / td > < td > is a pointer to the < a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > instance. < / td > < / tr >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > TimerNumber< / em > < / td > < td > is the timer counter of the device to operate on. Each device may contain multiple timer counters. The timer number is a zero based number with a range of 0 to (XTC_DEVICE_TIMER_COUNT - 1).< / td > < / tr >
< / table >
2014-08-21 15:30:26 +05:30
< / dd >
2014-06-24 16:45:01 +05:30
< / dl >
2014-08-21 15:30:26 +05:30
< dl class = "return" > < dt > < b > Returns:< / b > < / dt > < dd > TRUE if the timer has expired, and FALSE otherwise.< / dd > < / dl >
< dl class = "note" > < dt > < b > Note:< / b > < / dt > < dd > None. < / dd > < / dl >
< / div >
< / div >
< a class = "anchor" id = "ad4112b2d6d28300c5c687e9a8d80e22d" > < / a > <!-- doxytag: member="xiomodule.c::XIOModule_LookupConfig" ref="ad4112b2d6d28300c5c687e9a8d80e22d" args="(u16 DeviceId)" -->
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > < a class = "el" href = "struct_x_i_o_module___config.html" > XIOModule_Config< / a > * XIOModule_LookupConfig < / td >
< td > (< / td >
< td class = "paramtype" > u16 < / td >
< td class = "paramname" > < em > DeviceId< / em > < / td >
< td > ) < / td >
< td > < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< / table >
2014-08-21 15:30:26 +05:30
< / div >
< div class = "memdoc" >
< p > Looks up the device configuration based on the unique device ID. A table contains the configuration info for each device in the system.< / p >
< dl > < dt > < b > Parameters:< / b > < / dt > < dd >
2014-06-24 16:45:01 +05:30
< table border = "0" cellspacing = "2" cellpadding = "0" >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > DeviceId< / em > < / td > < td > is the unique identifier for a device.< / td > < / tr >
< / table >
2014-08-21 15:30:26 +05:30
< / dd >
2014-06-24 16:45:01 +05:30
< / dl >
2014-08-21 15:30:26 +05:30
< dl class = "return" > < dt > < b > Returns:< / b > < / dt > < dd > A pointer to the < a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > configuration structure for the specified device, or NULL if the device was not found.< / dd > < / dl >
< dl class = "note" > < dt > < b > Note:< / b > < / dt > < dd > None. < / dd > < / dl >
< / div >
< / div >
< a class = "anchor" id = "ae5d1cb85ee2100003b7e2dcc160c47c0" > < / a > <!-- doxytag: member="xiomodule.c::XIOModule_Reset" ref="ae5d1cb85ee2100003b7e2dcc160c47c0" args="(XIOModule *InstancePtr, u8 TimerNumber)" -->
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
2014-06-24 16:45:01 +05:30
< tr >
2014-08-21 15:30:26 +05:30
< td class = "memname" > void XIOModule_Reset < / td >
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > * < / td >
< td class = "paramname" > < em > InstancePtr< / em > , < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< tr >
2014-08-21 15:30:26 +05:30
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > u8 < / td >
< td class = "paramname" > < em > TimerNumber< / em > < / td > < td > < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< tr >
2014-08-21 15:30:26 +05:30
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td > < td > < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< / table >
2014-08-21 15:30:26 +05:30
< / div >
< div class = "memdoc" >
< p > Resets the specified timer counter of the device. A reset causes the timer counter to set it's value to the reset value.< / p >
< dl > < dt > < b > Parameters:< / b > < / dt > < dd >
2014-06-24 16:45:01 +05:30
< table border = "0" cellspacing = "2" cellpadding = "0" >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > InstancePtr< / em > < / td > < td > is a pointer to the < a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > instance. < / td > < / tr >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > TimerNumber< / em > < / td > < td > is the timer counter of the device to operate on. Each device may contain multiple timer counters. The timer number is a zero based number with a range of 0 to (XTC_DEVICE_TIMER_COUNT - 1).< / td > < / tr >
< / table >
2014-08-21 15:30:26 +05:30
< / dd >
2014-06-24 16:45:01 +05:30
< / dl >
2014-08-21 15:30:26 +05:30
< dl class = "return" > < dt > < b > Returns:< / b > < / dt > < dd > None.< / dd > < / dl >
< dl class = "note" > < dt > < b > Note:< / b > < / dt > < dd > None. < / dd > < / dl >
< / div >
< / div >
< a class = "anchor" id = "ab4ddcaf38d655ca70d916c1d5ba96240" > < / a > <!-- doxytag: member="xiomodule.c::XIOModule_SetNormalIntrMode" ref="ab4ddcaf38d655ca70d916c1d5ba96240" args="(XIOModule *InstancePtr, u8 Id)" -->
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
2014-06-24 16:45:01 +05:30
< tr >
2014-08-21 15:30:26 +05:30
< td class = "memname" > void XIOModule_SetNormalIntrMode < / td >
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > * < / td >
< td class = "paramname" > < em > InstancePtr< / em > , < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< tr >
2014-08-21 15:30:26 +05:30
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > u8 < / td >
< td class = "paramname" > < em > Id< / em > < / td > < td > < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< tr >
2014-08-21 15:30:26 +05:30
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td > < td > < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< / table >
2014-08-21 15:30:26 +05:30
< / div >
< div class = "memdoc" >
< p > Sets the normal interrupt mode for the specified interrupt in the Interrupt Mode Register, by resetting the vector to (BaseVector & 0xFFFFFF80) | 0x10 and selecting normal mode.< / p >
< dl > < dt > < b > Parameters:< / b > < / dt > < dd >
2014-06-24 16:45:01 +05:30
< table border = "0" cellspacing = "2" cellpadding = "0" >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > InstancePtr< / em > < / td > < td > is a pointer to the < a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > instance. < / td > < / tr >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > Id< / em > < / td > < td > contains the ID of the interrupt source and should be in the range of 0 to XPAR_INTC_MAX_NUM_INTR_INPUTS - 1 with 0 being the highest priority interrupt.< / td > < / tr >
< / table >
2014-08-21 15:30:26 +05:30
< / dd >
2014-06-24 16:45:01 +05:30
< / dl >
2014-08-21 15:30:26 +05:30
< dl class = "return" > < dt > < b > Returns:< / b > < / dt > < dd > None.< / dd > < / dl >
< dl class = "note" > < dt > < b > Note:< / b > < / dt > < dd > Only used with fast interrupt mode. < / dd > < / dl >
< / div >
< / div >
< a class = "anchor" id = "af9ed2111d2f53ac88626030d907f374a" > < / a > <!-- doxytag: member="xiomodule.c::XIOModule_SetResetValue" ref="af9ed2111d2f53ac88626030d907f374a" args="(XIOModule *InstancePtr, u8 TimerNumber, u32 ResetValue)" -->
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
2014-06-24 16:45:01 +05:30
< tr >
2014-08-21 15:30:26 +05:30
< td class = "memname" > void XIOModule_SetResetValue < / td >
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > * < / td >
< td class = "paramname" > < em > InstancePtr< / em > , < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< tr >
2014-08-21 15:30:26 +05:30
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > u8 < / td >
< td class = "paramname" > < em > TimerNumber< / em > , < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< tr >
2014-08-21 15:30:26 +05:30
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > u32 < / td >
< td class = "paramname" > < em > ResetValue< / em > < / td > < td > < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< tr >
2014-08-21 15:30:26 +05:30
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td > < td > < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< / table >
2014-08-21 15:30:26 +05:30
< / div >
< div class = "memdoc" >
< p > Set the reset value for the specified timer counter. This is the value that is loaded into the timer counter when it is reset. This value is also loaded when the timer counter is started.< / p >
< dl > < dt > < b > Parameters:< / b > < / dt > < dd >
2014-06-24 16:45:01 +05:30
< table border = "0" cellspacing = "2" cellpadding = "0" >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > InstancePtr< / em > < / td > < td > is a pointer to the < a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > instance. < / td > < / tr >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > TimerNumber< / em > < / td > < td > is the timer counter of the device to operate on. Each device may contain multiple timer counters. The timer number is a zero based number with a range of 0 to (XTC_DEVICE_TIMER_COUNT - 1). < / td > < / tr >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > ResetValue< / em > < / td > < td > contains the value to be used to reset the timer counter.< / td > < / tr >
< / table >
2014-08-21 15:30:26 +05:30
< / dd >
2014-06-24 16:45:01 +05:30
< / dl >
2014-08-21 15:30:26 +05:30
< dl class = "return" > < dt > < b > Returns:< / b > < / dt > < dd > None.< / dd > < / dl >
< dl class = "note" > < dt > < b > Note:< / b > < / dt > < dd > None. < / dd > < / dl >
< / div >
< / div >
< a class = "anchor" id = "a7e2fb72f58ec51dd632b89a67beb515d" > < / a > <!-- doxytag: member="xiomodule.c::XIOModule_Start" ref="a7e2fb72f58ec51dd632b89a67beb515d" args="(XIOModule *InstancePtr)" -->
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > int XIOModule_Start < / td >
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > * < / td >
< td class = "paramname" > < em > InstancePtr< / em > < / td >
< td > ) < / td >
< td > < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< / table >
2014-08-21 15:30:26 +05:30
< / div >
< div class = "memdoc" >
< p > Starts the IO Module. Interrupts may be generated by the IO Module after this function is called.< / p >
< p > It is necessary for the caller to connect the interrupt handler of this component to the proper interrupt source.< / p >
< dl > < dt > < b > Parameters:< / b > < / dt > < dd >
2014-06-24 16:45:01 +05:30
< table border = "0" cellspacing = "2" cellpadding = "0" >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > InstancePtr< / em > < / td > < td > is a pointer to the < a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > instance to be worked on.< / td > < / tr >
< / table >
2014-08-21 15:30:26 +05:30
< / dd >
2014-06-24 16:45:01 +05:30
< / dl >
2014-08-21 15:30:26 +05:30
< dl class = "return" > < dt > < b > Returns:< / b > < / dt > < dd > < ul >
< li > XST_SUCCESS if the device was started successfully< / li >
< li > XST_FAILURE if simulation mode was specified and it could not be set because real mode has already been entered.< / li >
< / ul >
2014-06-24 16:45:01 +05:30
< / dd > < / dl >
2014-08-21 15:30:26 +05:30
< dl class = "note" > < dt > < b > Note:< / b > < / dt > < dd > Must be called after < a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > initialization is completed. < / dd > < / dl >
< / div >
< / div >
< a class = "anchor" id = "a4cd1ece524eb5fd3d5d255027ad6a01a" > < / a > <!-- doxytag: member="xiomodule.c::XIOModule_Stop" ref="a4cd1ece524eb5fd3d5d255027ad6a01a" args="(XIOModule *InstancePtr)" -->
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void XIOModule_Stop < / td >
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > * < / td >
< td class = "paramname" > < em > InstancePtr< / em > < / td >
< td > ) < / td >
< td > < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< / table >
2014-08-21 15:30:26 +05:30
< / div >
< div class = "memdoc" >
< p > Stops the interrupt controller by disabling the output from the controller so that no interrupts will be caused by the interrupt controller.< / p >
< dl > < dt > < b > Parameters:< / b > < / dt > < dd >
2014-06-24 16:45:01 +05:30
< table border = "0" cellspacing = "2" cellpadding = "0" >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > InstancePtr< / em > < / td > < td > is a pointer to the < a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > instance to be worked on.< / td > < / tr >
< / table >
2014-08-21 15:30:26 +05:30
< / dd >
2014-06-24 16:45:01 +05:30
< / dl >
2014-08-21 15:30:26 +05:30
< dl class = "return" > < dt > < b > Returns:< / b > < / dt > < dd > None.< / dd > < / dl >
< dl class = "note" > < dt > < b > Note:< / b > < / dt > < dd > None. < / dd > < / dl >
< / div >
< / div >
< a class = "anchor" id = "ad0dad0abc10925039a42855110f8256f" > < / a > <!-- doxytag: member="xiomodule.c::XIOModule_Timer_Initialize" ref="ad0dad0abc10925039a42855110f8256f" args="(XIOModule *InstancePtr, u16 DeviceId)" -->
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
2014-06-24 16:45:01 +05:30
< tr >
2014-08-21 15:30:26 +05:30
< td class = "memname" > int XIOModule_Timer_Initialize < / td >
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > * < / td >
< td class = "paramname" > < em > InstancePtr< / em > , < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< tr >
2014-08-21 15:30:26 +05:30
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > u16 < / td >
< td class = "paramname" > < em > DeviceId< / em > < / td > < td > < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< tr >
2014-08-21 15:30:26 +05:30
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td > < td > < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< / table >
2014-08-21 15:30:26 +05:30
< / div >
< div class = "memdoc" >
< p > Initializes a specific timer instance/driver. Initialize fields of the < a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > structure, then reset the timer< / p >
< dl > < dt > < b > Parameters:< / b > < / dt > < dd >
2014-06-24 16:45:01 +05:30
< table border = "0" cellspacing = "2" cellpadding = "0" >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > InstancePtr< / em > < / td > < td > is a pointer to the < a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > instance. < / td > < / tr >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > DeviceId< / em > < / td > < td > is the unique id of the device controlled by this < a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > component. Passing in a device id associates the generic < a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > component to a specific device, as chosen by the caller or application developer.< / td > < / tr >
< / table >
2014-08-21 15:30:26 +05:30
< / dd >
2014-06-24 16:45:01 +05:30
< / dl >
2014-08-21 15:30:26 +05:30
< dl class = "return" > < dt > < b > Returns:< / b > < / dt > < dd > < ul >
< li > XST_SUCCESS if initialization was successful< / li >
< li > XST_DEVICE_IS_STARTED if the device has already been started< / li >
< li > XST_DEVICE_NOT_FOUND if the device doesn't exist< / li >
< / ul >
2014-06-24 16:45:01 +05:30
< / dd > < / dl >
2014-08-21 15:30:26 +05:30
< dl class = "note" > < dt > < b > Note:< / b > < / dt > < dd > None. < / dd > < / dl >
< / div >
< / div >
< a class = "anchor" id = "a622c3a5cd4e43543cfb445071d01e7a9" > < / a > <!-- doxytag: member="xiomodule.c::XIOModule_Timer_Start" ref="a622c3a5cd4e43543cfb445071d01e7a9" args="(XIOModule *InstancePtr, u8 TimerNumber)" -->
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
2014-06-24 16:45:01 +05:30
< tr >
2014-08-21 15:30:26 +05:30
< td class = "memname" > void XIOModule_Timer_Start < / td >
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > * < / td >
< td class = "paramname" > < em > InstancePtr< / em > , < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< tr >
2014-08-21 15:30:26 +05:30
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > u8 < / td >
< td class = "paramname" > < em > TimerNumber< / em > < / td > < td > < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< tr >
2014-08-21 15:30:26 +05:30
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td > < td > < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< / table >
2014-08-21 15:30:26 +05:30
< / div >
< div class = "memdoc" >
< p > Starts the specified timer counter of the device such that it starts running. The timer counter is reset before it is started and the reset value is loaded into the timer counter.< / p >
< p > If interrupt mode is specified in the options, it is necessary for the caller to connect the interrupt handler of the timer to the interrupt source, typically an interrupt controller, and enable the interrupt within the interrupt controller.< / p >
< dl > < dt > < b > Parameters:< / b > < / dt > < dd >
2014-06-24 16:45:01 +05:30
< table border = "0" cellspacing = "2" cellpadding = "0" >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > InstancePtr< / em > < / td > < td > is a pointer to the < a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > instance. < / td > < / tr >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > TimerNumber< / em > < / td > < td > is the timer of the device to operate on. Each device may contain multiple timers. The timer number is a zero based number with a range of 0 to (XTC_DEVICE_TIMER_COUNT - 1).< / td > < / tr >
< / table >
2014-08-21 15:30:26 +05:30
< / dd >
2014-06-24 16:45:01 +05:30
< / dl >
2014-08-21 15:30:26 +05:30
< dl class = "return" > < dt > < b > Returns:< / b > < / dt > < dd > None.< / dd > < / dl >
< dl class = "note" > < dt > < b > Note:< / b > < / dt > < dd > None. < / dd > < / dl >
< / div >
< / div >
< a class = "anchor" id = "a60bd9ef270b0de7440206326ec1fe710" > < / a > <!-- doxytag: member="xiomodule.c::XIOModule_Timer_Stop" ref="a60bd9ef270b0de7440206326ec1fe710" args="(XIOModule *InstancePtr, u8 TimerNumber)" -->
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
2014-06-24 16:45:01 +05:30
< tr >
2014-08-21 15:30:26 +05:30
< td class = "memname" > void XIOModule_Timer_Stop < / td >
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > * < / td >
< td class = "paramname" > < em > InstancePtr< / em > , < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< tr >
2014-08-21 15:30:26 +05:30
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > u8 < / td >
< td class = "paramname" > < em > TimerNumber< / em > < / td > < td > < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< tr >
2014-08-21 15:30:26 +05:30
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td > < td > < / td >
2014-06-24 16:45:01 +05:30
< / tr >
< / table >
2014-08-21 15:30:26 +05:30
< / div >
< div class = "memdoc" >
< p > Stops the timer by disabling it.< / p >
< p > It is the callers' responsibility to disconnect the interrupt handler of the timer from the interrupt source, typically an interrupt controller, and disable the interrupt within the interrupt controller.< / p >
< dl > < dt > < b > Parameters:< / b > < / dt > < dd >
2014-06-24 16:45:01 +05:30
< table border = "0" cellspacing = "2" cellpadding = "0" >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > InstancePtr< / em > < / td > < td > is a pointer to the < a class = "el" href = "struct_x_i_o_module.html" > XIOModule< / a > instance. < / td > < / tr >
< tr > < td valign = "top" > < / td > < td valign = "top" > < em > TimerNumber< / em > < / td > < td > is the timer counter of the device to operate on. Each device may contain multiple timer counters. The timer number is a zero based number with a range of 0 to (XTC_DEVICE_TIMER_COUNT - 1).< / td > < / tr >
< / table >
2014-08-21 15:30:26 +05:30
< / dd >
2014-06-24 16:45:01 +05:30
< / dl >
2014-08-21 15:30:26 +05:30
< dl class = "return" > < dt > < b > Returns:< / b > < / dt > < dd > None.< / dd > < / dl >
< dl class = "note" > < dt > < b > Note:< / b > < / dt > < dd > None. < / dd > < / dl >
< / div >
< / div >
< hr / > < h2 > Variable Documentation< / h2 >
< a class = "anchor" id = "ab021984b27165498eb3edbc9e2cbc939" > < / a > <!-- doxytag: member="xiomodule.c::XIOModule_BitPosMask" ref="ab021984b27165498eb3edbc9e2cbc939" args="[XPAR_IOMODULE_INTC_MAX_INTR_SIZE]" -->
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > u32 < a class = "el" href = "xiomodule__i_8h.html#a36499fe673de55638703393cf70e6dd9" > XIOModule_BitPosMask< / a > [XPAR_IOMODULE_INTC_MAX_INTR_SIZE]< / td >
< / tr >
< / table >
< / div >
< div class = "memdoc" >
< / div >
< / div >
< / div >
< p class = "Copyright" >
Copyright © 1995-2014 Xilinx, Inc. All rights reserved.
< / p >
< / body >
< / html >
