Rename PDIProtocol.c/.h to XPROGProtocol.c/.h as it will now handle both TPI and...

[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..41ca278 100644 (file)
--- a/LUFA/Drivers/Board/USBKEY/Dataflash.h
+++ b/LUFA/Drivers/Board/USBKEY/Dataflash.h
@@ -30,12 +30,18 @@
 \r
 /** \file\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
+/** \ingroup Group_Dataflash\r
+ *  @defgroup Group_Dataflash_USBKEY USBKEY\r
+ *\r
+ *  @{\r
+ */\r
+\r
 #ifndef __DATAFLASH_USBKEY_H__\r
 #define __DATAFLASH_USBKEY_H__\r
 \r
@@ -74,5 +80,45 @@
 \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
+/** @} */\r