no_os_dma.h

Go to the documentation of this file.

/***************************************************************************/
#ifndef _NO_OS_DMA_H_
#define _NO_OS_DMA_H_
 
#include <stdio.h>
#include <stdlib.h>
#include <stdint.h>
 
#include "no_os_list.h"
#include "no_os_irq.h"
#include "no_os_mutex.h"
 
enum no_os_dma_xfer_type {
    MEM_TO_MEM,
    MEM_TO_DEV,
    DEV_TO_MEM,
};
 
struct no_os_dma_default_handler_data {
    struct no_os_dma_desc *desc;
    struct no_os_dma_ch *channel;
    void *extra;
};
 
struct no_os_dma_platform_ops;
 
struct no_os_dma_xfer_desc {
    uint8_t *src;
    uint8_t *dst;
    uint32_t length;
    enum no_os_dma_xfer_type xfer_type;
 
    void (*xfer_complete_cb)(struct no_os_dma_xfer_desc *,
                 struct no_os_dma_xfer_desc *,
                 void *);
    void *xfer_complete_ctx;
    uint32_t irq_priority;
 
    enum no_os_irq_peripheral periph;
 
    void *extra;
};
 
struct no_os_dma_ch {
    uint32_t id;
    bool free;
    struct no_os_list_desc *sg_list;
    uint32_t irq_num;
    struct no_os_dma_default_handler_data irq_ctx;
    void *extra;
 
    void *mutex;
 
    bool sync_lock;
};
 
struct no_os_dma_desc {
    uint32_t id;
    uint32_t num_ch;
    struct no_os_dma_ch *channels;
    struct no_os_dma_platform_ops *platform_ops;
    struct no_os_irq_ctrl_desc *irq_ctrl;
    void *extra;
    uint32_t ref;
    void *mutex;
 
    void (*sg_handler)(void *);
};
 
struct no_os_dma_init_param {
    uint32_t id;
    uint32_t num_ch;
    struct no_os_dma_platform_ops *platform_ops;
    void *extra;
 
    void (*sg_handler)(void *);
    void *ctx;
};
 
int no_os_dma_init(struct no_os_dma_desc **,
           struct no_os_dma_init_param *);
 
int no_os_dma_remove(struct no_os_dma_desc *);
 
int no_os_dma_config_xfer(struct no_os_dma_desc *,
              struct no_os_dma_xfer_desc *,
              uint32_t,
              struct no_os_dma_ch *);
 
int no_os_dma_chan_lock(struct no_os_dma_ch *);
 
int no_os_dma_chan_unlock(struct no_os_dma_ch *);
 
int no_os_dma_xfer_start(struct no_os_dma_desc *, struct no_os_dma_ch *);
 
int no_os_dma_xfer_abort(struct no_os_dma_desc *, struct no_os_dma_ch *);
 
bool no_os_dma_is_completed(struct no_os_dma_desc *, struct no_os_dma_ch *);
 
bool no_os_dma_in_progress(struct no_os_dma_desc *, struct no_os_dma_ch *);
 
int no_os_dma_acquire_channel(struct no_os_dma_desc *, struct no_os_dma_ch **);
 
int no_os_dma_release_channel(struct no_os_dma_desc *, struct no_os_dma_ch *);
 
struct no_os_dma_platform_ops {
    int (*dma_init)(struct no_os_dma_desc **, struct no_os_dma_init_param *);
    int (*dma_remove)(struct no_os_dma_desc *desc);
    int (*dma_acquire_ch)(struct no_os_dma_desc *, uint32_t *);
    int (*dma_release_ch)(struct no_os_dma_desc *, uint32_t);
    int (*dma_config_xfer)(struct no_os_dma_ch *,
                   struct no_os_dma_xfer_desc *);
    int (*dma_xfer_start)(struct no_os_dma_desc *, struct no_os_dma_ch *);
    int (*dma_xfer_abort)(struct no_os_dma_desc *, struct no_os_dma_ch *);
    bool (*dma_ch_is_completed)(struct no_os_dma_desc *, struct no_os_dma_ch *);
    bool (*dma_ch_in_progress)(struct no_os_dma_desc *, struct no_os_dma_ch *);
};
 
#endif