Make sure that long reads are aborted early if the connection times out while waiting...

[pub/USBasp.git] / LUFA / Drivers / Board / USBKEY / Dataflash.h

diff --git a/LUFA/Drivers/Board/USBKEY/Dataflash.h b/LUFA/Drivers/Board/USBKEY/Dataflash.h
index 848ae32..75bf289 100644 (file)
--- a/LUFA/Drivers/Board/USBKEY/Dataflash.h
+++ b/LUFA/Drivers/Board/USBKEY/Dataflash.h
@@ -1,21 +1,21 @@
 /*\r
              LUFA Library\r
 /*\r
              LUFA Library\r

-     Copyright (C) Dean Camera, 2009.\r
+     Copyright (C) Dean Camera, 2010.\r

               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\r
               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\r

-  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-\r
-  Permission to use, copy, modify, and distribute this software\r
-  and its documentation for any purpose and without fee is hereby\r
-  granted, provided that the above copyright notice appear in all\r
-  copies and that both that the copyright notice and this\r
-  permission notice and warranty disclaimer appear in supporting\r
-  documentation, and that the name of the author not be used in\r
-  advertising or publicity pertaining to distribution of the\r
+  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+\r
+  Permission to use, copy, modify, distribute, and sell this \r
+  software and its documentation for any purpose is hereby granted\r
+  without fee, provided that the above copyright notice appear in \r
+  all copies and that both that the copyright notice and this\r
+  permission notice and warranty disclaimer appear in supporting \r
+  documentation, and that the name of the author not be used in \r
+  advertising or publicity pertaining to distribution of the \r

   software without specific, written prior permission.\r
 \r
   The author disclaim all warranties with regard to this\r
   software without specific, written prior permission.\r
 \r
   The author disclaim all warranties with regard to this\r


@@ -29,13 +29,25 @@
 */\r
 \r
 /** \file\r
 */\r
 \r
 /** \file\r

+ *  \brief Board specific Dataflash driver header for the USBKEY.\r

  *\r
  *\r

- *  Board specific HWB driver header for the STK525.\r
+ *  Board specific Dataflash driver header for the USBKEY.\r

  *\r
  *  \note This file should not be included directly. It is automatically included as needed by the dataflash driver\r
  *        dispatch header located in LUFA/Drivers/Board/Dataflash.h.\r
  */\r
 \r
  *\r
  *  \note This file should not be included directly. It is automatically included as needed by the dataflash driver\r
  *        dispatch header located in LUFA/Drivers/Board/Dataflash.h.\r
  */\r
 \r

+/** \ingroup Group_Dataflash\r
+ *  @defgroup Group_Dataflash_USBKEY USBKEY\r
+ *\r
+ *  Board specific Dataflash driver header for the USBKEY board.\r
+ *\r
+ *  \note This file should not be included directly. It is automatically included as needed by the dataflash driver\r
+ *        dispatch header located in LUFA/Drivers/Board/Dataflash.h. \r
+ *\r
+ *  @{\r
+ */\r
+\r

 #ifndef __DATAFLASH_USBKEY_H__\r
 #define __DATAFLASH_USBKEY_H__\r
 \r
 #ifndef __DATAFLASH_USBKEY_H__\r
 #define __DATAFLASH_USBKEY_H__\r
 \r


@@ -43,7 +55,7 @@
                #include "AT45DB642D.h"\r
 \r
        /* Preprocessor Checks: */\r
                #include "AT45DB642D.h"\r
 \r
        /* Preprocessor Checks: */\r

-               #if !defined(INCLUDE_FROM_DATAFLASH_H)\r
+               #if !defined(__INCLUDE_FROM_DATAFLASH_H)\r

                        #error Do not include this file directly. Include LUFA/Drivers/Board/Dataflash.h instead.\r
                #endif\r
                \r
                        #error Do not include this file directly. Include LUFA/Drivers/Board/Dataflash.h instead.\r
                #endif\r
                \r


@@ -74,5 +86,45 @@
 \r
                        /** Total number of pages inside each of the board's dataflash ICs. */\r
                        #define DATAFLASH_PAGES                      8192\r
 \r
                        /** Total number of pages inside each of the board's dataflash ICs. */\r
                        #define DATAFLASH_PAGES                      8192\r

+                       \r
+               /* Inline Functions: */\r
+                       /** Selects a dataflash IC from the given page number, which should range from 0 to\r
+                        *  ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1). For boards containing only one\r
+                        *  dataflash IC, this will select DATAFLASH_CHIP1. If the given page number is outside\r
+                        *  the total number of pages contained in the boards dataflash ICs, all dataflash ICs\r
+                        *  are deselected.\r
+                        *\r
+                        *  \param[in] PageAddress  Address of the page to manipulate, ranging from\r
+                        *                          ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1).\r
+                        */\r
+                       static inline void Dataflash_SelectChipFromPage(const uint16_t PageAddress)\r
+                       {\r
+                               Dataflash_DeselectChip();\r
+                               \r
+                               if (PageAddress >= (DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS))\r
+                                 return;\r
+\r
+                               if (PageAddress & 0x01)\r
+                                 Dataflash_SelectChip(DATAFLASH_CHIP2);\r
+                               else\r
+                                 Dataflash_SelectChip(DATAFLASH_CHIP1);\r
+                       }\r
+\r
+                       /** Sends a set of page and buffer address bytes to the currently selected dataflash IC, for use with\r
+                        *  dataflash commands which require a complete 24-byte address.\r
+                        *\r
+                        *  \param[in] PageAddress  Page address within the selected dataflash IC\r
+                        *  \param[in] BufferByte   Address within the dataflash's buffer\r
+                        */\r
+                       static inline void Dataflash_SendAddressBytes(uint16_t PageAddress, const uint16_t BufferByte)\r
+                       {       \r
+                               PageAddress >>= 1;\r
+                               \r
+                               Dataflash_SendByte(PageAddress >> 5);\r
+                               Dataflash_SendByte((PageAddress << 3) | (BufferByte >> 8));\r
+                               Dataflash_SendByte(BufferByte);\r
+                       }               \r

 \r
 #endif\r
 \r
 #endif\r

+\r
+/** @} */\r