Freescale Semiconductor Inc.
Main Page | Data Structures | File List | Data Fields | Globals

crank_instance_t Struct Reference

#include <etpu_crank.h>


Detailed Description

A structure to represent an instance of CRANK. It includes static CRANK initialization items.

Definition at line 34 of file etpu_crank.h.

Data Fields

const uint8_t chan_num
const uint8_t priority
const uint8_t polarity
const uint8_t teeth_till_gap
const uint8_t teeth_in_gap
const uint8_t teeth_per_cycle
const uint24_t tcr2_ticks_per_tooth
const uint24_t tcr2_ticks_per_add_tooth
const uint8_t log_tooth_periods
const uint32_t link_cam
const uint32_t link_1
const uint32_t link_2
const uint32_t link_3
const uint32_t link_4
uint32_t * cpba
uint32_t * cpba_tooth_period_log


Field Documentation

const uint8_t crank_instance_t::chan_num
 

Channel number of the CRANK channel.

Definition at line 36 of file etpu_crank.h.

Referenced by fs_etpu_crank_init(), and fs_etpu_crank_set_sync().

uint32_t* crank_instance_t::cpba
 

Channel parameter base address. Set cpba = 0 to use automatic allocation of eTPU DATA RAM for CRANK channel parameters using the eTPU utility function fs_etpu_malloc (recommanded), or assign the cpba manually by an address where the CRANK channel parameter space will start from, e.g. 0xC3FC8100.

Definition at line 73 of file etpu_crank.h.

Referenced by fs_etpu_crank_config(), fs_etpu_crank_get_states(), fs_etpu_crank_init(), and fs_etpu_crank_set_sync().

uint32_t* crank_instance_t::cpba_tooth_period_log
 

Base address of the CRANK tooth period log buffer in eTPU DATA RAM. Set cpba_tooth_period_log = 0 to use automatic allocation of eTPU DATA RAM for this buffer using the eTPU utility function fs_etpu_malloc (recommanded), or assign the p_tooth_period_log manually by an address where the CRANK buffer will start. The memory does not need to be allocated if FS_ETPU_CRANK_FM1_TOOTH_PERIODS_LOG_OFF is set.

Definition at line 78 of file etpu_crank.h.

Referenced by fs_etpu_crank_copy_tooth_period_log(), and fs_etpu_crank_init().

const uint32_t crank_instance_t::link_1
 

The first set of 4 link numbers to send when stall conditions accure.

Definition at line 65 of file etpu_crank.h.

Referenced by fs_etpu_crank_init().

const uint32_t crank_instance_t::link_2
 

The second set of 4 link numbers to send when stall conditions accure.

Definition at line 67 of file etpu_crank.h.

Referenced by fs_etpu_crank_init().

const uint32_t crank_instance_t::link_3
 

The third set of 4 link numbers to send when stall conditions accure.

Definition at line 69 of file etpu_crank.h.

Referenced by fs_etpu_crank_init().

const uint32_t crank_instance_t::link_4
 

The fourth set of 4 link numbers to send when stall conditions accure.

Definition at line 71 of file etpu_crank.h.

Referenced by fs_etpu_crank_init().

const uint32_t crank_instance_t::link_cam
 

Set of 4 link numbers to send to reset the Cam log. Up to 4 Cam channel numbers can be used. In case of a single Cam on channel 1, use 0x01010101.

Definition at line 62 of file etpu_crank.h.

Referenced by fs_etpu_crank_init().

const uint8_t crank_instance_t::log_tooth_periods
 

An option to record tooth_periods. It can be one of:

Definition at line 58 of file etpu_crank.h.

Referenced by fs_etpu_crank_init().

const uint8_t crank_instance_t::polarity
 

CRANK transition polarity. It defines which type of transitions are captured. It can be one of:

Definition at line 38 of file etpu_crank.h.

Referenced by fs_etpu_crank_init().

const uint8_t crank_instance_t::priority
 

Channel priority for the CRANK channel.

Definition at line 37 of file etpu_crank.h.

Referenced by fs_etpu_crank_init().

const uint24_t crank_instance_t::tcr2_ticks_per_add_tooth
 

A number of TCR2 angle ticks from the last tooth to the additional tooth. It can be any value between 1 and 1024. This parameter only applies for crank pattern with an additional tooth (teeth_in_gap=0).

Definition at line 54 of file etpu_crank.h.

Referenced by fs_etpu_crank_init().

const uint24_t crank_instance_t::tcr2_ticks_per_tooth
 

A number of TCR2 angle ticks per one tooth. It can be any value between 1 and 1024.

Definition at line 52 of file etpu_crank.h.

Referenced by fs_etpu_crank_init().

const uint8_t crank_instance_t::teeth_in_gap
 

A number of missing teeth in one gap. This can be assigned a value of 1, 2, 3 (for eTPU and eTPU2), up to 7 (for eTPU2+), or 0. The value 0 indicates there is an additional tooth instead of missing teeth.

Definition at line 45 of file etpu_crank.h.

Referenced by fs_etpu_crank_init().

const uint8_t crank_instance_t::teeth_per_cycle
 

A number of teeth (including missing teeth in gap) per an engine cycle (720 degrees). It must be a multiple of (teeth_till_gap + teeth_in_gap).

Definition at line 49 of file etpu_crank.h.

Referenced by fs_etpu_crank_copy_tooth_period_log(), and fs_etpu_crank_init().

const uint8_t crank_instance_t::teeth_till_gap
 

A number of physical teeth between 2 gaps. This is the number of physical teeth on the crank wheel divided by the number of (equally spaced) gaps on the wheel.

Definition at line 42 of file etpu_crank.h.

Referenced by fs_etpu_crank_init().


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