cfs-coffee-arch.h

Go to the documentation of this file.

/*
 * Copyright (c) 2014, Eistec AB.
 * 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 copyright holder 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.
 *
 * This file is part of the Mulle platform port of the Contiki operating system.
 *
 */

/**
 * \file
 *         Coffee file system architecture-dependent header for the Mulle platform.
 *
 * \author
 *         Henrik Makitaavola <henrik@makitaavola.se>
 */

#ifndef CFS_COFFEE_ARCH_H
#define CFS_COFFEE_ARCH_H

#include "contiki-conf.h"
#include "dev/xmem.h"
#include "xmem-arch.h"

#ifdef __cplusplus
extern "C" {
#endif

/* Coffee configuration parameters. */
#define COFFEE_PAGE_SIZE    XMEM_PAGE_SIZE
#define COFFEE_SECTOR_SIZE              XMEM_SECTOR_SIZE
#define COFFEE_NUM_SECTORS              XMEM_NUM_SECTORS
#define COFFEE_START      0
#define COFFEE_SIZE     XMEM_NUM_SECTORS * XMEM_SECTOR_SIZE
#define COFFEE_NAME_LENGTH    64
#define COFFEE_MAX_OPEN_FILES 6
#define COFFEE_FD_SET_SIZE    8
/* TODO(henrik) check the next four settings. */
#define COFFEE_LOG_TABLE_LIMIT  256
#define COFFEE_DYN_SIZE     4 * 1024
#define COFFEE_LOG_SIZE     1024
#define COFFEE_MICRO_LOGS   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;

#ifdef __cplusplus
} /* extern "C" */
#endif

#endif /* !COFFEE_ARCH_H */