summaryrefslogtreecommitdiffstats
path: root/c/src/lib/libbsp/shared/vmeUniverse/bspVmeDmaList.h
blob: 25b1e9d16b9af76db20ed5951973ed8ad710d459 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
#ifndef BSP_VME_DMA_LIST_H
#define BSP_VME_DMA_LIST_H

/* $Id$ */


/* The bspVmeDmaList utility implements part of the API defined by
 * 'VMEDMA.h' namely all 'VMEDmaListDescriptor' related entry points:
 *
 * BSP_VMEDmaListDescriptorDestroy(),
 * BSP_VMEDmaListDestroy(),
 * BSP_VMEDmaListDescriptorEnq(),
 * BSP_VMEDmaListDescriptorNext(),
 * BSP_VMEDmaListDescriptorPrev(),
 * BSP_VMEDmaListDescriptorSetUsr(),
 * BSP_VMEDmaListDescriptorGetUsr(),
 * BSP_VMEDmaListRefresh()
 *
 * Also, it provides helper routines to assist BSPs with implementing
 *
 * BSP_VMEDmaListDescriptorSetup()
 *
 * and
 *
 * BSP_VMEDmaListStart()
 *
 * by providing
 *
 * BSP_VMEDmaListDescriptorNewTool(),
 * BSP_VMEDmaListDescriptorSetupTool(),
 *
 * and
 *
 * BSP_VMEDmaListDescriptorStartTool()
 *
 * This header should only be used inside a BSP
 * chosing to use bspVmeDmaList for implementing VMEDMA.h
 */

/*
 * Authorship
 * ----------
 * This software was created by
 *     Till Straumann <strauman@slac.stanford.edu>, 2006, 2007
 * 	   Stanford Linear Accelerator Center, Stanford University.
 *
 * Acknowledgement of sponsorship
 * ------------------------------
 * This software was produced by
 *     the Stanford Linear Accelerator Center, Stanford University,
 * 	   under Contract DE-AC03-76SFO0515 with the Department of Energy.
 *
 * Government disclaimer of liability
 * ----------------------------------
 * Neither the United States nor the United States Department of Energy,
 * nor any of their employees, makes any warranty, express or implied, or
 * assumes any legal liability or responsibility for the accuracy,
 * completeness, or usefulness of any data, apparatus, product, or process
 * disclosed, or represents that its use would not infringe privately owned
 * rights.
 *
 * Stanford disclaimer of liability
 * --------------------------------
 * Stanford University makes no representations or warranties, express or
 * implied, nor assumes any liability for the use of this software.
 *
 * Stanford disclaimer of copyright
 * --------------------------------
 * Stanford University, owner of the copyright, hereby disclaims its
 * copyright and all other rights in this software.  Hence, anyone may
 * freely use it for any purpose without restriction.
 *
 * Maintenance of notices
 * ----------------------
 * In the interest of clarity regarding the origin and status of this
 * SLAC software, this and all the preceding Stanford University notices
 * are to remain affixed to any copy or derivative of this software made
 * or distributed by the recipient and are to be affixed to any copy of
 * software made or distributed by the recipient that contains a copy or
 * derivative of this software.
 *
 * ------------------ SLAC Software Notices, Set 4 OTT.002a, 2004 FEB 03
 */
#include <stdint.h>

#include <bsp/VMEDMA.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef struct VMEDmaListNodeRec_    *VMEDmaListNode;

typedef struct VMEDmaListClassRec_   *VMEDmaListClass;

/* Create and setup a new descriptor.
 * The BSP must supply the appropriate controller class.
 */

VMEDmaListNode
BSP_VMEDmaListDescriptorNewTool(
		VMEDmaListClass pc,
		uint32_t	attr_mask,
		uint32_t	xfer_mode,
		uint32_t	pci_addr,
		uint32_t	vme_addr,
		uint32_t	n_bytes);

/* Setup an existing descriptor */
VMEDmaListNode
BSP_VMEDmaListDescriptorSetupTool(
		VMEDmaListNode n,
		uint32_t	attr_mask,
		uint32_t	xfer_mode,
		uint32_t	pci_addr,
		uint32_t	vme_addr,
		uint32_t	n_bytes);


/* Start a list DMA transfer on 'controller'. The 'controller' information
 * must be provided by the BSP.
 */
int
BSP_VMEDmaListDescriptorStartTool(volatile void *controller, int channel, VMEDmaListNode n);

#ifdef __cplusplus
}
#endif

#endif