v29_tx_state_s Struct Reference

#include <v29tx.h>

Public Attributes
int	bit_rate
	The bit rate of the modem. Valid values are 4800, 7200 and 9600.
span_get_bit_func_t	get_bit
	The callback function used to get the next bit to be transmitted.
void *	get_bit_user_data
	A user specified opaque pointer passed to the get_bit function.
span_modem_status_func_t	status_handler
	The callback function used to report modem status changes.
void *	status_user_data
	A user specified opaque pointer passed to the status function.
float	base_gain
	Gain required to achieve the specified output power, not allowing for the size of the current constellation.
float	gain
	Gain required to achieve the specified output power, allowing for the size of the current constellation.
float	rrc_filter_re [9]
	The root raised cosine (RRC) pulse shaping filter buffer.
float	rrc_filter_im [9]
int	rrc_filter_step
	Current offset into the RRC pulse shaping filter buffer.
uint32_t	scramble_reg
	The register for the data scrambler.
uint8_t	training_scramble_reg
	The register for the training scrambler.
bool	in_training
	True if transmitting the training sequence, or shutting down transmission. False if transmitting user data.
int	training_step
	A counter used to track progress through sending the training sequence.
int	training_offset
	An offset value into the table of training parameters, used to match the training pattern to the bit rate.
uint32_t	carrier_phase
	The current phase of the carrier (i.e. the DDS parameter).
int32_t	carrier_phase_rate
	The update rate for the phase of the carrier (i.e. the DDS increment).
int	baud_phase
	The current fractional phase of the baud timing.
int	constellation_state
	The code number for the current position in the constellation.
span_get_bit_func_t	current_get_bit
	The get_bit function in use at any instant.
logging_state_t	logging
	Error and flow logging control.

Detailed Description

V.29 modem transmit side descriptor. This defines the working state for a single instance of a V.29 modem transmitter.

Member Data Documentation

base_gain

float v29_tx_state_s::base_gain

Gain required to achieve the specified output power, not allowing for the size of the current constellation.

Referenced by v29_tx_power().

baud_phase

int v29_tx_state_s::baud_phase

The current fractional phase of the baud timing.

Referenced by v29_tx(), and v29_tx_restart().

bit_rate

int v29_tx_state_s::bit_rate

The bit rate of the modem. Valid values are 4800, 7200 and 9600.

Referenced by v29_tx_restart().

carrier_phase

uint32_t v29_tx_state_s::carrier_phase

The current phase of the carrier (i.e. the DDS parameter).

Referenced by v29_tx(), and v29_tx_restart().

carrier_phase_rate

int32_t v29_tx_state_s::carrier_phase_rate

The update rate for the phase of the carrier (i.e. the DDS increment).

Referenced by v29_tx(), and v29_tx_init().

constellation_state

int v29_tx_state_s::constellation_state

The code number for the current position in the constellation.

Referenced by v29_tx_restart().

current_get_bit

span_get_bit_func_t v29_tx_state_s::current_get_bit

The get_bit function in use at any instant.

Referenced by v29_tx_restart(), and v29_tx_set_get_bit().

gain

float v29_tx_state_s::gain

Gain required to achieve the specified output power, allowing for the size of the current constellation.

Referenced by v29_tx().

get_bit

span_get_bit_func_t v29_tx_state_s::get_bit

The callback function used to get the next bit to be transmitted.

Referenced by v29_tx_init(), and v29_tx_set_get_bit().

get_bit_user_data

void* v29_tx_state_s::get_bit_user_data

A user specified opaque pointer passed to the get_bit function.

Referenced by v29_tx_init(), and v29_tx_set_get_bit().

in_training

bool v29_tx_state_s::in_training

True if transmitting the training sequence, or shutting down transmission. False if transmitting user data.

Referenced by v29_tx_restart().

logging

logging_state_t v29_tx_state_s::logging

Error and flow logging control.

Referenced by v29_tx_get_logging_state(), v29_tx_init(), and v29_tx_restart().

rrc_filter_re

float v29_tx_state_s::rrc_filter_re[9]

The root raised cosine (RRC) pulse shaping filter buffer.

Referenced by v29_tx(), and v29_tx_restart().

rrc_filter_step

int v29_tx_state_s::rrc_filter_step

Current offset into the RRC pulse shaping filter buffer.

Referenced by v29_tx(), and v29_tx_restart().

scramble_reg

uint32_t v29_tx_state_s::scramble_reg

The register for the data scrambler.

Referenced by v29_tx_restart().

status_handler

span_modem_status_func_t v29_tx_state_s::status_handler

The callback function used to report modem status changes.

Referenced by v29_tx_set_modem_status_handler().

status_user_data

void* v29_tx_state_s::status_user_data

A user specified opaque pointer passed to the status function.

Referenced by v29_tx_set_modem_status_handler().

training_offset

int v29_tx_state_s::training_offset

An offset value into the table of training parameters, used to match the training pattern to the bit rate.

Referenced by v29_tx_restart().

training_scramble_reg

uint8_t v29_tx_state_s::training_scramble_reg

The register for the training scrambler.

Referenced by v29_tx_restart().

training_step

int v29_tx_state_s::training_step

A counter used to track progress through sending the training sequence.

Referenced by v29_tx(), and v29_tx_restart().

---

The documentation for this struct was generated from the following file:

• private/v29tx.h