247 lines
8.5 KiB
C
247 lines
8.5 KiB
C
/****************************************************************************
|
|
* arch/arm/src/lpc17xx_40xx/lpc17_40_gpdma.h
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*
|
|
* Licensed to the Apache Software Foundation (ASF) under one or more
|
|
* contributor license agreements. See the NOTICE file distributed with
|
|
* this work for additional information regarding copyright ownership. The
|
|
* ASF licenses this file to you under the Apache License, Version 2.0 (the
|
|
* "License"); you may not use this file except in compliance with the
|
|
* License. You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
* License for the specific language governing permissions and limitations
|
|
* under the License.
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifndef __ARCH_ARM_SRC_LPC17XX_40XX_LPC17_40_GPDMA_H
|
|
#define __ARCH_ARM_SRC_LPC17XX_40XX_LPC17_40_GPDMA_H
|
|
|
|
/****************************************************************************
|
|
* Included Files
|
|
****************************************************************************/
|
|
|
|
#include <nuttx/config.h>
|
|
#include "hardware/lpc17_40_gpdma.h"
|
|
|
|
/****************************************************************************
|
|
* Pre-processor Definitions
|
|
****************************************************************************/
|
|
|
|
/****************************************************************************
|
|
* Public Types
|
|
****************************************************************************/
|
|
|
|
#ifdef CONFIG_LPC17_40_GPDMA
|
|
/* DMA_HANDLE is an opaque reference to an allocated DMA channel */
|
|
|
|
typedef void *DMA_HANDLE;
|
|
|
|
/* dma_callback_t a function pointer provided to lpc17_40_dmastart. This
|
|
* function is called at the completion of the DMA transfer. 'arg' is the
|
|
* same 'arg' value that was provided when lpc17_40_dmastart() was called and
|
|
* result indicates the result of the transfer: Zero indicates a successful
|
|
* transfers. On failure, a negated errno is returned indicating the general
|
|
* nature of the DMA failure.
|
|
*/
|
|
|
|
typedef void (*dma_callback_t)(DMA_HANDLE handle, void *arg, int result);
|
|
|
|
/* The following is used for sampling DMA registers when CONFIG DEBUG_DMA
|
|
* is selected
|
|
*/
|
|
|
|
#ifdef CONFIG__DEBUG_DMA_INFO
|
|
struct lpc17_40_dmaglobalregs_s
|
|
{
|
|
/* Global Registers */
|
|
|
|
uint32_t intst; /* DMA Interrupt Status Register */
|
|
uint32_t inttcst; /* DMA Interrupt Terminal Count Request Status Register */
|
|
uint32_t interrst; /* DMA Interrupt Error Status Register */
|
|
uint32_t rawinttcst; /* DMA Raw Interrupt Terminal Count Status Register */
|
|
uint32_t rawinterrst; /* DMA Raw Error Interrupt Status Register */
|
|
uint32_t enbldchns; /* DMA Enabled Channel Register */
|
|
uint32_t softbreq; /* DMA Software Burst Request Register */
|
|
uint32_t softsreq; /* DMA Software Single Request Register */
|
|
uint32_t softlbreq; /* DMA Software Last Burst Request Register */
|
|
uint32_t softlsreq; /* DMA Software Last Single Request Register */
|
|
uint32_t config; /* DMA Configuration Register */
|
|
uint32_t sync; /* DMA Synchronization Register */
|
|
};
|
|
|
|
struct lpc17_40_dmachanregs_s
|
|
{
|
|
/* Channel Registers */
|
|
|
|
uint32_t srcaddr; /* DMA Channel Source Address Register */
|
|
uint32_t destaddr; /* DMA Channel Destination Address Register */
|
|
uint32_t lli; /* DMA Channel Linked List Item Register */
|
|
uint32_t control; /* DMA Channel Control Register */
|
|
uint32_t config; /* DMA Channel Configuration Register */
|
|
};
|
|
|
|
struct lpc17_40_dmaregs_s
|
|
{
|
|
/* Global Registers */
|
|
|
|
struct lpc17_40_dmaglobalregs_s gbl;
|
|
|
|
/* Channel Registers */
|
|
|
|
struct lpc17_40_dmachanregs_s ch;
|
|
};
|
|
|
|
#endif /* CONFIG__DEBUG_DMA_INFO */
|
|
|
|
/****************************************************************************
|
|
* Public Data
|
|
****************************************************************************/
|
|
|
|
#ifndef __ASSEMBLY__
|
|
#undef EXTERN
|
|
#if defined(__cplusplus)
|
|
#define EXTERN extern "C"
|
|
extern "C"
|
|
{
|
|
#else
|
|
#define EXTERN extern
|
|
#endif
|
|
|
|
/* If the following value is zero, then there is no DMA in progress. This
|
|
* value is needed in the IDLE loop to determine if the IDLE loop should
|
|
* go into lower power power consumption modes. According to the LPC17xx
|
|
* User Manual: "The DMA controller can continue to work in Sleep mode, and
|
|
* has access to the peripheral SRAMs and all peripheral registers. The
|
|
* flash memory and the Main SRAM are not available in Sleep mode, they are
|
|
* disabled in order to save power."
|
|
*/
|
|
|
|
EXTERN volatile uint8_t g_dma_inprogress;
|
|
|
|
/****************************************************************************
|
|
* Public Functions Prototypes
|
|
****************************************************************************/
|
|
|
|
/****************************************************************************
|
|
* Name: lpc17_40_dmaconfigure
|
|
*
|
|
* Description:
|
|
* Configure a DMA request. Each DMA request may have two different DMA
|
|
* request sources. This associates one of the sources with a DMA request.
|
|
*
|
|
* Returned Value:
|
|
* None
|
|
*
|
|
****************************************************************************/
|
|
|
|
void lpc17_40_dmaconfigure(uint8_t dmarequest, bool alternate);
|
|
|
|
/****************************************************************************
|
|
* Name: lpc17_40_dmachannel
|
|
*
|
|
* Description:
|
|
* Allocate a DMA channel. This function sets aside a DMA channel and
|
|
* gives the caller exclusive access to the DMA channel.
|
|
*
|
|
* Returned Value:
|
|
* On success, this function returns a non-NULL, void* DMA channel handle.
|
|
* NULL is returned on any failure. This function can fail only if no DMA
|
|
* channel is available.
|
|
*
|
|
****************************************************************************/
|
|
|
|
DMA_HANDLE lpc17_40_dmachannel(void);
|
|
|
|
/****************************************************************************
|
|
* Name: lpc17_40_dmafree
|
|
*
|
|
* Description:
|
|
* Release a DMA channel. NOTE: The 'handle' used in this argument must
|
|
* NEVER be used again until lpc17_40_dmachannel() is called again to
|
|
* re-gain a valid handle.
|
|
*
|
|
* Returned Value:
|
|
* None
|
|
*
|
|
****************************************************************************/
|
|
|
|
void lpc17_40_dmafree(DMA_HANDLE handle);
|
|
|
|
/****************************************************************************
|
|
* Name: lpc17_40_dmasetup
|
|
*
|
|
* Description:
|
|
* Configure DMA for one transfer.
|
|
*
|
|
****************************************************************************/
|
|
|
|
int lpc17_40_dmasetup(DMA_HANDLE handle, uint32_t control, uint32_t config,
|
|
uint32_t srcaddr, uint32_t destaddr, size_t nxfrs);
|
|
|
|
/****************************************************************************
|
|
* Name: lpc17_40_dmastart
|
|
*
|
|
* Description:
|
|
* Start the DMA transfer
|
|
*
|
|
****************************************************************************/
|
|
|
|
int lpc17_40_dmastart(DMA_HANDLE handle, dma_callback_t callback, void *arg);
|
|
|
|
/****************************************************************************
|
|
* Name: lpc17_40_dmastop
|
|
*
|
|
* Description:
|
|
* Cancel the DMA. After lpc17_40_dmastop() is called, the DMA channel is
|
|
* reset and lpc17_40_dmasetup() must be called before lpc17_40_dmastart()
|
|
* can be called again
|
|
*
|
|
****************************************************************************/
|
|
|
|
void lpc17_40_dmastop(DMA_HANDLE handle);
|
|
|
|
/****************************************************************************
|
|
* Name: lpc17_40_dmasample
|
|
*
|
|
* Description:
|
|
* Sample DMA register contents
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifdef CONFIG__DEBUG_DMA_INFO
|
|
void lpc17_40_dmasample(DMA_HANDLE handle, struct lpc17_40_dmaregs_s *regs);
|
|
#else
|
|
# define lpc17_40_dmasample(handle,regs)
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Name: lpc17_40_dmadump
|
|
*
|
|
* Description:
|
|
* Dump previously sampled DMA register contents
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifdef CONFIG__DEBUG_DMA_INFO
|
|
void lpc17_40_dmadump(DMA_HANDLE handle,
|
|
const struct lpc17_40_dmaregs_s *regs,
|
|
const char *msg);
|
|
#else
|
|
# define lpc17_40_dmadump(handle,regs,msg)
|
|
#endif
|
|
|
|
#undef EXTERN
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* __ASSEMBLY__ */
|
|
#endif /* CONFIG_LPC17_40_GPDMA */
|
|
#endif /* __ARCH_ARM_SRC_LPC17XX_40XX_LPC17_40_GPDMA_H */
|