fds_config.h

00001 /*
00002  * Copyright (c) Nordic Semiconductor ASA
00003  * All rights reserved.
00004  *
00005  * Redistribution and use in source and binary forms, with or without modification,
00006  * are permitted provided that the following conditions are met:
00007  *
00008  *   1. Redistributions of source code must retain the above copyright notice, this
00009  *   list of conditions and the following disclaimer.
00010  *
00011  *   2. Redistributions in binary form must reproduce the above copyright notice, this
00012  *   list of conditions and the following disclaimer in the documentation and/or
00013  *   other materials provided with the distribution.
00014  *
00015  *   3. Neither the name of Nordic Semiconductor ASA nor the names of other
00016  *   contributors to this software may be used to endorse or promote products
00017  *   derived from this software without specific prior written permission.
00018  *
00019  *
00020  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
00021  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
00022  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00023  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
00024  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
00025  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
00026  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
00027  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
00028  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00029  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00030  *
00031  */
00032 
00033 #ifndef FDS_CONFIG_H__
00034 #define FDS_CONFIG_H__
00035 
00036  /**
00037  * @file fds_config.h
00038  *
00039  * @addtogroup flash_data_storage
00040  * @{
00041  */
00042 
00043 /**@brief Configures the size of the internal queue. */
00044 #define FDS_CMD_QUEUE_SIZE          (8)
00045 /**@brief Determines how many @ref fds_record_chunk_t structures can be buffered at any time. */
00046 #define FDS_CHUNK_QUEUE_SIZE        (8)
00047 
00048 /**@brief Configures the number of physical flash pages to use. Out of the total, one is reserved
00049  *        for garbage collection, hence, two pages is the minimum: one for the application data
00050  *        and one for the system. */
00051 #define FDS_MAX_PAGES               (2)
00052 /**@brief Configures the maximum number of callbacks which can be registred. */
00053 #define FDS_MAX_USERS               (10)
00054 
00055 /** Page tag definitions. */
00056 #define FDS_PAGE_TAG_WORD_0_SWAP    (0xA5A5A5A5)
00057 #define FDS_PAGE_TAG_WORD_0_VALID   (0xA4A4A4A4)
00058 #define FDS_PAGE_TAG_WORD_1         (0xAABBCCDD)
00059 #define FDS_PAGE_TAG_WORD_2         (0xAABB01DD) /**< Includes version. */
00060 #define FDS_PAGE_TAG_WORD_3         (0x1CEB00DA)
00061 #define FDS_PAGE_TAG_WORD_3_GC      (0x1CEB00D8)
00062 
00063 /** @} */
00064 
00065 #endif // FDS_CONFIG_H__