bertos/hw/hw_dataflash.c

   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 Dataflash HW control routines.
  34  *
  35  * \author Francesco Sacchi <batt@develer.com>
  36  */
  37
  38 #include "hw/hw_dataflash.h"
  39
  40 #include <cfg/compiler.h>
  41 #include <cfg/module.h>
  42 #include <cfg/macros.h>
  43
  44 #warning TODO:This is an example implementation, you must implement it!
  45
  46 MOD_DEFINE(hw_dataflash);
  47
  48 /**
  49  * Data flash init function.
  50  *
  51  * This function provide to initialize all that
  52  * needs to drive a dataflash memory.
  53  * Generaly needs to init pins to drive a CS line
  54  * and reset line.
  55  */
  56 void dataflash_hw_init(void)
  57 {
  58
  59     //Disable CS line (remove if not needed)
  60         dataflash_hw_setCS(false);
  61
  62         /*
  63          * Put here your code!
  64          *
  65          * Note:
  66          * - if you drive manualy CS line, here init a CS pin
  67          * - if you use a dedicated reset line, here init a reset pin
  68          */
  69
  70         MOD_INIT(hw_dataflash);
  71 }
  72
  73 /**
  74  * Chip Select drive.
  75  *
  76  * This function enable or disable a CS line.
  77  * You must implement this function comply to a dataflash
  78  * memory datasheet to allow the drive to enable a memory
  79  * when \p enable flag is true, and disable it when is false.
  80  */
  81 void dataflash_hw_setCS(bool enable)
  82 {
  83         if (enable)
  84         {
  85                 /*
  86                  * Put here your code to enable
  87                  * dataflash memory
  88                  */
  89         }
  90         else
  91         {
  92                 /*
  93                  * Put here your code to disable
  94                  * dataflash memory
  95                  */
  96         }
  97 }
  98
  99 /**
 100  * Reset data flash memory.
 101  *
 102  * This function provide to send reset signal to
 103  * dataflash memory. You must impement it comly to a dataflash
 104  * memory datasheet to allow the drive to set a reset pin
 105  * when \p enable flag is true, and disable it when is false.
 106  *
 107  */
 108 void dataflash_hw_setReset(bool enable)
 109 {
 110         if (enable)
 111         {
 112                 /*
 113                  * Put here your code to set reset of
 114                  * dataflash memory
 115                  */
 116         }
 117         else
 118         {
 119                 /*
 120                  * Put here your code to clear reset of
 121                  * dataflash memory
 122                  */
 123         }
 124 }
 125