endat_api.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2021-23 Texas Instruments Incorporated
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *
 *    Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 *    Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the
 *    distribution.
 *
 *    Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef ENDAT_API_H_
#define ENDAT_API_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
int32_t endat_recvd_process(struct endat_priv *priv, int32_t cmd,
                        union endat_format_data *u);
 
uint32_t endat_recvd_validate(struct endat_priv *priv, int32_t cmd,
                              union endat_format_data *u);
 
int32_t endat_command_process(struct endat_priv *priv, int32_t cmd,
                          struct cmd_supplement *cmd_supplement);
 
int32_t endat_command_build(struct endat_priv *priv, int32_t cmd,
                        struct cmd_supplement *cmd_supplement);
 
void endat_command_send(struct endat_priv *priv);
 
void endat_command_wait(struct endat_priv *priv);
 
 
uint32_t endat_get_recovery_time(struct endat_priv *priv);
 
int32_t endat_get_encoder_info(struct endat_priv *priv);
 
uint32_t endat_get_prop_delay(struct endat_priv *priv);
 
void endat_addinfo_track(struct endat_priv *priv, int32_t cmd,
                         struct cmd_supplement *cmd_supplement);
 
void endat_config_clock(struct endat_priv *priv,
                        struct endat_clk_cfg *clk_cfg);
 
void endat_config_tst_delay(struct endat_priv *priv, uint16_t delay);
 
void endat_config_rx_arm_cnt(struct endat_priv *priv, uint16_t val);
 
void endat_config_wire_delay(struct endat_priv *priv, uint16_t val);
 
void endat_config_rx_clock_disable(struct endat_priv *priv,
                                   uint16_t val);
 
int32_t endat_start_continuous_mode(struct endat_priv *priv);
 
void endat_stop_continuous_mode(struct endat_priv *priv);
 
void endat_config_host_trigger(struct endat_priv *priv);
 
void endat_config_periodic_trigger(struct endat_priv *priv);
/*  brief     set syn_bits of all connected channels for synchronization before global_TX_init
 *
 *  \param[in]  priv    cookie returned by endat_init
 * \param[in]   mask    channels mask
 *
 */
void endat_config_syn_bits(struct endat_priv *priv, uint8_t mask);
void endat_config_primary_core_mask(struct endat_priv *priv, uint8_t mask);
void endat_enable_load_share_mode(struct endat_priv *priv);
void endat_config_channel(struct endat_priv *priv, int32_t ch);
void endat_config_multi_channel_mask(struct endat_priv *priv,
                                     uint8_t mask,
                                     uint8_t loadshare);
uint8_t endat_multi_channel_detected(struct endat_priv *priv);
 
void endat_multi_channel_set_cur(struct endat_priv *priv, int32_t ch);
int32_t endat_wait_initialization(struct endat_priv *priv, uint32_t timeout, uint8_t mask);
 
struct endat_priv *endat_init(struct endat_pruss_xchg *pruss_xchg, struct endatChRxInfo *endatRxInfo, uint64_t endatChInfoGlobalAddr,
                              void *pruss_cfg, void *pruss_iep, int32_t slice);
 
int32_t endat_get_2_2_angle(struct endat_priv *priv);
 
#ifdef __cplusplus
}
#endif
 
#endif