Statistics
| Branch: | Tag: | Revision:

root / LUFA / Drivers / Board / AVR8 / USBKEY / Dataflash.h @ 978b99e5

History | View | Annotate | Download (7.08 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
/** \file
32
 *  \brief Board specific Dataflash driver header for the Atmel USBKEY.
33
 *  \copydetails Group_Dataflash_USBKEY
34
 *
35
 *  \note This file should not be included directly. It is automatically included as needed by the dataflash driver
36
 *        dispatch header located in LUFA/Drivers/Board/Dataflash.h.
37
 */
38

    
39
/** \ingroup Group_Dataflash
40
 *  \defgroup Group_Dataflash_USBKEY USBKEY
41
 *  \brief Board specific Dataflash driver header for the Atmel USBKEY.
42
 *
43
 *  Board specific Dataflash driver header for the Atmel USBKEY board.
44
 *
45
 *  @{
46
 */
47

    
48
#ifndef __DATAFLASH_USBKEY_H__
49
#define __DATAFLASH_USBKEY_H__
50

    
51
        /* Includes: */
52
                #include "../../../../Common/Common.h"
53
                #include "../../../Misc/AT45DB642D.h"
54

    
55
        /* Preprocessor Checks: */
56
                #if !defined(__INCLUDE_FROM_DATAFLASH_H)
57
                        #error Do not include this file directly. Include LUFA/Drivers/Board/Dataflash.h instead.
58
                #endif
59

    
60
        /* Private Interface - For use in library only: */
61
        #if !defined(__DOXYGEN__)
62
                /* Macros: */
63
                        #define DATAFLASH_CHIPCS_MASK                ((1 << 1) | (1 << 0))
64
                        #define DATAFLASH_CHIPCS_DDR                 DDRE
65
                        #define DATAFLASH_CHIPCS_PORT                PORTE
66
        #endif
67

    
68
        /* Public Interface - May be used in end-application: */
69
                /* Macros: */
70
                        /** Constant indicating the total number of dataflash ICs mounted on the selected board. */
71
                        #define DATAFLASH_TOTALCHIPS                 2
72

    
73
                        /** Mask for no dataflash chip selected. */
74
                        #define DATAFLASH_NO_CHIP                    DATAFLASH_CHIPCS_MASK
75

    
76
                        /** Mask for the first dataflash chip selected. */
77
                        #define DATAFLASH_CHIP1                      (1 << 1)
78

    
79
                        /** Mask for the second dataflash chip selected. */
80
                        #define DATAFLASH_CHIP2                      (1 << 0)
81

    
82
                        /** Internal main memory page size for the board's dataflash ICs. */
83
                        #define DATAFLASH_PAGE_SIZE                  1024
84

    
85
                        /** Total number of pages inside each of the board's dataflash ICs. */
86
                        #define DATAFLASH_PAGES                      8192
87

    
88
                /* Inline Functions: */
89
                        /** Initializes the dataflash driver so that commands and data may be sent to an attached dataflash IC.
90
                         *  The microcontroller's SPI driver MUST be initialized before any of the dataflash commands are used.
91
                         */
92
                        static inline void Dataflash_Init(void)
93
                        {
94
                                DATAFLASH_CHIPCS_DDR  |= DATAFLASH_CHIPCS_MASK;
95
                                DATAFLASH_CHIPCS_PORT |= DATAFLASH_CHIPCS_MASK;
96
                        }
97

    
98
                        /** Determines the currently selected dataflash chip.
99
                         *
100
                         *  \return Mask of the currently selected Dataflash chip, either \ref DATAFLASH_NO_CHIP if no chip is selected
101
                         *  or a DATAFLASH_CHIPn mask (where n is the chip number).
102
                         */
103
                        static inline uint8_t Dataflash_GetSelectedChip(void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT;
104
                        static inline uint8_t Dataflash_GetSelectedChip(void)
105
                        {
106
                                return (DATAFLASH_CHIPCS_PORT & DATAFLASH_CHIPCS_MASK);
107
                        }
108

    
109
                        /** Selects the given dataflash chip.
110
                         *
111
                         *  \param[in]  ChipMask  Mask of the Dataflash IC to select, in the form of DATAFLASH_CHIPn mask (where n is
112
                         *              the chip number).
113
                         */
114
                        static inline void Dataflash_SelectChip(const uint8_t ChipMask) ATTR_ALWAYS_INLINE;
115
                        static inline void Dataflash_SelectChip(const uint8_t ChipMask)
116
                        {
117
                                DATAFLASH_CHIPCS_PORT = ((DATAFLASH_CHIPCS_PORT & ~DATAFLASH_CHIPCS_MASK) | ChipMask);
118
                        }
119

    
120
                        /** Deselects the current dataflash chip, so that no dataflash is selected. */
121
                        static inline void Dataflash_DeselectChip(void) ATTR_ALWAYS_INLINE;
122
                        static inline void Dataflash_DeselectChip(void)
123
                        {
124
                                Dataflash_SelectChip(DATAFLASH_NO_CHIP);
125
                        }
126

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

    
140
                                if (PageAddress >= (DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS))
141
                                  return;
142

    
143
                                if (PageAddress & 0x01)
144
                                  Dataflash_SelectChip(DATAFLASH_CHIP2);
145
                                else
146
                                  Dataflash_SelectChip(DATAFLASH_CHIP1);
147
                        }
148

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

    
156
                                Dataflash_DeselectChip();
157
                                Dataflash_SelectChip(SelectedChipMask);
158
                        }
159

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

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

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

    
187
#endif
188

    
189
/** @} */
190