/alps/pcitool

To get this branch, use:
bzr branch http://suren.me/webbzr/alps/pcitool

« back to all changes in this revision

Viewing changes to pcilib/bank.h

  • Committer: Suren A. Chilingaryan
  • Date: 2015-10-22 13:57:59 UTC
  • Revision ID: csa@suren.me-20151022135759-nqs5wowy38tvbw09
Documentation update

Show diffs side-by-side

added added

removed removed

Lines of Context:
pcilib/bank.h
8
8
#define PCILIB_REGISTER_BANK1                   1
9
9
#define PCILIB_REGISTER_BANK2                   2
10
10
#define PCILIB_REGISTER_BANK3                   3
11
 
#define PCILIB_REGISTER_BANK_PROPERTY           64                                      /**< Registers abstracting properties and other computed registers */
12
 
#define PCILIB_REGISTER_BANK_DMA                96                                      /**< First BANK address to be used by DMA engines */
 
11
#define PCILIB_REGISTER_BANK_CONF               64                                      /**< Configuration registers */
 
12
#define PCILIB_REGISTER_BANK_PROPERTY           65                                      /**< Registers abstracting properties and other computed registers */
13
13
#define PCILIB_REGISTER_BANK_DMACONF            96                                      /**< DMA configuration in the software registers */
 
14
#define PCILIB_REGISTER_BANK_DMA                97                                      /**< First BANK address to be used by DMA engines */
14
15
#define PCILIB_REGISTER_BANK_DYNAMIC            128                                     /**< First BANK address to map dynamic XML configuration */
15
16
#define PCILIB_REGISTER_PROTOCOL_INVALID        ((pcilib_register_protocol_t)-1)
16
17
#define PCILIB_REGISTER_PROTOCOL0               0                                       /**< First PROTOCOL address to be used in the event engine */
60
61
    uintptr_t write_addr;                                                       /**< protocol specific (normally offset in the BAR of the first address used to write registers) */
61
62
 
62
63
    uint8_t access;                                                             /**< Default register size in bits (or word-size in plain addressing mode) */
63
 
    size_t size;                                                                /**< Number of register addresses (plain addressing) in the bank (more register names can be defined if bit-fields/views are used) */
 
64
    size_t size;                                                                /**< The size of the bank in bytes (i.e. number of registers in plain addressing mode multiplied by access; this does not limit number of register names since indefinite number of names can be provided if bit-fields/views are used) */
64
65
    pcilib_endianess_t raw_endianess;                                           /**< Specifies endianess in the plain-addressing mode, PCILIB_HOST_ENDIAN have to be specified if no conversion desired. 
65
66
                                                                                Conversion applied after protocol. This value does not get into the account in register-access mode */
66
67
    pcilib_endianess_t endianess;                                               /**< Specifies endianess in the register-access mode, this may differ from raw_endianess if multi-word registers are used. 
163
164
pcilib_register_protocol_t pcilib_find_register_protocol_by_name(pcilib_t *ctx, const char *name);
164
165
pcilib_register_protocol_t pcilib_find_register_protocol(pcilib_t *ctx, const char *name);
165
166
 
166
 
 
167
167
int pcilib_get_register_bank_attr_by_id(pcilib_t *ctx, pcilib_register_bank_t bank, const char *attr, pcilib_value_t *val);
 
168
int pcilib_get_register_bank_attr(pcilib_t *ctx, const char *bankname, const char *attr, pcilib_value_t *val);
168
169
 
169
170
#ifdef __cplusplus
170
171
}