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