blob: 6b4ab599f62c27b9c7a5cb0d07dd5a03d7b7b27d (
plain)
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
|
\# Author Andy Pugh
\# Issued under the terms of the GPL v2 License or any later version
.TH hm2_tram_add_bspi_frame "3hm2" "2011-05-31" "LinuxCNC Documentation" "Hostmot2"
.SH NAME
hm2_tram_add_bspi_frame \- add a register-write to the Hostmot2 TRAM
.SH SYNTAX
.HP
hm2_tram_add_bspi_frame(char *name, int chan, u32 **wbuff, u32 **rbuff)
.SH DESCRIPTION
\fBhm2_tram_add_bspi_frame\fR Add a regular (every thread) write event to the
Hostmot2 tram for bspi instance "name". "name" is a unique string given to each
bspi channel during hostmot2 setup. The names of the available
channels are printed to standard output during the driver loading process and
take the form:
hm2_<board name>.<board index>.bspi.<index> For example hm2_5i23.0.bspi.0
This function is used to add a regular, every thread, write or write-read
transaction to the Translation RAM system. A write need not have a read (use 0
for **rbuff) but it is an error to have a read without a write. Note that the
TRAM list is not actioned until the hm2_allocate_bspi_tram function is called.
The read and write parameters must be pointers to pointers, as TRAM re-maps the
buffers into contiguous memory.
.SH RETURN VALUE
Returns 0 on success and -1 on failure.
.SH SEE ALSO
man hm2_bspi_setup_chan, man hm2_bspi_write_chan, man hm2_tram_add_bspi_frame
man hm2_allocate_bspi_tram.
See src/hal/drivers mesa_7i65.comp for an example usage.
|
