Statistics
| Branch: | Tag: | Revision:

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

History | View | Annotate | Download (6.8 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 STK525.
33
 *  \copydetails Group_Dataflash_STK525
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_STK525 STK525
41
 *  \brief Board specific Dataflash driver header for the Atmel STK525.
42
 *
43
 *  Board specific Dataflash driver header for the Atmel STK525.
44
 *
45
 *  @{
46
 */
47

    
48
#ifndef __DATAFLASH_STK525_H__
49
#define __DATAFLASH_STK525_H__
50

    
51
        /* Includes: */
52
                #include "../../../../Common/Common.h"
53
                #include "../../../Misc/AT45DB321C.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 << 4)
64
                        #define DATAFLASH_CHIPCS_DDR                 DDRB
65
                        #define DATAFLASH_CHIPCS_PORT                PORTB
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                 1
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                      0
78

    
79
                        /** Internal main memory page size for the board's dataflash IC. */
80
                        #define DATAFLASH_PAGE_SIZE                  512
81

    
82
                        /** Total number of pages inside the board's dataflash IC. */
83
                        #define DATAFLASH_PAGES                      8192
84

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

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

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

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

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

    
137
                                if (PageAddress >= DATAFLASH_PAGES)
138
                                  return;
139

    
140
                                Dataflash_SelectChip(DATAFLASH_CHIP1);
141
                        }
142

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

    
150
                                Dataflash_DeselectChip();
151
                                Dataflash_SelectChip(SelectedChipMask);
152
                        }
153

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

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

    
179
#endif
180

    
181
/** @} */
182