Contiki 2.5
cfs-coffee-arch.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2008, Swedish Institute of Computer Science
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  * notice, this list of conditions and the following disclaimer in the
12  * documentation and/or other materials provided with the distribution.
13  * 3. Neither the name of the Institute nor the names of its contributors
14  * may be used to endorse or promote products derived from this software
15  * without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  * This file is part of the Contiki operating system.
30  *
31  */
32 
33 /**
34  * \file
35  * Coffee architecture-dependent header for the Zolertia Z1 platform.
36  * \author
37  * Nicolas Tsiftes <nvt@sics.se>
38  * Enric M. Calvo <ecalvo@zolertia.com>
39  */
40 
41 #ifndef CFS_COFFEE_ARCH_H
42 #define CFS_COFFEE_ARCH_H
43 
44 #include "contiki-conf.h"
45 #include "dev/xmem.h"
46 
47 /*** M25P16 Memory Organization
48 The memory is organized as:
49 16Mbit = 2 097 152 bytes (8 bits each)
50 32 sectors (512 Kbits, 65536 bytes each)
51 8192 pages (256 bytes each).
52 Each page can be individually programmed (bits are programmed from 1 to 0). The device is
53 sector or bulk erasable (bits are erased from 0 to 1) but not page erasable
54 */
55 #define COFFEE_XMEM_TOTAL_SIZE_KB 2048UL //Total size of the External Flash Memory in the Z1
56 
57 /* Coffee configuration parameters. */
58 #define COFFEE_SECTOR_SIZE 65536UL
59 #define COFFEE_PAGE_SIZE 256UL
60 #define COFFEE_START COFFEE_SECTOR_SIZE
61 #define COFFEE_SIZE (COFFEE_XMEM_TOTAL_SIZE_KB * 1024UL - COFFEE_START)
62 #define COFFEE_NAME_LENGTH 16
63 #define COFFEE_MAX_OPEN_FILES 6
64 #define COFFEE_FD_SET_SIZE 8
65 #define COFFEE_LOG_TABLE_LIMIT 256
66 #define COFFEE_DYN_SIZE 4*1024
67 #define COFFEE_LOG_SIZE 1024
68 
69 #define COFFEE_MICRO_LOGS 1
70 
71 /* Flash operations. */
72 #define COFFEE_WRITE(buf, size, offset) \
73  xmem_pwrite((char *)(buf), (size), COFFEE_START + (offset))
74 
75 #define COFFEE_READ(buf, size, offset) \
76  xmem_pread((char *)(buf), (size), COFFEE_START + (offset))
77 
78 #define COFFEE_ERASE(sector) \
79  xmem_erase(COFFEE_SECTOR_SIZE, COFFEE_START + (sector) * COFFEE_SECTOR_SIZE)
80 
81 /* Coffee types. */
82 typedef int16_t coffee_page_t;
83 
84 #endif /* !COFFEE_ARCH_H */