bissc_api.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2023 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 BISSC_API_H_
#define BISSC_API_H_
 
#ifdef __cplusplus
extern "C" {
#endif
#include "bissc_drv.h"
 
int32_t bissc_command_process(struct bissc_priv *priv);
 
void bissc_command_send(struct bissc_priv *priv);
 
int32_t bissc_command_wait(struct bissc_priv *priv);
 
int32_t bissc_get_pos(struct bissc_priv *priv);
 
void bissc_config_clock(struct bissc_priv *priv,
                        struct bissc_clk_cfg *clk_cfg);
 
void bissc_config_channel(struct bissc_priv *priv, int32_t mask, int32_t totalch);
void bissc_config_load_share(struct bissc_priv *priv, int32_t mask);
void bissc_enable_load_share_mode(struct bissc_priv *priv);
void bissc_config_primary_core_mask(struct bissc_priv *priv, uint8_t mask);
int32_t bissc_wait_for_fw_initialization(struct bissc_priv *priv, uint32_t timeout, uint8_t mask);
 
void bissc_hw_init(struct bissc_priv *priv);
 
struct bissc_priv *bissc_init(PRUICSS_Handle gPruIcssXHandle, 
                              int32_t slice, 
                              uint32_t frequency,
                              uint32_t core_clk_freq,
                              uint32_t uart_clk_freq);
 
void bissc_update_max_proc_delay(struct bissc_priv *priv); 
int32_t bissc_wait_measure_proc_delay(struct bissc_priv *priv, uint32_t timeout);
 
void bissc_set_default_initialization(struct bissc_priv *priv, uint64_t icssgclk);
void bissc_update_data_len(struct bissc_priv *priv, uint32_t single_turn_len[], uint32_t multi_turn_len[], int32_t num_pru);
 
int32_t bissc_set_ctrl_cmd_and_process(struct bissc_priv *priv, uint32_t ctrl_cmd[]);
void bissc_config_endat_mode(struct bissc_priv *priv);
void bissc_config_clr_cfg0(struct bissc_priv *priv);
void bissc_get_enc_proc_delay(struct bissc_priv *priv);
int32_t bissc_calc_clock(struct bissc_priv *priv, struct bissc_clk_cfg *clk_cfg);
#ifdef __cplusplus
}
#endif
 
#endif