vmod/vmodttl: fixed bug related to luns not ordered and/or not starting from zero.
[ht-drivers.git] / vmod / doc / libvmodttl2dioaio_doc.txt
blobb752f5cb0677532141b025627075ce67337d7af2
1 *****************************************************************************
2                         libvmodttl2diaio 
3                           User Manual
4 *****************************************************************************
6  INTRODUCTION
7  ------------
9  This library is an adapter to translate the calls from the new library 
10 to the old library in PPC environment. 
13  API
14  ---
16  The API is, of course, the same of the new one for GNU/Linux. It is
17 described and there are some tips about how to use it, in the following 
18 lines:
20  --> int vmodttl_open(int lun)
21      Originally, this function open the corresponding file and translates 
22      from logical unit number to file descriptor. 
23      It's unnecessary with dioaiolib, so only checks that the lun is 
24      between the right values.
26  --> int vmodttl_close(int lun)
27      Originally, this function closes the file corresponding of the given lun.
28      With dioaiolib, it's unnecessary and it returns 0 always.
30  --> int vmodttl_ioconfig(int lun, struct vmodttl_config conf)
31      It configures the direction of each channel and the desired mode (inverted or
32      normal TTL-level). 
33      The delay value is not working here (it is a 1 us pulse).
34      *Remember* to call this function before to do any read/write operation.
36  --> int vmodttl_write(int lun, enum vmodttl_channel chan, int val)
37      It writes to the desired channel (A, B or A and B togethera) the value of 'val'.
38      It generates a data strobe in port C in each write operation.
40  --> int vmodttl_read(int lun, enum vmodttl_channel chan, int *val)
41      It reads the desired channel and write its value to 'val'. It also generates a
42      data strobe in the port C in each read operation.
44  REFERENCES
45  ----------
47  More information is available in the libvmodttl documentation. Realize that the 
48 differences between it and this library are detailed here.
50 http://cs-ccr-www3/private/coht/doxy/vmodttl/