Get rid of the redundant ATTR_NEVER_INLINE macro which translated to the same as...
[pub/USBasp.git] / LUFA / Drivers / Board / AVR8 / XPLAIN / Dataflash.h
index 71ff72b..d8bb12b 100644 (file)
@@ -1,13 +1,13 @@
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2011.
+     Copyright (C) Dean Camera, 2013.
 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*
-  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2013  Dean Camera (dean [at] fourwalledcubicle [dot] com)
 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted
@@ -18,7 +18,7 @@
   advertising or publicity pertaining to distribution of the
   software without specific, written prior permission.
 
-  The author disclaim all warranties with regard to this
+  The author disclaims all warranties with regard to this
   software, including all implied warranties of merchantability
   and fitness.  In no event shall the author be liable for any
   special, indirect or consequential damages or any damages
@@ -29,7 +29,7 @@
 */
 
 /** \file
- *  \brief Board specific Dataflash driver header for the Atmel XPLAIN.
+ *  \brief Board specific Dataflash driver header for the original Atmel XPLAIN.
  *  \copydetails Group_Dataflash_XPLAIN
  *
  *  \note This file should not be included directly. It is automatically included as needed by the dataflash driver
  */
 
 /** \ingroup Group_Dataflash
+ *  \defgroup Group_Dataflash_XPLAIN_REV1 XPLAIN_REV1
+ *  \brief Board specific Dataflash driver header for the original Atmel XPLAIN, revision 1.
+ *
+ *  See \ref Group_Dataflash_XPLAIN for more details.
+ */
+
+/** \ingroup Group_Dataflash
  *  \defgroup Group_Dataflash_XPLAIN XPLAIN
- *  \brief Board specific Dataflash driver header for the Atmel XPLAIN.
+ *  \brief Board specific Dataflash driver header for the original Atmel XPLAIN.
+ *
+ *  \note For the first revision XPLAIN board, compile with <code>BOARD = BOARD_XPLAIN_REV1</code>.
  *
  *  Board specific Dataflash driver header for the Atmel XPLAIN.
  *
+ *  <b>Revision 1 Boards</b>:
+ *  <table>
+ *    <tr><th>Name</th><th>Info</th><th>Select Pin</th><th>SPI Port</th></tr>
+ *    <tr><td>DATAFLASH_CHIP1</td><td>AT45DB041D (512KB)</td><td>PORTB.5</td><td>SPI0</td></tr>
+ *  </table>
+ *
+ *  <b>Other Board Revisions</b>:
+ *  <table>
+ *    <tr><th>Name</th><th>Info</th><th>Select Pin</th><th>SPI Port</th></tr>
+ *    <tr><td>DATAFLASH_CHIP1</td><td>AT45DB642D (8MB)</td><td>PORTB.5</td><td>SPI0</td></tr>
+ *  </table>
+ *
  *  @{
  */
 
@@ -50,7 +71,9 @@
 
        /* Includes: */
                #include "../../../../Common/Common.h"
+
                #include "../../../Misc/AT45DB642D.h"
+               #include "../../../Peripheral/SPI.h"
 
        /* Preprocessor Checks: */
                #if !defined(__INCLUDE_FROM_DATAFLASH_H)
@@ -60,7 +83,7 @@
        /* Private Interface - For use in library only: */
        #if !defined(__DOXYGEN__)
                /* Macros: */
-                       #define DATAFLASH_CHIPCS_MASK                (1 << 5)
+                       #define DATAFLASH_CHIPCS_MASK                DATAFLASH_CHIP1
                        #define DATAFLASH_CHIPCS_DDR                 DDRB
                        #define DATAFLASH_CHIPCS_PORT                PORTB
        #endif
                        #define DATAFLASH_TOTALCHIPS                 1
 
                        /** Mask for no dataflash chip selected. */
-                       #define DATAFLASH_NO_CHIP                    DATAFLASH_CHIPCS_MASK
+                       #define DATAFLASH_NO_CHIP                    0
 
                        /** Mask for the first dataflash chip selected. */
-                       #define DATAFLASH_CHIP1                      0
+                       #define DATAFLASH_CHIP1                      (1 << 5)
 
                        #if ((BOARD != BOARD_XPLAIN_REV1) || defined(__DOXYGEN__))
                                /** Internal main memory page size for the board's dataflash ICs. */
 
                /* Inline Functions: */
                        /** Initializes the dataflash driver so that commands and data may be sent to an attached dataflash IC.
-                        *  The microcontroller's SPI driver MUST be initialized before any of the dataflash commands are used.
+                        *  The appropriate SPI interface will be automatically configured.
                         */
                        static inline void Dataflash_Init(void)
                        {
                                DATAFLASH_CHIPCS_DDR  |= DATAFLASH_CHIPCS_MASK;
                                DATAFLASH_CHIPCS_PORT |= DATAFLASH_CHIPCS_MASK;
+
+                               SPI_Init(SPI_SPEED_FCPU_DIV_2 | SPI_ORDER_MSB_FIRST | SPI_SCK_LEAD_FALLING | SPI_SAMPLE_TRAILING | SPI_MODE_MASTER);
                        }
 
                        /** Sends a byte to the currently selected dataflash IC, and returns a byte from the dataflash.
                         *
-                        *  \param[in] Byte of data to send to the dataflash
+                        *  \param[in] Byte  Byte of data to send to the dataflash
                         *
                         *  \return Last response byte from the dataflash
                         */
 
                        /** Sends a byte to the currently selected dataflash IC, and ignores the next byte from the dataflash.
                         *
-                        *  \param[in] Byte of data to send to the dataflash
+                        *  \param[in] Byte  Byte of data to send to the dataflash
                         */
                        static inline void Dataflash_SendByte(const uint8_t Byte) ATTR_ALWAYS_INLINE;
                        static inline void Dataflash_SendByte(const uint8_t Byte)
                        /** Determines the currently selected dataflash chip.
                         *
                         *  \return Mask of the currently selected Dataflash chip, either \ref DATAFLASH_NO_CHIP if no chip is selected
-                        *  or a DATAFLASH_CHIPn mask (where n is the chip number).
+                        *          or a DATAFLASH_CHIPn mask (where n is the chip number).
                         */
                        static inline uint8_t Dataflash_GetSelectedChip(void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT;
                        static inline uint8_t Dataflash_GetSelectedChip(void)
                        {
-                               return (DATAFLASH_CHIPCS_PORT & DATAFLASH_CHIPCS_MASK);
+                               return (~DATAFLASH_CHIPCS_PORT & DATAFLASH_CHIPCS_MASK);
                        }
 
                        /** Selects the given dataflash chip.
                         *
-                        *  \param[in]  ChipMask  Mask of the Dataflash IC to select, in the form of DATAFLASH_CHIPn mask (where n is
+                        *  \param[in]  ChipMask  Mask of the Dataflash IC to select, in the form of a \c DATAFLASH_CHIPn mask (where n is
                         *              the chip number).
                         */
                        static inline void Dataflash_SelectChip(const uint8_t ChipMask) ATTR_ALWAYS_INLINE;
                        static inline void Dataflash_SelectChip(const uint8_t ChipMask)
                        {
-                               DATAFLASH_CHIPCS_PORT = ((DATAFLASH_CHIPCS_PORT & ~DATAFLASH_CHIPCS_MASK) | ChipMask);
+                               DATAFLASH_CHIPCS_PORT = ((DATAFLASH_CHIPCS_PORT | DATAFLASH_CHIPCS_MASK) & ~ChipMask);
                        }
 
                        /** Deselects the current dataflash chip, so that no dataflash is selected. */