dma_space.h

Go to the documentation of this file.

/*
 * (c) 2014 Alexander Warg <alexander.warg@kernkonzept.com>
 *
 * License: see LICENSE.spdx (in this directory or the directories above)
 */
#pragma once

 
#include <l4/sys/compiler.h>
#include <l4/sys/types.h>
#include <l4/re/c/dataspace.h>
 
L4_BEGIN_DECLS

enum l4re_dma_space_direction
{
  L4RE_DMA_SPACE_BIDIRECTIONAL, 
  L4RE_DMA_SPACE_TO_DEVICE,     
  L4RE_DMA_SPACE_FROM_DEVICE,   
  L4RE_DMA_SPACE_NONE           
};

enum l4re_dma_space_attributes
{
  L4RE_DMA_SPACE_SEARCH_ADDR = 1U << 0, 
  L4RE_DMA_SPACE_PARTIAL_MAP = 1U << 1, 
  L4RE_DMA_SPACE_RESERVE     = 1U << 2, 
  L4RE_DMA_SPACE_REPLACE     = 1U << 3, 
};

enum l4re_dma_space_mgr_space_attribs
{
  L4RE_DMA_SPACE_MGR_IDENTITY_MAP = 1U << 0,
};

enum l4re_dma_space_mgr_block_flags
{
  L4RE_DMA_SPACE_MGR_SEARCH_ADDR = 1U << 0,
};

typedef l4_cap_idx_t l4re_dma_space_t;

typedef l4_cap_idx_t l4re_dma_space_mgr_t;

typedef l4_uint64_t l4re_dma_space_dma_addr_t;

typedef l4_uint64_t l4re_dma_space_dma_size_t;

L4_CV l4_ret_t
l4re_dma_space_map(l4re_dma_space_t dma, l4re_ds_t src,
                   l4re_ds_offset_t offset,
                   l4_size_t * size, unsigned long attrs,
                   enum l4re_dma_space_direction dir,
                   l4re_dma_space_dma_addr_t *dma_addr) L4_NOTHROW;
 

L4_CV l4_ret_t
l4re_dma_space_unmap(l4re_dma_space_t dma, l4re_dma_space_dma_addr_t dma_addr,
                     l4_size_t size, unsigned long attrs,
                     enum l4re_dma_space_direction dir) L4_NOTHROW;
 

L4_CV l4_ret_t
l4re_dma_space_mgr_associate(l4re_dma_space_mgr_t dma_mgr,
                             l4re_dma_space_t dma_space,
                             l4_cap_idx_t dma_task,
                             enum l4re_dma_space_mgr_space_attribs attr) L4_NOTHROW;

L4_CV l4_ret_t
l4re_dma_space_mgr_associate_phys(l4re_dma_space_mgr_t dma_mgr,
                                  l4re_dma_space_t dma_space,
                                  enum l4re_dma_space_mgr_space_attribs attr) L4_NOTHROW;

L4_CV l4_ret_t
l4re_dma_space_mgr_disassociate(l4re_dma_space_mgr_t dma_mgr,
                                l4re_dma_space_t dma_space) L4_NOTHROW;

L4_CV l4_ret_t
l4re_dma_space_mgr_block_area(l4re_dma_space_mgr_t dma_mgr,
                              l4re_dma_space_t dma_space,
                              l4re_dma_space_dma_addr_t *addr,
                              l4re_dma_space_dma_size_t size,
                              l4re_dma_space_dma_addr_t max_addr,
                              enum l4re_dma_space_mgr_block_flags flags,
                              unsigned char align) L4_NOTHROW;

L4_CV l4_ret_t
l4re_dma_space_mgr_set_limits(l4re_dma_space_mgr_t dma_mgr,
                              l4re_dma_space_t dma_space,
                              l4re_dma_space_dma_addr_t min_addr,
                              l4re_dma_space_dma_addr_t max_addr) L4_NOTHROW;
 
L4_END_DECLS