Contiki 2.6

sd.h

Go to the documentation of this file.
00001 /*
00002  * Copyright (c) 2009, Swedish Institute of Computer Science
00003  * All rights reserved.
00004  *
00005  * Redistribution and use in source and binary forms, with or without
00006  * modification, are permitted provided that the following conditions
00007  * are met:
00008  * 1. Redistributions of source code must retain the above copyright
00009  *    notice, this list of conditions and the following disclaimer.
00010  * 2. Redistributions in binary form must reproduce the above copyright
00011  *    notice, this list of conditions and the following disclaimer in the
00012  *    documentation and/or other materials provided with the distribution.
00013  * 3. Neither the name of the Institute nor the names of its contributors
00014  *    may be used to endorse or promote products derived from this software
00015  *    without specific prior written permission.
00016  *
00017  * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
00018  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00019  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00020  * ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
00021  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00022  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
00023  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
00024  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00025  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
00026  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00027  * SUCH DAMAGE.
00028  *
00029  * This file is part of the Contiki operating system.
00030  *
00031  */
00032 
00033 /**
00034  * \file
00035  *      SD driver interface.
00036  * \author
00037  *      Nicolas Tsiftes <nvt@sics.se>
00038  */
00039 
00040 #ifndef SD_H
00041 #define SD_H
00042 
00043 #include "sd-arch.h"
00044 
00045 #define SD_DEFAULT_BLOCK_SIZE                   512
00046 #define SD_REGISTER_SIZE                        16
00047 
00048 /* API return codes. */
00049 #define SD_OK                                    1
00050 
00051 #define SD_INIT_ERROR_NO_CARD                   -1
00052 #define SD_INIT_ERROR_ARCH                      -2
00053 #define SD_INIT_ERROR_NO_IF_COND                -3
00054 #define SD_INIT_ERROR_NO_BLOCK_SIZE    -4
00055 
00056 #define SD_WRITE_ERROR_NO_CMD_RESPONSE          -5
00057 #define SD_WRITE_ERROR_NO_BLOCK_RESPONSE        -6
00058 #define SD_WRITE_ERROR_PROGRAMMING              -7
00059 #define SD_WRITE_ERROR_TOKEN                    -8
00060 #define SD_WRITE_ERROR_NO_TOKEN                 -9
00061 
00062 #define SD_READ_ERROR_NO_CMD_RESPONSE           -10
00063 #define SD_READ_ERROR_INVALID_SIZE              -11
00064 #define SD_READ_ERROR_TOKEN                     -12
00065 #define SD_READ_ERROR_NO_TOKEN                  -13
00066 
00067 /* Type definition. */
00068 typedef uint32_t sd_offset_t;
00069 
00070 /* API */
00071 int sd_initialize(void);
00072 int sd_write(sd_offset_t, char *, unsigned);
00073 int sd_read(sd_offset_t, char *, unsigned);
00074 int sd_write_block(sd_offset_t, char *);
00075 int sd_read_block(sd_offset_t, char *);
00076 sd_offset_t sd_get_capacity(void);
00077 char *sd_error_string(int);
00078 
00079 #endif /* !SD_H */