CF2 API Reference (PDF) - Persistor Instruments Inc

More documents

Recommendations

Info

CF2 API ReferenceRTCElapsedTime -- Read the elapsed time (us)Description:Prototype:Inputs:Returns:Notes:Read the elapsed time in microsecondsulong RTCElapsedTime(RTCTimer *rt);rt is a pointer to an RTCTimer struct that is preallocated and ready to be filled.Returns the elapsed time in microseconds.Because internally the real time clock can only measure time in units of ticks, the timer isinternally counted as an integer number of ticks then normalized to microseconds. Because onetick is approximately 25 µsecs and the calling overhead of the functions that interact with thesecounters is at least 20 µsecs, the timers have an effective resolution of no less than 55 µsecs.RTCElapsedTimerSetup -- Setup and start an elapsed timer (us)Description:Prototype:Inputs:Notes:Tells the real time clock to set up and start an ascending counter. The timer will immediatelybegin counting up from zero in microseconds. Once RTCElapsedTimerSetup returns, use thefunction RTCElapsedTime with the same RTCTimer struct to watch the counter.void RTCElapsedTimerSetup(RTCTimer *rt);rt is a pointer to an RTCTimer struct that is preallocated and ready to be filled.See the Elapsed and Countdown Timers description at the top.RTCGetTime -- Get both seconds and ticksDescription:Prototype:Inputs:Returns:Notes:The real time clock maintains two registers. One that keeps ticks (1/40000'ths of a second (forapproximately 25 µsec resolution) and one that keeps seconds.ulong RTCGetTime(ulong *seconds, ushort *ticks);seconds is a pointer to a ulong into which the current seconds counter will be placed.ticks is a pointer to a ushort into which the current ticks count will be placed.Returns a ulong containing just the seconds count. This is useful when you do not wish to createplaceholding variables.If either or both of the pointers are NULL, the function will not write into the base of memory, itwill ignore the parameter and fill the other one, or if both are NULL, it will simply return theseconds count. See RTCSetTime for UNIX epoch note.RTCSetTime -- Set both seconds and ticksDescription:Prototype:Inputs:RTCSetTime loads values into the ticks and seconds registers that are provided in the argumentto the function. For standard operation these values should reflect the number of seconds andthe number of ticks since the UNIX epoch which is midnight Jan 1, 1970, although there is norestriction that forces this to be true. RTCSetTime can be called regardless of whether the realtime clock is running or stopped. If the clock is running, RTCSetTime will set the time and keepthe clock running, as could be expected. If the clock is stopped, for instance if you wish to setthe clock based on an external event, RTCSetTime will load the given values into the registersand then when/if the clock is started, it will continue to count from the values loaded.void RTCSetTime(ulong secs, ushort ticks);secs is a ulong that contains the value intended for the seconds register of the Real Time Clockticks is a ushort that contains the value intended for the ticks register of the Real Time ClockPERSISTORInstruments Inc.50 of 84CF2 API Reference7/19/2005
CF2 API ReferenceRTCtime -- ANSI standard C library time() equivalent functionDescription:Prototype:Inputs:Returns:Notes:This function returns the contents of the real time clock's seconds register. In a system with aproperly set clock, this will be equal to the number of seconds since midnight Jan 1, 1970. Thisnumber is copied into the ulong pointed to by tp.ulong RTCtime(ulong *tp);tp is a pointer to a ulong where you wish the time to be placed on return.Returns the contents of the real time clock's seconds register.If tp is NULL, the function will not fail or write to the base of memory, it will simply do nothingwith the argument and return the contents of the real time clock's seconds register.PERSISTORInstruments Inc.51 of 84CF2 API Reference7/19/2005
Page 1 and 2: PERSISTOR ® CF2API ReferenceCopyri
Page 3 and 4: CF2 API ReferenceATA Device Drivers
Page 5 and 6: CF2 API ReferenceBigIDEA IDE Driver
Page 7 and 8: CF2 API ReferenceBIOSVersionCheck -
Page 9 and 10: CF2 API ReferenceCheckSum32 -- Upda
Page 11 and 12: CF2 API ReferenceChip Select Wrappe
Page 13 and 14: CF2 API ReferenceCompactFlash Low L
Page 15 and 16: CF2 API ReferenceBelow are macros d
Page 17 and 18: CF2 API ReferenceCIOprintf - Simple
Page 19 and 20: CF2 API Referenceuprintf -- A clone
Page 21 and 22: CF2 API ReferenceDIRMatchName -- Re
Page 23 and 24: CF2 API ReferenceLED Signal Functio
Page 25 and 26: CF2 API ReferencePeriodic Interrupt
Page 27 and 28: CF2 API ReferencePicoDOS Initializa
Page 29 and 30: CF2 API ReferencePin I/O Drivers, F
Page 31 and 32: CF2 API ReferencePinIO -- Make an I
Page 33 and 34: CF2 API ReferencePIOClear -- Config
Page 35 and 36: CF2 API ReferencePing-Pong Buffer F
Page 37 and 38: CF2 API ReferencePPBPutWord -- Writ
Page 39 and 40: CF2 API ReferenceQSMRun - Start the
Page 41 and 42: CF2 API ReferenceQuery/Reply Functi
Page 43 and 44: CF2 API ReferenceQRdouble -- Query/
Page 45 and 46: CF2 API ReferenceQueued PicoBUS (QS
Page 47 and 48: CF2 API ReferenceQPBSetup -- Set up
Page 49: CF2 API ReferenceReal Time Clock Dr
Page 53 and 54: CF2 API ReferenceSTDIO WarningThe A
Page 55 and 56: CF2 API ReferenceSCIRxFlush -- Dele
Page 57 and 58: CF2 API ReferenceSCIRxTxIdle -- Ret
Page 59 and 60: CF2 API ReferenceSCITxWaitCompletio
Page 61 and 62: CF2 API ReferenceTable Driven Comma
Page 63 and 64: CF2 API ReferenceCmdIsNumber- Is Co
Page 65 and 66: CF2 API ReferenceTime Processing Un
Page 67 and 68: CF2 API ReferencePrototype:Inputs:N
Page 69 and 70: CF2 API ReferenceTPU UartSummary of
Page 71 and 72: CF2 API ReferenceTUOpen - Open a TP
Page 73 and 74: CF2 API ReferenceTUTxFlush - Delete
Page 75 and 76: CF2 API ReferenceUtility Functionse
Page 77 and 78: CF2 API Referencesscantime -- scan
Page 79 and 80: CF2 API ReferenceVEEDelete -- Delet
Page 81 and 82: CF2 API ReferenceVEEStoreFloat -- S
Page 83 and 84: CF2 API ReferencePinBus, 30PinClear

CF2 API Reference (PDF) - Persistor Instruments Inc

Create successful ePaper yourself

Delete template?

Save as template?