cvt_V1495.h File Reference

V1495 VME board definitions. More...

#include "cvt_common_defs.h"
#include "cvt_board_commons.h"

Go to the source code of this file.

Data Structures

struct  cvt_V1495_data
 V1495 board data structure. More...

Defines

#define CVT_V1495_CONTROL_ADD   0x0002
 Control register relative address.
#define CVT_V1495_PORTA_EN_LOW_ADD   0x0010
 Port A enable low word relative address.
#define CVT_V1495_PORTA_EN_HIGH_ADD   0x0012
 Port A enable high word relative address.
#define CVT_V1495_PORTB_EN_LOW_ADD   0x0014
 Port B enable low word relative address.
#define CVT_V1495_PORTB_EN_HIGH_ADD   0x0016
 Port B enable high word relative address.
#define CVT_V1495_PORTD_EN_LOW_ADD   0x0018
 Port D enable low word relative address.
#define CVT_V1495_PORTD_EN_HIGH_ADD   0x001A
 Port D enable high word relative address.
#define CVT_V1495_CONTROL_DATA_SIZE   cvD16
 Control register data size.
#define CVT_V1495_PORTA_EN_LOW_DATA_SIZE   cvD16
 Port A enable low word data size.
#define CVT_V1495_PORTA_EN_HIGH_DATA_SIZE   cvD16
 Port A enable high word data size.
#define CVT_V1495_PORTB_EN_LOW_DATA_SIZE   cvD16
 Port B enable low word data size.
#define CVT_V1495_PORTB_EN_HIGH_DATA_SIZE   cvD16
 Port B enable high word data size.
#define CVT_V1495_PORTD_EN_LOW_DATA_SIZE   cvD16
 Port D enable low word data size.
#define CVT_V1495_PORTD_EN_HIGH_DATA_SIZE   cvD16
 Port D enable high word data size.
#define CVT_V1495_CONTROL_AM   cvA32_S_DATA
 Control register address modifier.
#define CVT_V1495_PORTA_EN_LOW_AM   cvA32_S_DATA
 Port A enable low word address modifier.
#define CVT_V1495_PORTA_EN_HIGH_AM   cvA32_S_DATA
 Port A enable high word address modifier.
#define CVT_V1495_PORTB_EN_LOW_AM   cvA32_S_DATA
 Port B enable low word address modifier.
#define CVT_V1495_PORTB_EN_HIGH_AM   cvA32_S_DATA
 Port B enable high word address modifier.
#define CVT_V1495_PORTD_EN_LOW_AM   cvA32_S_DATA
 Port D enable low word address modifier.
#define CVT_V1495_PORTD_EN_HIGH_AM   cvA32_S_DATA
 Port D enable high word address modifier.

Enumerations

enum  CVT_V1495_REG_INDEX {
  CVT_V1495_CONTROL_INDEX, CVT_V1495_PORTA_EN_LOW_INDEX, CVT_V1495_PORTA_EN_HIGH_INDEX, CVT_V1495_PORTB_EN_LOW_INDEX,
  CVT_V1495_PORTB_EN_HIGH_INDEX, CVT_V1495_PORTD_EN_LOW_INDEX, CVT_V1495_PORTD_EN_HIGH_INDEX
}
 The registers indexes. More...

Functions

BOOL cvt_V1495_open (cvt_V1495_data *p_data, UINT16 base_address, long vme_handle)
 V1494 VME boards data initialization.
BOOL cvt_V1495_close (cvt_V1495_data *p_data)
 V1495 VME boards closing and resource free.
BOOL cvt_V1495_set_control (cvt_V1495_data *p_data, UINT16 value)
 Set the control register.
BOOL cvt_V1495_set_port_A_enable (cvt_V1495_data *p_data, UINT32 value)
 Set the port A register.
BOOL cvt_V1495_set_port_B_enable (cvt_V1495_data *p_data, UINT32 value)
 Set the port B register.
BOOL cvt_V1495_set_port_D_enable (cvt_V1495_data *p_data, UINT32 value)
 Set the port D register.


Detailed Description

V1495 VME board definitions.

Author:
NDA
Version:
1.0
Date:
03/2006
Provides methods, properties and defines to handle with V1495 VME boards

Definition in file cvt_V1495.h.


Enumeration Type Documentation

enum CVT_V1495_REG_INDEX
 

The registers indexes.

Provides an entry for each register: This is the index into the CVT_V1495_REG_TABLE board table

Enumerator:
CVT_V1495_CONTROL_INDEX  Control register index.
CVT_V1495_PORTA_EN_LOW_INDEX  Port A enable low word index.
CVT_V1495_PORTA_EN_HIGH_INDEX  Port A enable high word index.
CVT_V1495_PORTB_EN_LOW_INDEX  Port B enable low word index.
CVT_V1495_PORTB_EN_HIGH_INDEX  Port B enable high word index.
CVT_V1495_PORTD_EN_LOW_INDEX  Port D enable low word index.
CVT_V1495_PORTD_EN_HIGH_INDEX  Port D enable high word index.

Definition at line 82 of file cvt_V1495.h.


Function Documentation

BOOL cvt_V1495_close cvt_V1495_data p_data  ) 
 

V1495 VME boards closing and resource free.

Provides specific handling for V1495 boards closing.

Parameters:
p_data Pointer to board data
Returns:
TRUE: board successfully closed
Note:
Must be called when done with any other board specific API.

Definition at line 76 of file cvt_V1495.c.

References cvt_board_close(), FALSE, cvt_V1495_data::m_common_data, and TRUE.

BOOL cvt_V1495_open cvt_V1495_data p_data,
UINT16  base_address,
long  vme_handle
 

V1494 VME boards data initialization.

Provides specific handling for V495 boards opening.

Parameters:
p_data Pointer to board data
base_address The board base address (MSW)
vme_handle The VME handle
Returns:
TRUE: board successfully opened
Note:
Must be called before any other board specific API.

Definition at line 62 of file cvt_V1495.c.

References cvt_board_open(), FALSE, cvt_V1495_data::m_common_data, and TRUE.

BOOL cvt_V1495_set_control cvt_V1495_data p_data,
UINT16  value
 

Set the control register.

Writes the specified value to the control register

Parameters:
p_data Pointer to board data
value The value to set
Returns:
TRUE: Procedure successfully executed
See also:
cvt_V1495_threshold_id

Definition at line 98 of file cvt_V1495.c.

References CVT_V1495_CONTROL_INDEX, cvt_write_reg(), FALSE, cvt_V1495_data::m_common_data, TRACE, and TRUE.

BOOL cvt_V1495_set_port_A_enable cvt_V1495_data p_data,
UINT32  value
 

Set the port A register.

Writes the specified value to the port A register

Parameters:
p_data Pointer to board data
value The value to set
Returns:
TRUE: Procedure successfully executed

Definition at line 113 of file cvt_V1495.c.

References CVT_V1495_PORTA_EN_HIGH_INDEX, CVT_V1495_PORTA_EN_LOW_INDEX, cvt_write_reg(), FALSE, cvt_V1495_data::m_common_data, TRACE, and TRUE.

BOOL cvt_V1495_set_port_B_enable cvt_V1495_data p_data,
UINT32  value
 

Set the port B register.

Writes the specified value to the port B register

Parameters:
p_data Pointer to board data
value The value to set
Returns:
TRUE: Procedure successfully executed

Definition at line 135 of file cvt_V1495.c.

References CVT_V1495_PORTB_EN_HIGH_INDEX, CVT_V1495_PORTB_EN_LOW_INDEX, cvt_write_reg(), FALSE, cvt_V1495_data::m_common_data, TRACE, and TRUE.

BOOL cvt_V1495_set_port_D_enable cvt_V1495_data p_data,
UINT32  value
 

Set the port D register.

Writes the specified value to the port D register

Parameters:
p_data Pointer to board data
value The value to set
Returns:
TRUE: Procedure successfully executed

Definition at line 156 of file cvt_V1495.c.

References CVT_V1495_PORTD_EN_HIGH_INDEX, CVT_V1495_PORTD_EN_LOW_INDEX, cvt_write_reg(), FALSE, cvt_V1495_data::m_common_data, TRACE, and TRUE.


Generated on Wed Oct 18 12:36:56 2006 for CAEVMEToolLib by  doxygen 1.4.6-NO