linux/drivers/mxc/dam/dam.h File Reference

This is the brief documentation for this dam.h file. More...

Defines

#define TEST_DAM   1

Enumerations

enum  dam_mode {
  normal_mode = 0,
  internal_network_mode = 1,
  CE_bus_network_mode = 2
}
enum  dam_port {
  port_1 = 0,
  port_2 = 1,
  port_3 = 2,
  port_4 = 3,
  port_5 = 4,
  port_6 = 5,
  port_7 = 6
}
enum  signal_direction {
  signal_in = 0,
  signal_out = 1
}

Functions

int dam_select_mode (dam_port port, dam_mode the_mode)
void dam_select_RxClk_direction (dam_port port, signal_direction direction)
void dam_select_RxClk_source (dam_port p_config, bool from_RxClk, dam_port p_source)
void dam_select_RxD_source (dam_port p_config, dam_port p_source)
void dam_select_RxFS_direction (dam_port port, signal_direction direction)
void dam_select_RxFS_source (dam_port p_config, bool from_RxFS, dam_port p_source)
void dam_select_TxClk_direction (dam_port port, signal_direction direction)
void dam_select_TxClk_source (dam_port p_config, bool from_RxClk, dam_port p_source)
void dam_select_TxFS_direction (dam_port port, signal_direction direction)
void dam_select_TxFS_source (dam_port p_config, bool from_RxFS, dam_port p_source)
int dam_set_internal_network_mode_mask (dam_port port, unsigned char bit_mask)
void dam_set_synchronous (dam_port port, bool synchronous)
void dam_switch_Tx_Rx (dam_port port, bool value)
void dam_reset_register (dam_port port)

Detailed Description

This is the brief documentation for this dam.h file.

This header file contains DAM driver functions prototypes.


Define Documentation

#define TEST_DAM   1

Test purpose definition


Enumeration Type Documentation

enum dam_mode

This enumeration describes the Digital Audio Multiplexer mode.

Enumerator:
normal_mode 

Normal mode

internal_network_mode 

Internal network mode

CE_bus_network_mode 

CE bus network mode

enum dam_port

This enumeration describes the port.

Enumerator:
port_1 

The port 1

port_2 

The port 2

port_3 

The port 3

port_4 

The port 4

port_5 

The port 5

port_6 

The port 6

port_7 

The port 7

This enumeration describes the signal direction.

Enumerator:
signal_in 

Signal In

signal_out 

Signal Out


Function Documentation

void dam_reset_register ( dam_port  port  ) 

This function resets the two registers of the selected port.

Parameters:
port the DAM port to reset

References ModifyRegister32.

int dam_select_mode ( dam_port  port,
dam_mode  the_mode 
)

This function selects the operation mode of the port.

Parameters:
port the DAM port to configure
the_mode the operation mode of the port
Returns:
This function returns the result of the operation (0 if successful, -1 otherwise).

DAM major

This function selects the operation mode of the port.

Parameters:
port the DAM port to configure
the_mode the operation mode of the port
Returns:
This function returns the result of the operation (0 if successful, -1 otherwise).

References dam_mode_masq, ModifyRegister32, and normal_mode.

void dam_select_RxClk_direction ( dam_port  port,
signal_direction  direction 
)

This function controls Receive clock signal direction for the port.

Parameters:
port the DAM port to configure
direction the Rx clock signal direction

References ModifyRegister32.

void dam_select_RxClk_source ( dam_port  p_config,
bool  from_RxClk,
dam_port  p_source 
)

This function controls Receive clock signal source for the port.

Parameters:
p_config the DAM port to configure
from_RxClk the signal comes from RxClk or TxClk of the source port
p_source the source port

References ModifyRegister32.

void dam_select_RxD_source ( dam_port  p_config,
dam_port  p_source 
)

This function selects the source port for the RxD data.

Parameters:
p_config the DAM port to configure
p_source the source port

References ModifyRegister32.

void dam_select_RxFS_direction ( dam_port  port,
signal_direction  direction 
)

This function controls Receive Frame Sync signal direction for the port.

Parameters:
port the DAM port to configure
direction the Rx Frame Sync signal direction

References ModifyRegister32.

void dam_select_RxFS_source ( dam_port  p_config,
bool  from_RxFS,
dam_port  p_source 
)

This function controls Receive Frame Sync signal source for the port.

Parameters:
p_config the DAM port to configure
from_RxFS the signal comes from RxFS or TxFS of the source port
p_source the source port

References ModifyRegister32.

void dam_select_TxClk_direction ( dam_port  port,
signal_direction  direction 
)

This function controls Transmit clock signal direction for the port.

Parameters:
port the DAM port to configure
direction the Tx clock signal direction

References ModifyRegister32.

void dam_select_TxClk_source ( dam_port  p_config,
bool  from_RxClk,
dam_port  p_source 
)

This function controls Transmit clock signal source for the port.

Parameters:
p_config the DAM port to configure
from_RxClk the signal comes from RxClk or TxClk of the source port
p_source the source port

References ModifyRegister32.

void dam_select_TxFS_direction ( dam_port  port,
signal_direction  direction 
)

This function controls Transmit Frame Sync signal direction for the port.

Parameters:
port the DAM port to configure
direction the Tx Frame Sync signal direction

References ModifyRegister32.

void dam_select_TxFS_source ( dam_port  p_config,
bool  from_RxFS,
dam_port  p_source 
)

This function controls Transmit Frame Sync signal source for the port.

Parameters:
p_config the DAM port to configure
from_RxFS the signal comes from RxFS or TxFS of the source port
p_source the source port

References ModifyRegister32.

int dam_set_internal_network_mode_mask ( dam_port  port,
unsigned char  bit_mask 
)

This function sets a bit mask that selects the port from which of the RxD signals are to be ANDed together for internal network mode. Bit 6 represents RxD from Port7 and bit0 represents RxD from Port1. 1 excludes RxDn from ANDing. 0 includes RxDn for ANDing.

Parameters:
port the DAM port to configure
bit_mask the bit mask
Returns:
This function returns the result of the operation (0 if successful, -1 otherwise).

References dam_internal_network_mode_shift, and ModifyRegister32.

void dam_set_synchronous ( dam_port  port,
bool  synchronous 
)

This function controls whether or not the port is in synchronous mode. When the synchronous mode is selected, the receive and the transmit sections use common clock and frame sync signals. When the synchronous mode is not selected, separate clock and frame sync signals are used for the transmit and the receive sections. The defaut value is the synchronous mode selected.

Parameters:
port the DAM port to configure
synchronous the state to assign

References dam_synchronous_mode_shift, and ModifyRegister32.

void dam_switch_Tx_Rx ( dam_port  port,
bool  value 
)

This function swaps the transmit and receive signals from (Da-TxD, Db-RxD) to (Da-RxD, Db-TxD). This default signal configuration is Da-TxD, Db-RxD.

Parameters:
port the DAM port to configure
value the switch state

References ModifyRegister32.

footer
©  Freescale Semiconductor, Inc., 2007.  All rights reserved.
Freescale Confidential Proprietary
NDA Required
doxygen