1 /*****************************************************************************
2 * FullFAT - High Performance, Thread-Safe Embedded FAT File-System *
3 * Copyright (C) 2009 James Walmsley (james@worm.me.uk) *
5 * This program is free software: you can redistribute it and/or modify *
6 * it under the terms of the GNU General Public License as published by *
7 * the Free Software Foundation, either version 3 of the License, or *
8 * (at your option) any later version. *
10 * This program is distributed in the hope that it will be useful, *
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13 * GNU General Public License for more details. *
15 * You should have received a copy of the GNU General Public License *
16 * along with this program. If not, see <http://www.gnu.org/licenses/>. *
20 * Alternative Licensing is available directly from the Copyright holder, *
21 * (James Walmsley). For more information consult LICENSING.TXT to obtain *
22 * a Commercial license. *
24 * See RESTRICTIONS.TXT for extra restrictions on the use of FullFAT. *
26 * Removing the above notice is illegal and will invalidate this license. *
27 *****************************************************************************
28 * See http://worm.me.uk/fullfat for more information. *
29 * Or http://fullfat.googlecode.com/ for latest releases and the wiki. *
30 *****************************************************************************/
38 * @author James Walmsley
41 * @defgroup TIME Real-Time Clock Interface
42 * @brief Allows FullFAT to time-stamp files.
44 * Provides a means for receiving the time on any platform.
47 #ifdef FF_TIME_SUPPORT
50 * @brief Populates an FF_SYSTEMTIME object with the current time from the system.
52 * The developer must modify this function so that it is suitable for their platform.
53 * The function must return with 0, and if the time is not available all elements of the
54 * FF_SYSTEMTIME object must be zero'd, as in the examples provided.
56 * @param pTime Pointer to an FF_TIME object.
58 * @return Always returns 0.
60 FF_T_SINT32
FF_GetSystemTime(FF_SYSTEMTIME
*pTime
) {