muntjac-coffee-arch.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008, Swedish Institute of Computer Science
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. 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.
 * 3. Neither the name of the Institute 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 INSTITUTE 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 INSTITUTE 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.
 *
 * This file is part of the Contiki operating system.
 *
 */

/**
 * \file
 *      Coffee architecture-dependent header for the muntjac.
 *      Based on the Zolertia Z! implementation
 * \author
 *      Nicolas Tsiftes <nvt@sics.se>
 *      Enric M. Calvo <ecalvo@zolertia.com>
 */

#ifndef CFS_COFFEE_ARCH_H
#define CFS_COFFEE_ARCH_H

#include "contiki-conf.h"
#include "dev/xmem.h"
#include "reset-sensor.h"
#include "flash.h"

// Reserve space in the program flash for the reset sensor
#define FLASH_CONF_FW_ADDR CC2538_DEV_FLASH_ADDR + RESET_SENSOR_SIZE

/*** M25P16 Memory Organization
The memory is organized as: 
16Mbit = 2 097 152 bytes (8 bits each) 
32 sectors (512 Kbits, 65536 bytes each) 
8192 pages (256 bytes each). 
Each page can be individually programmed (bits are programmed from 1 to 0). The device is 
sector or bulk erasable (bits are erased from 0 to 1) but not page erasable
*/
#define COFFEE_XMEM_TOTAL_SIZE_KB       2048UL  //Total size of the External Flash Memory in the Z1

// Params from z1-feshie/platform-conf.h
#define XMEM_ERASE_UNIT_SIZE (64*1024L)

#define CFS_CONF_OFFSET_TYPE    long

// We don't use the flash for anything else, no need for an offset
#define CFS_XMEM_CONF_OFFSET    (0 * XMEM_ERASE_UNIT_SIZE)
#define CFS_XMEM_CONF_SIZE      (1 * XMEM_ERASE_UNIT_SIZE)

/* Coffee configuration parameters. */
#define COFFEE_SECTOR_SIZE              65536UL  
#define COFFEE_PAGE_SIZE                128UL // Coffee stores 1 file per logical page + doesn't care about physical page size
#define COFFEE_START                    0
#define COFFEE_SIZE                     (COFFEE_XMEM_TOTAL_SIZE_KB * 1024UL - COFFEE_START)
#define COFFEE_NAME_LENGTH              6
#define COFFEE_MAX_OPEN_FILES   3 // We have space RAM to cache files
#define COFFEE_FD_SET_SIZE              1 // We only open one file at a time
#define COFFEE_LOG_TABLE_LIMIT  0
#define COFFEE_DYN_SIZE                 120
#define COFFEE_LOG_SIZE                 0

#define COFFEE_MICRO_LOGS               0
#define COFFEE_SMALL_HEADERS    1
#define COFFEE_IO_SEMANTICS     1

/* Flash operations. */
#define COFFEE_WRITE(buf, size, offset)                         \
                xmem_pwrite((char *)(buf), (size), COFFEE_START + (offset))

#define COFFEE_READ(buf, size, offset)                          \
                xmem_pread((char *)(buf), (size), COFFEE_START + (offset))

#define COFFEE_ERASE(sector)                                    \
                xmem_erase(COFFEE_SECTOR_SIZE, COFFEE_START + (sector) * COFFEE_SECTOR_SIZE)

/* Coffee types. */
typedef int16_t coffee_page_t;

#endif /* !COFFEE_ARCH_H */