sdrv_flexray.h

Go to the documentation of this file.

 
#ifndef SDRV_FLEXRAY_H_
#define SDRV_FLEXRAY_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "sdrv_common.h"
#include "sdrv_flexray_driver.h"
#include "sdrv_flexray_general_types.h"
 
typedef enum {
    FR_UNINIT = 0U,  /* Flexray un-init */
    FR_INIT          /* Flexray init */
} Fr_SoftwareStatesType;
 
typedef Fr_ConfigType                   sdrv_flexray_config_type;
typedef Fr_CtrlCfgType                  sdrv_flexray_ctrl_cfg_type;
typedef Fr_ChannelType                  sdrv_flexray_channel_type;
typedef Fr_POCStatusType                sdrv_flexray_poc_status_type;
typedef Fr_ConfigurationType            sdrv_flexray_configuration_type;
typedef Fr_SoftwareStatesType           sdrv_flexray_software_states_type;
typedef Fr_SlotAssignmentType           sdrv_flexray_slot_assignment_type;
typedef Fr_CCTxBufferConfigType         sdrv_flexray_cc_tx_buffer_config_type;
typedef Fr_RxLPduStatusType             sdrv_flexray_rx_lpdu_status_type;
typedef Fr_TxLPduStatusType             sdrv_flexray_tx_lpdu_status_type;
typedef GlobalInterruptType             sdrv_flexray_global_interrupt_type;
typedef Fr_CCHardwareConfigType         sdrv_flexray_cc_hardware_config_type;
typedef Fr_CCLowLevelConfigSetType
sdrv_flexray_cc_low_level_config_set_type;
typedef Fr_CCRxBufferConfigType         sdrv_flexray_cc_rx_buffer_config_type;
typedef Fr_CCFifoConfigType             sdrv_flexray_cc_fifo_config_type;
typedef Fr_CCBufferConfigSetType        sdrv_flexray_cc_buffer_config_set_type;
typedef Fr_CCLpduInfoType               sdrv_flexray_cc_lpdu_info_type;
typedef Fr_CCBufferAddressType          sdrv_flexray_cc_buffer_address_type;
typedef Fr_CCBufferOffset16Type         sdrv_flexray_cc_buffer_offset16_type;
 
typedef struct sdrv_flexray {
    uint32_t irq;                                               
    uint32_t abs_timers_num;                                    
    sdrv_flexray_software_states_type     status;               
    const sdrv_flexray_configuration_type *internal_cfg;        
} sdrv_flexray_t;
 
enum sdrv_flexray_error {
    /* Error reported when parameter timer index exceeds number of available timers */
    SDRV_FLEXRAY_INV_TIMER_IDX      = SDRV_ERROR_STATUS(SDRV_STATUS_GROUP_FLEXRAY, 1),
    /* Error reported when invalid pointer in parameter list */
    SDRV_FLEXRAY_PARAM_POINTER      = SDRV_ERROR_STATUS(SDRV_STATUS_GROUP_FLEXRAY, 2),
    /* Error reported when parameter offset exceeds bounds */
    SDRV_FLEXRAY_INV_OFFSET         = SDRV_ERROR_STATUS(SDRV_STATUS_GROUP_FLEXRAY, 3),
    /* Error reported when invalid controller base */
    SDRV_FLEXRAY_INV_BASE_ADDR      = SDRV_ERROR_STATUS(SDRV_STATUS_GROUP_FLEXRAY, 4),
    /* Error reported when invalid channel index */
    SDRV_FLEXRAY_INV_CHNL_IDX       = SDRV_ERROR_STATUS(SDRV_STATUS_GROUP_FLEXRAY, 5),
    /* Error reported when parameter cycle exceeds 63 */
    SDRV_FLEXRAY_INV_CYCLE          = SDRV_ERROR_STATUS(SDRV_STATUS_GROUP_FLEXRAY, 6),
    /* Error reported when Fr module was not initialized */
    SDRV_FLEXRAY_INIT_FAILED        = SDRV_ERROR_STATUS(SDRV_STATUS_GROUP_FLEXRAY, 7),
    /* Error reported when Fr CC is not in the expected POC state */
    SDRV_FLEXRAY_INV_POCSTATE       = SDRV_ERROR_STATUS(SDRV_STATUS_GROUP_FLEXRAY, 8),
    /* Error reported when Payload length parameter has an invalid value */
    SDRV_FLEXRAY_INV_LENGTH         = SDRV_ERROR_STATUS(SDRV_STATUS_GROUP_FLEXRAY, 9),
    /* Error reported when invalid LPdu index */
    SDRV_FLEXRAY_INV_LPDU_IDX       = SDRV_ERROR_STATUS(SDRV_STATUS_GROUP_FLEXRAY, 10),
    /* Error reported when invalid FlexRay header CRC */
    SDRV_FLEXRAY_INV_HEADERCRC      = SDRV_ERROR_STATUS(SDRV_STATUS_GROUP_FLEXRAY, 11),
    /* Error reported when invalid value passed as parameter Fr_ConfigParamIdx. */
    SDRV_FLEXRAY_INV_CONFIG_IDX     = SDRV_ERROR_STATUS(SDRV_STATUS_GROUP_FLEXRAY, 12),
    /* Error reported when invalid framelist size value. */
    SDRV_FLEXRAY_INV_FRAMELIST_SIZE = SDRV_ERROR_STATUS(SDRV_STATUS_GROUP_FLEXRAY, 13),
    /* Error reported when requested resource is not configured to be available
      on the current core */
    SDRV_FLEXRAY_PARAM_CONFIG       = SDRV_ERROR_STATUS(SDRV_STATUS_GROUP_FLEXRAY, 14),
};
 
extern status_t sdrv_flexray_init(sdrv_flexray_t *handle);
 
extern status_t sdrv_flexray_controller_init(sdrv_flexray_t *handle);
 
extern status_t sdrv_flexray_start_communication(sdrv_flexray_t *handle);
 
extern status_t sdrv_flexray_allow_coldstart(sdrv_flexray_t *handle);
 
extern status_t sdrv_flexray_all_slots(sdrv_flexray_t *handle);
 
extern status_t sdrv_flexray_halt_communication(sdrv_flexray_t *handle);
 
extern status_t sdrv_flexray_abort_communication(sdrv_flexray_t *handle);
 
extern status_t sdrv_flexray_send_wakeup(sdrv_flexray_t *handle);
 
extern status_t sdrv_flexray_set_wakeup_channel(sdrv_flexray_t *handle,
        sdrv_flexray_channel_type channel_idx);
 
extern status_t sdrv_flexray_get_poc_status(sdrv_flexray_t *handle,
        sdrv_flexray_poc_status_type *poc_status_ptr);
 
extern status_t sdrv_flexray_set_absolute_timer(sdrv_flexray_t *handle,
        uint8_t abs_timer_idx,
        uint8_t cycle, uint16_t offset);
 
extern status_t sdrv_flexray_transmit_tx_lpdu(sdrv_flexray_t *handle,
        uint16_t lpdu_idx,
        const uint8_t *lsdu_ptr,
        uint8_t lsdu_length, sdrv_flexray_slot_assignment_type *slot_assignment_ptr);
 
extern status_t sdrv_flexray_cancel_tx_lpdu(sdrv_flexray_t *handle,
        uint16_t lpdu_idx);
 
extern status_t sdrv_flexray_receive_rx_lpdu(sdrv_flexray_t *handle,
        uint16_t lpdu_idx,
        uint8_t *lsdu_ptr,
        sdrv_flexray_rx_lpdu_status_type *lpdu_status_ptr, uint8_t *lsdu_length_ptr,
        sdrv_flexray_slot_assignment_type *slot_assignment_ptr);
 
extern status_t sdrv_flexray_check_tx_lpdu_status(sdrv_flexray_t *handle,
        uint16_t lpdu_idx,
        sdrv_flexray_tx_lpdu_status_type *tx_lpdu_status_ptr,
        sdrv_flexray_slot_assignment_type *slot_assignment_ptr);
 
extern status_t sdrv_flexray_get_global_time(sdrv_flexray_t *handle,
        uint8_t *cycle_ptr,
        uint16_t *macro_tick_ptr);
 
extern status_t sdrv_flexray_get_network_vector(sdrv_flexray_t *handle,
        uint8_t *network_vector);
 
extern status_t sdrv_flexray_get_number_startup_frames(sdrv_flexray_t *handle,
        uint8_t *number_startup_frame_ptr);
 
extern status_t sdrv_flexray_get_channel_status(sdrv_flexray_t *handle,
        uint16_t *channel_a_status_ptr, uint16_t *channel_b_status_ptr);
 
extern status_t sdrv_flexray_get_clock_correction(sdrv_flexray_t *handle,
        sint16 *rate_correction_ptr, sint32 *offset_correction_ptr);
 
extern status_t sdrv_flexray_get_sync_frame_list(sdrv_flexray_t *handle,
        uint8_t list_size,
        uint16_t *channel_a_even_list_ptr,
        uint16_t *channel_b_even_list_ptr, uint16_t *channel_a_odd_list_ptr,
        uint16_t *channel_b_odd_list_ptr);
 
extern status_t sdrv_flexray_get_wakeup_rx_status(sdrv_flexray_t *handle,
        uint8_t *wakeup_rx_status_ptr);
 
extern status_t sdrv_flexray_cancel_absolute_timer(sdrv_flexray_t *handle,
        uint8_t abs_timer_idx);
 
extern status_t sdrv_flexray_read_cc_config(sdrv_flexray_t *handle,
        uint8_t config_paramter_idx, uint32_t *config_para_value_ptr);
 
extern status_t sdrv_flexray_enable_absolute_timer_irq(sdrv_flexray_t *handle,
        uint8_t abs_timer_idx);
 
extern status_t sdrv_flexray_ack_absolute_timer_irq(sdrv_flexray_t *handle,
        uint8_t abs_timer_idx);
 
extern status_t sdrv_flexray_disable_absolute_timer_irq(sdrv_flexray_t *handle,
        uint8_t abs_timer_idx);
 
extern status_t sdrv_flexray_get_absolute_timer_irq_status(
    sdrv_flexray_t *handle,
    uint8_t abs_timer_idx,
    boolean *irq_status_ptr);
 
extern status_t sdrv_flexray_interrupt_enable(sdrv_flexray_t *handle,
        sdrv_flexray_global_interrupt_type interrupt_source);
 
extern status_t sdrv_flexray_interrupt_disable(sdrv_flexray_t *handle,
        sdrv_flexray_global_interrupt_type interrupt_source);
 
#ifdef __cplusplus
}
#endif
 
#endif /* SDRV_FLEXRAY_H_ */