+++ /dev/null
-/*\r
- LUFA Library\r
- Copyright (C) Dean Camera, 2012.\r
-\r
- dean [at] fourwalledcubicle [dot] com\r
- www.lufa-lib.org\r
-*/\r
-\r
-/*\r
- Copyright 2012 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, including all implied warranties of merchantability\r
- and fitness. In no event shall the author be liable for any\r
- special, indirect or consequential damages or any damages\r
- whatsoever resulting from loss of use, data or profits, whether\r
- in an action of contract, negligence or other tortious action,\r
- arising out of or in connection with the use or performance of\r
- this software.\r
-*/\r
-\r
-/** \file\r
- * \brief LUFA Custom Board Dataflash Hardware Driver (Template)\r
- *\r
- * This is a stub driver header file, for implementing custom board\r
- * layout hardware with compatible LUFA board specific drivers. If\r
- * the library is configured to use the BOARD_USER board mode, this\r
- * driver file should be completed and copied into the "/Board/" folder\r
- * inside the application's folder.\r
- *\r
- * This stub is for the board-specific component of the LUFA Dataflash\r
- * driver.\r
-*/\r
-\r
-#ifndef __DATAFLASH_USER_H__\r
-#define __DATAFLASH_USER_H__\r
-\r
- /* Includes: */\r
- // TODO: Add any required includes here\r
-\r
- /* Preprocessor Checks: */\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
- /* Private Interface - For use in library only: */\r
- #if !defined(__DOXYGEN__)\r
- /* Macros: */\r
- #define DATAFLASH_CHIPCS_MASK // TODO: Replace this with a mask of all the /CS pins of all Dataflashes\r
- #define DATAFLASH_CHIPCS_DDR // TODO: Replace with the DDR register name for the board's Dataflash ICs\r
- #define DATAFLASH_CHIPCS_PORT // TODO: Replace with the PORT register name for the board's Dataflash ICs\r
- #endif\r
-\r
- /* Public Interface - May be used in end-application: */\r
- /* Macros: */\r
- /** Constant indicating the total number of dataflash ICs mounted on the selected board. */\r
- #define DATAFLASH_TOTALCHIPS 1 // TODO: Replace with the number of Dataflashes on the board, max 2\r
-\r
- /** Mask for no dataflash chip selected. */\r
- #define DATAFLASH_NO_CHIP DATAFLASH_CHIPCS_MASK\r
-\r
- /** Mask for the first dataflash chip selected. */\r
- #define DATAFLASH_CHIP1 // TODO: Replace with mask to hold /CS of first Dataflash low, and all others high\r
-\r
- /** Mask for the second dataflash chip selected. */\r
- #define DATAFLASH_CHIP2 // TODO: Replace with mask to hold /CS of second Dataflash low, and all others high\r
-\r
- /** Internal main memory page size for the board's dataflash ICs. */\r
- #define DATAFLASH_PAGE_SIZE // TODO: Replace with the page size for the Dataflash ICs\r
-\r
- /** Total number of pages inside each of the board's dataflash ICs. */\r
- #define DATAFLASH_PAGES // TODO: Replace with the total number of pages inside one of the Dataflash ICs\r
-\r
- /* Inline Functions: */\r
- /** Initializes the dataflash driver so that commands and data may be sent to an attached dataflash IC.\r
- * The microcontroller's SPI driver MUST be initialized before any of the dataflash commands are used.\r
- */\r
- static inline void Dataflash_Init(void)\r
- {\r
- DATAFLASH_CHIPCS_DDR |= DATAFLASH_CHIPCS_MASK;\r
- DATAFLASH_CHIPCS_PORT |= DATAFLASH_CHIPCS_MASK;\r
- }\r
-\r
- /** Sends a byte to the currently selected dataflash IC, and returns a byte from the dataflash.\r
- *\r
- * \param[in] Byte Byte of data to send to the dataflash\r
- *\r
- * \return Last response byte from the dataflash\r
- */\r
- static inline uint8_t Dataflash_TransferByte(const uint8_t Byte) ATTR_ALWAYS_INLINE;\r
- static inline uint8_t Dataflash_TransferByte(const uint8_t Byte)\r
- {\r
- // TODO\r
- }\r
-\r
- /** Sends a byte to the currently selected dataflash IC, and ignores the next byte from the dataflash.\r
- *\r
- * \param[in] Byte Byte of data to send to the dataflash\r
- */\r
- static inline void Dataflash_SendByte(const uint8_t Byte) ATTR_ALWAYS_INLINE;\r
- static inline void Dataflash_SendByte(const uint8_t Byte)\r
- {\r
- // TODO\r
- }\r
-\r
- /** Sends a dummy byte to the currently selected dataflash IC, and returns the next byte from the dataflash.\r
- *\r
- * \return Last response byte from the dataflash\r
- */\r
- static inline uint8_t Dataflash_ReceiveByte(void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT;\r
- static inline uint8_t Dataflash_ReceiveByte(void)\r
- {\r
- // TODO\r
- }\r
-\r
- /** Determines the currently selected dataflash chip.\r
- *\r
- * \return Mask of the currently selected Dataflash chip, either \ref DATAFLASH_NO_CHIP if no chip is selected\r
- * or a DATAFLASH_CHIPn mask (where n is the chip number).\r
- */\r
- static inline uint8_t Dataflash_GetSelectedChip(void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT;\r
- static inline uint8_t Dataflash_GetSelectedChip(void)\r
- {\r
- return (DATAFLASH_CHIPCS_PORT & DATAFLASH_CHIPCS_MASK);\r
- }\r
-\r
- /** Selects the given dataflash chip.\r
- *\r
- * \param[in] ChipMask Mask of the Dataflash IC to select, in the form of DATAFLASH_CHIPn mask (where n is\r
- * the chip number).\r
- */\r
- static inline void Dataflash_SelectChip(const uint8_t ChipMask) ATTR_ALWAYS_INLINE;\r
- static inline void Dataflash_SelectChip(const uint8_t ChipMask)\r
- {\r
- DATAFLASH_CHIPCS_PORT = ((DATAFLASH_CHIPCS_PORT & ~DATAFLASH_CHIPCS_MASK) | ChipMask);\r
- }\r
-\r
- /** Deselects the current dataflash chip, so that no dataflash is selected. */\r
- static inline void Dataflash_DeselectChip(void) ATTR_ALWAYS_INLINE;\r
- static inline void Dataflash_DeselectChip(void)\r
- {\r
- Dataflash_SelectChip(DATAFLASH_NO_CHIP);\r
- }\r
-\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
- * 0 to ((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 (DATAFLASH_TOTALCHIPS == 2)\r
- if (PageAddress & 0x01)\r
- Dataflash_SelectChip(DATAFLASH_CHIP2);\r
- else\r
- Dataflash_SelectChip(DATAFLASH_CHIP1);\r
- #else\r
- Dataflash_SelectChip(DATAFLASH_CHIP1);\r
- #endif\r
- }\r
-\r
- /** Toggles the select line of the currently selected dataflash IC, so that it is ready to receive\r
- * a new command.\r
- */\r
- static inline void Dataflash_ToggleSelectedChipCS(void)\r
- {\r
- uint8_t SelectedChipMask = Dataflash_GetSelectedChip();\r
-\r
- Dataflash_DeselectChip();\r
- Dataflash_SelectChip(SelectedChipMask);\r
- }\r
-\r
- /** Spin-loops while the currently selected dataflash is busy executing a command, such as a main\r
- * memory page program or main memory to buffer transfer.\r
- */\r
- static inline void Dataflash_WaitWhileBusy(void)\r
- {\r
- Dataflash_ToggleSelectedChipCS();\r
- Dataflash_SendByte(DF_CMD_GETSTATUS);\r
- while (!(Dataflash_ReceiveByte() & DF_STATUS_READY));\r
- Dataflash_ToggleSelectedChipCS();\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-bit 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
- #if (DATAFLASH_TOTALCHIPS == 2)\r
- PageAddress >>= 1;\r
- #endif\r
-\r
- Dataflash_SendByte(PageAddress >> 5);\r
- Dataflash_SendByte((PageAddress << 3) | (BufferByte >> 8));\r
- Dataflash_SendByte(BufferByte);\r
- }\r
-\r
-#endif\r
-\r
projects / qmk_firmware.git / blobdiff