Statistics
| Branch: | Tag: | Revision:

root / LUFA / CodeTemplates / DriverStubs / Dataflash.h @ 978b99e5

History | View | Annotate | Download (7.51 KB)

1
/*
2
             LUFA Library
3
     Copyright (C) Dean Camera, 2011.
4

5
  dean [at] fourwalledcubicle [dot] com
6
           www.lufa-lib.org
7
*/
8

    
9
/*
10
  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
11

12
  Permission to use, copy, modify, distribute, and sell this
13
  software and its documentation for any purpose is hereby granted
14
  without fee, provided that the above copyright notice appear in
15
  all copies and that both that the copyright notice and this
16
  permission notice and warranty disclaimer appear in supporting
17
  documentation, and that the name of the author not be used in
18
  advertising or publicity pertaining to distribution of the
19
  software without specific, written prior permission.
20

21
  The author disclaim all warranties with regard to this
22
  software, including all implied warranties of merchantability
23
  and fitness.  In no event shall the author be liable for any
24
  special, indirect or consequential damages or any damages
25
  whatsoever resulting from loss of use, data or profits, whether
26
  in an action of contract, negligence or other tortious action,
27
  arising out of or in connection with the use or performance of
28
  this software.
29
*/
30

    
31
/*
32
   This is a stub driver header file, for implementing custom board
33
   layout hardware with compatible LUFA board specific drivers. If
34
   the library is configured to use the BOARD_USER board mode, this
35
   driver file should be completed and copied into the "/Board/" folder
36
   inside the application's folder.
37

38
   This stub is for the board-specific component of the LUFA Dataflash
39
   driver.
40
*/
41

    
42
#ifndef __DATAFLASH_USER_H__
43
#define __DATAFLASH_USER_H__
44

    
45
        /* Includes: */
46
                // TODO: Add any required includes here
47

    
48
        /* Preprocessor Checks: */
49
                #if !defined(__INCLUDE_FROM_DATAFLASH_H)
50
                        #error Do not include this file directly. Include LUFA/Drivers/Board/Dataflash.h instead.
51
                #endif
52

    
53
        /* Private Interface - For use in library only: */
54
        #if !defined(__DOXYGEN__)
55
                /* Macros: */
56
                        #define DATAFLASH_CHIPCS_MASK                // TODO: Replace this with a mask of all the /CS pins of all Dataflashes
57
                        #define DATAFLASH_CHIPCS_DDR                 // TODO: Replace with the DDR register name for the board's Dataflash ICs
58
                        #define DATAFLASH_CHIPCS_PORT                // TODO: Replace with the PORT register name for the board's Dataflash ICs
59
        #endif
60

    
61
        /* Public Interface - May be used in end-application: */
62
                /* Macros: */
63
                        /** Constant indicating the total number of dataflash ICs mounted on the selected board. */
64
                        #define DATAFLASH_TOTALCHIPS                 1 // TODO: Replace with the number of Dataflashes on the board, max 2
65

    
66
                        /** Mask for no dataflash chip selected. */
67
                        #define DATAFLASH_NO_CHIP                    DATAFLASH_CHIPCS_MASK
68

    
69
                        /** Mask for the first dataflash chip selected. */
70
                        #define DATAFLASH_CHIP1                      // TODO: Replace with mask to hold /CS of first Dataflash low, and all others high
71

    
72
                        /** Mask for the second dataflash chip selected. */
73
                        #define DATAFLASH_CHIP2                      // TODO: Replace with mask to hold /CS of second Dataflash low, and all others high
74

    
75
                        /** Internal main memory page size for the board's dataflash ICs. */
76
                        #define DATAFLASH_PAGE_SIZE                  // TODO: Replace with the page size for the Dataflash ICs
77

    
78
                        /** Total number of pages inside each of the board's dataflash ICs. */
79
                        #define DATAFLASH_PAGES                      // TODO: Replace with the total number of pages inside one of the Dataflash ICs
80

    
81
                /* Inline Functions: */
82
                        /** Initializes the dataflash driver so that commands and data may be sent to an attached dataflash IC.
83
                         *  The microcontroller's SPI driver MUST be initialized before any of the dataflash commands are used.
84
                         */
85
                        static inline void Dataflash_Init(void)
86
                        {
87
                                DATAFLASH_CHIPCS_DDR  |= DATAFLASH_CHIPCS_MASK;
88
                                DATAFLASH_CHIPCS_PORT |= DATAFLASH_CHIPCS_MASK;
89
                        }
90

    
91
                        /** Determines the currently selected dataflash chip.
92
                         *
93
                         *  \return Mask of the currently selected Dataflash chip, either \ref DATAFLASH_NO_CHIP if no chip is selected
94
                         *          or a DATAFLASH_CHIPn mask (where n is the chip number).
95
                         */
96
                        static inline uint8_t Dataflash_GetSelectedChip(void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT;
97
                        static inline uint8_t Dataflash_GetSelectedChip(void)
98
                        {
99
                                return (DATAFLASH_CHIPCS_PORT & DATAFLASH_CHIPCS_MASK);
100
                        }
101

    
102
                        /** Selects the given dataflash chip.
103
                         *
104
                         *  \param[in]  ChipMask  Mask of the Dataflash IC to select, in the form of DATAFLASH_CHIPn mask (where n is
105
                         *              the chip number).
106
                         */
107
                        static inline void Dataflash_SelectChip(const uint8_t ChipMask) ATTR_ALWAYS_INLINE;
108
                        static inline void Dataflash_SelectChip(const uint8_t ChipMask)
109
                        {
110
                                DATAFLASH_CHIPCS_PORT = ((DATAFLASH_CHIPCS_PORT & ~DATAFLASH_CHIPCS_MASK) | ChipMask);
111
                        }
112

    
113
                        /** Deselects the current dataflash chip, so that no dataflash is selected. */
114
                        static inline void Dataflash_DeselectChip(void) ATTR_ALWAYS_INLINE;
115
                        static inline void Dataflash_DeselectChip(void)
116
                        {
117
                                Dataflash_SelectChip(DATAFLASH_NO_CHIP);
118
                        }
119

    
120
                        /** Selects a dataflash IC from the given page number, which should range from 0 to
121
                         *  ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1). For boards containing only one
122
                         *  dataflash IC, this will select DATAFLASH_CHIP1. If the given page number is outside
123
                         *  the total number of pages contained in the boards dataflash ICs, all dataflash ICs
124
                         *  are deselected.
125
                         *
126
                         *  \param[in] PageAddress  Address of the page to manipulate, ranging from
127
                         *                          0 to ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1).
128
                         */
129
                        static inline void Dataflash_SelectChipFromPage(const uint16_t PageAddress)
130
                        {
131
                                Dataflash_DeselectChip();
132

    
133
                                if (PageAddress >= (DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS))
134
                                  return;
135

    
136
                                #if (DATAFLASH_TOTALCHIPS == 2)
137
                                        if (PageAddress & 0x01)
138
                                          Dataflash_SelectChip(DATAFLASH_CHIP2);
139
                                        else
140
                                          Dataflash_SelectChip(DATAFLASH_CHIP1);
141
                                #else
142
                                        Dataflash_SelectChip(DATAFLASH_CHIP1);
143
                                #endif
144
                        }
145

    
146
                        /** Toggles the select line of the currently selected dataflash IC, so that it is ready to receive
147
                         *  a new command.
148
                         */
149
                        static inline void Dataflash_ToggleSelectedChipCS(void)
150
                        {
151
                                uint8_t SelectedChipMask = Dataflash_GetSelectedChip();
152

    
153
                                Dataflash_DeselectChip();
154
                                Dataflash_SelectChip(SelectedChipMask);
155
                        }
156

    
157
                        /** Spin-loops while the currently selected dataflash is busy executing a command, such as a main
158
                         *  memory page program or main memory to buffer transfer.
159
                         */
160
                        static inline void Dataflash_WaitWhileBusy(void)
161
                        {
162
                                Dataflash_ToggleSelectedChipCS();
163
                                Dataflash_SendByte(DF_CMD_GETSTATUS);
164
                                while (!(Dataflash_ReceiveByte() & DF_STATUS_READY));
165
                                Dataflash_ToggleSelectedChipCS();
166
                        }
167

    
168
                        /** Sends a set of page and buffer address bytes to the currently selected dataflash IC, for use with
169
                         *  dataflash commands which require a complete 24-bit address.
170
                         *
171
                         *  \param[in] PageAddress  Page address within the selected dataflash IC
172
                         *  \param[in] BufferByte   Address within the dataflash's buffer
173
                         */
174
                        static inline void Dataflash_SendAddressBytes(uint16_t PageAddress, const uint16_t BufferByte)
175
                        {
176
                                #if (DATAFLASH_TOTALCHIPS == 2)
177
                                        PageAddress >>= 1;
178
                                #endif
179

    
180
                                Dataflash_SendByte(PageAddress >> 5);
181
                                Dataflash_SendByte((PageAddress << 3) | (BufferByte >> 8));
182
                                Dataflash_SendByte(BufferByte);
183
                        }
184

    
185
#endif
186