summaryrefslogtreecommitdiff
path: root/nuttx/arch/arm/src/samv7/sam_hsmci.h
diff options
context:
space:
mode:
authorGregory Nutt <gnutt@nuttx.org>2015-03-12 18:03:41 -0600
committerGregory Nutt <gnutt@nuttx.org>2015-03-12 18:03:41 -0600
commit6f59721d9f9c97a4b561dd4875c626211719dda6 (patch)
tree1117279d09088c591989134bf488a0222397734d /nuttx/arch/arm/src/samv7/sam_hsmci.h
parentf4a2cfceab0faf654716c619dc6e6eb610dede55 (diff)
downloadpx4-nuttx-6f59721d9f9c97a4b561dd4875c626211719dda6.tar.gz
px4-nuttx-6f59721d9f9c97a4b561dd4875c626211719dda6.tar.bz2
px4-nuttx-6f59721d9f9c97a4b561dd4875c626211719dda6.zip
SAMV7: Quick'n'dirty port of the SAMA5 HSMCI driver to the SAMV7
Diffstat (limited to 'nuttx/arch/arm/src/samv7/sam_hsmci.h')
-rw-r--r--nuttx/arch/arm/src/samv7/sam_hsmci.h175
1 files changed, 175 insertions, 0 deletions
diff --git a/nuttx/arch/arm/src/samv7/sam_hsmci.h b/nuttx/arch/arm/src/samv7/sam_hsmci.h
new file mode 100644
index 000000000..7ddfc104d
--- /dev/null
+++ b/nuttx/arch/arm/src/samv7/sam_hsmci.h
@@ -0,0 +1,175 @@
+/************************************************************************************
+ * arch/arm/src/samv7/sam_hsmci.h
+ *
+ * Copyright (C) 2015 Gregory Nutt. All rights reserved.
+ * Author: Gregory Nutt <gnutt@nuttx.org>
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in
+ * the documentation and/or other materials provided with the
+ * distribution.
+ * 3. Neither the name NuttX nor the names of its contributors may be
+ * used to endorse or promote products derived from this software
+ * without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+ * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+ * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+ * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+ * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
+ * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
+ * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+ * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ *
+ ************************************************************************************/
+
+#ifndef __ARCH_ARM_SRC_SAMV7_SAM_HSMCI_H
+#define __ARCH_ARM_SRC_SAMV7_SAM_HSMCI_H
+
+/************************************************************************************
+ * Included Files
+ ************************************************************************************/
+
+#include <nuttx/config.h>
+
+#include <stdint.h>
+#include <stdbool.h>
+
+/************************************************************************************
+ * Definitions
+ ************************************************************************************/
+
+/************************************************************************************
+ * Public Types
+ ************************************************************************************/
+
+/************************************************************************************
+ * Inline Functions
+ ************************************************************************************/
+
+#ifndef __ASSEMBLY__
+
+/************************************************************************************
+ * Public Data
+ ************************************************************************************/
+
+#undef EXTERN
+#if defined(__cplusplus)
+#define EXTERN extern "C"
+extern "C"
+{
+#else
+#define EXTERN extern
+#endif
+
+/************************************************************************************
+ * Public Function Prototypes
+ ************************************************************************************/
+
+/****************************************************************************
+ * Name: sdio_initialize
+ *
+ * Description:
+ * Initialize SDIO for operation.
+ *
+ * Input Parameters:
+ * slotno - Not used.
+ *
+ * Returned Values:
+ * A reference to an SDIO interface structure. NULL is returned on failures.
+ *
+ ****************************************************************************/
+
+struct sdio_dev_s; /* See include/nuttx/sdio.h */
+FAR struct sdio_dev_s *sdio_initialize(int slotno);
+
+/****************************************************************************
+ * Name: sam_hsmci_clkdiv
+ *
+ * Description:
+ * Multimedia Card Interface clock (MCCK or MCI_CK) is Master Clock (MCK)
+ * divided by (2*(CLKDIV) + CLOCKODD + 2).
+ *
+ * CLKFULLDIV = 2*CLKDIV + CLOCKODD;
+ * MCI_SPEED = MCK / (CLKFULLDIV + 2)
+ * CLKFULLDIV = MCK / MCI_SPEED - 2
+ *
+ * CLKDIV = CLKFULLDIV >> 1
+ * CLOCKODD = CLKFULLDIV & 1
+ *
+ * Where CLKDIV has a range of 0-255.
+ *
+ * NOTE: The primary use of this function is for cases where the clock
+ * frequencies are not known a priori and so HSMCI clock dividers must
+ * be determined dynamically. This is the case, for example, when we
+ * execute out of SDRAM. In that case, the clocking was set up by the
+ * bootloader that brought us into SDRAM and it is that bootloader that
+ * has configured the clocking.
+ *
+ * Input parameters:
+ * target - The target SD frequency
+ *
+ * Returned Value:
+ * A bitset containing the CLKDIV and CLKODD bits as needed to configure
+ * the HSMCI clock output.
+ *
+ ****************************************************************************/
+
+uint32_t sam_hsmci_clkdiv(uint32_t target);
+
+/****************************************************************************
+ * Name: sdio_mediachange
+ *
+ * Description:
+ * Called by board-specific logic -- possibly from an interrupt handler --
+ * in order to signal to the driver that a card has been inserted or
+ * removed from the slot
+ *
+ * Input Parameters:
+ * dev - An instance of the SDIO driver device state structure.
+ * cardinslot - true is a card has been detected in the slot; false if a
+ * card has been removed from the slot. Only transitions
+ * (inserted->removed or removed->inserted should be reported)
+ *
+ * Returned Values:
+ * None
+ *
+ ****************************************************************************/
+
+void sdio_mediachange(FAR struct sdio_dev_s *dev, bool cardinslot);
+
+/****************************************************************************
+ * Name: sdio_wrprotect
+ *
+ * Description:
+ * Called by board-specific logic to report if the card in the slot is
+ * mechanically write protected.
+ *
+ * Input Parameters:
+ * dev - An instance of the SDIO driver device state structure.
+ * wrprotect - true is a card is writeprotected.
+ *
+ * Returned Values:
+ * None
+ *
+ ****************************************************************************/
+
+void sdio_wrprotect(FAR struct sdio_dev_s *dev, bool wrprotect);
+
+#undef EXTERN
+#if defined(__cplusplus)
+}
+#endif
+
+#endif /* __ASSEMBLY__ */
+#endif /* __ARCH_ARM_SRC_SAMV7_SAM_HSMCI_H */