sclock.h

/**
 * Copyright (c) 2008-2012, Regents of the University of California
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * - Redistributions of source code must retain the above copyright notice,
 *   this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 * - Neither the name of the University of California, Berkeley nor the names
 *   of its contributors may be used to endorse or promote products derived
 *   from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 *
 * System Time Module
 *
 * by Stanley S. Baek and Humphrey Hu
 *
 * v.0.2
 *
 * Usage:
 *   #include "sclock.h"
 *   #include "utils.h"
 *
 *   unsigned long time_elapsed;
 *
 *   // initialize system time module
 *   sclockSetup();
 *
 *   // delay for .5 sec
 *   delay_us(500);
 *
 *   time_elapsed = sclockGetTime();
 *   // time_elapsed should hold a value of ~500.
 */

#ifndef __SCLOCK_H
#define __SCLOCK_H


// Handles initialization of required timers and resets time to 0.
void sclockSetup(void);

// Requests number of ticks since the clock was started.
//
// 5 ticks add up to a microsecond elapsed.
//
// Returns : clock ticks
unsigned long sclockGetTicks(void);

// Requests number of microseconds since the clock was started.
//
// Returns : time in microseconds
unsigned long sclockGetTime(void);


#endif //  __SCLOCK_H