rmslog/hw/hw_spi.h

   1 /**
   2  * \file
   3  * <!--
   4  * This file is part of BeRTOS.
   5  *
   6  * Bertos is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  *
  20  * As a special exception, you may use this file as part of a free software
  21  * library without restriction.  Specifically, if other files instantiate
  22  * templates or use macros or inline functions from this file, or you compile
  23  * this file and link it with other files to produce an executable, this
  24  * file does not by itself cause the resulting executable to be covered by
  25  * the GNU General Public License.  This exception does not however
  26  * invalidate any other reasons why the executable file might be covered by
  27  * the GNU General Public License.
  28  *
  29  * Copyright 2008 Develer S.r.l. (http://www.develer.com/)
  30  * All Rights Reserved.
  31  * -->
  32  *
  33  * \brief Hardware macro definition.
  34  *
  35  *
  36  * \author Daniele Basile <asterix@develer.com>
  37  */
  38
  39 #ifndef HW_SPI_H
  40 #define HW_SPI_H
  41
  42 #warning TODO:This is an example implentation, you must implement it!
  43
  44 #include <cfg/macros.h>
  45
  46 /**
  47  * SPI pin definition.
  48  *
  49  * \note CS is assert when level
  50  * is low.
  51  *
  52  * \{
  53  */
  54 #define CS       /* pin */   ///Connect to CS pin of Flash memory.
  55 #define SCK      /* pin */   ///Connect to SCK pin of Flash memory.
  56 #define MOSI     /* pin */   ///Connect to SI pin of Flash memory.
  57 #define MISO     /* pin */   ///Connect to SO pin of Flash memory.
  58 #define SPI_PORT /* pin */   ///Micro pin PORT register.
  59 #define SPI_PIN  /* pin */   ///Micro pin PIN register.
  60 #define SPI_DDR  /* pin */   ///Micro pin DDR register.
  61 /*\}*/
  62
  63 /**
  64  * Pin logic level.
  65  *
  66  * \{
  67  */
  68 #define MOSI_LOW()       do { /* Implement me! */ } while(0)
  69 #define MOSI_HIGH()      do { /* Implement me! */ } while(0)
  70 #define MISO_HIGH()      do { /* Implement me! */ } while(0)
  71 #define SCK_LOW()        do { /* Implement me! */ } while(0)
  72 #define SCK_HIGH()       do { /* Implement me! */ } while(0)
  73 #define CS_LOW()         do { /* Implement me! */ } while(0)
  74 #define CS_HIGH()        do { /* Implement me! */ } while(0)
  75 /*\}*/
  76
  77 /**
  78  * SPI pin commands.
  79  *
  80  * \{
  81  */
  82 #define CS_ENABLE()      CS_LOW()
  83 #define CS_DISABLE()     CS_HIGH()
  84 #define SS_ACTIVE()      CS_LOW()
  85 #define SS_INACTIVE()    CS_HIGH()
  86 #define SCK_INACTIVE()   SCK_LOW()
  87 #define SCK_ACTIVE()     SCK_HIGH()
  88 #define CS_OUT()         do { /* Implement me! */ } while(0)
  89 #define MOSI_IN()        do { /* Implement me! */ } while(0)
  90 #define MOSI_OUT()       do { /* Implement me! */ } while(0)
  91 #define IS_MISO_HIGH()   (false /* Implement me! */ )
  92 #define MISO_IN()        do { /* Implement me! */ } while(0)
  93 #define MISO_OUT()       do { /* Implement me! */ } while(0)
  94 #define SCK_OUT()        do { /* Implement me! */ } while(0)
  95
  96 #define SCK_PULSE()\
  97         do {\
  98                         SCK_HIGH();\
  99                         SCK_LOW();\
 100         } while (0)
 101 /*\}*/
 102
 103
 104 #define SPI_HW_INIT() \
 105         CS_DISABLE();\
 106         MOSI_LOW();\
 107         SCK_LOW();\
 108         MISO_IN();\
 109         MOSI_OUT();\
 110         SCK_OUT();\
 111         CS_OUT();
 112
 113 #endif /* HW_SPI_H */
 114