DmaManager.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020 Teknic, Inc.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#ifndef __DMAMANAGER_H__
#define __DMAMANAGER_H__

#include <stdint.h>
#include <sam.h>

#ifndef HIDE_FROM_DOXYGEN
namespace ClearCore {

/* DMA channels */
typedef enum {
    DMA_ADC_RESULTS,    
    DMA_ADC_SEQUENCE,   
    DMA_SERCOM0_SPI_RX, 
    DMA_SERCOM0_SPI_TX, 
    DMA_SERCOM7_SPI_RX, 
    DMA_SERCOM7_SPI_TX, 
    DMA_CHANNEL_COUNT,  // Keep at end
    DMA_INVALID_CHANNEL // Placeholder for unset values
} DmaChannels;

class DmaManager {
    friend class SysManager;

public:
    static DmacChannel *Channel(DmaChannels index);
    static DmacDescriptor *BaseDescriptor(DmaChannels index);

    static DmaManager &Instance();
private:

    static DmacDescriptor writeBackDescriptor[DMA_CHANNEL_COUNT] __attribute__((
                aligned(16)));
    static DmacDescriptor descriptorBase[DMA_CHANNEL_COUNT] __attribute__((aligned(
                16)));

    DmaManager() {};

    static void Initialize();
}; // DmaManager

} // ClearCore namespace

#endif // HIDE_FROM_DOXYGEN
#endif // __DMAMANAGER_H__