nikon_api.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2024-25 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 NIKON_API_H_
#define NIKON_API_H_
 
#ifdef __cplusplus
extern "C" {
#endif
#include "nikon_drv.h"
 
int32_t nikon_command_wait(struct nikon_priv *priv);
 
int32_t nikon_get_pos(struct nikon_priv *priv, uint32_t cmd);
 
void nikon_config_clock(struct nikon_priv *priv,
                        struct nikon_clk_cfg *clk_cfg);
 
struct nikon_priv *nikon_init(PRUICSS_Handle gPruIcssXHandle,
                              uint32_t slice,
                              float_t frequency,
                              uint32_t core_clk_freq,
                              uint32_t uart_clk_freq,
                              uint32_t tx_rx_clock_source,
                              uint32_t mask,
                              uint32_t totalch,
                              uint32_t protocol_version);
 
void nikon_config_clr_cfg0(struct nikon_priv *priv);
 
int32_t nikon_calc_clock(struct nikon_priv *priv, struct nikon_clk_cfg *clk_cfg);
 
void nikon_generate_cdf(struct nikon_priv *priv, uint32_t cmd);
 
uint64_t nikon_reverse_bits(uint64_t bits, uint32_t num_bits);
 
uint32_t nikon_calc_3bitcrc(struct nikon_priv *priv, uint32_t cmd);
 
void nikon_config_load_share(struct nikon_priv *priv, uint8_t mask);
 
void nikon_config_periodic_trigger(struct nikon_priv *priv);
 
void nikon_config_host_trigger(struct nikon_priv *priv);
 
int32_t nikon_wait_for_encoder_detection(struct nikon_priv *priv);
 
void nikon_update_enc_len(struct nikon_priv *priv,
                          uint32_t num_encoders,
                          uint32_t single_turn_len[],
                          uint32_t multi_turn_len[],
                          uint32_t ch);
 
void nikon_update_clock_freq(struct nikon_priv *priv, float_t frequency);
 
uint32_t nikon_get_current_channel(struct nikon_priv *priv, uint32_t ch_idx);
 
uint32_t nikon_get_totalchannels(struct nikon_priv *priv);
 
void nikon_update_enc_addr(struct nikon_priv *priv, uint32_t enc_addr, uint32_t ls_ch);
 
void nikon_update_eeprom_addr(struct nikon_priv *priv, uint8_t addr, uint32_t ls_ch);
 
void nikon_update_eeprom_data(struct nikon_priv *priv, uint16_t data, uint32_t ls_ch);
 
void nikon_update_id_code(struct nikon_priv *priv, uint32_t data, uint32_t ls_ch);
 
void nikon_update_velocity_coefficient(struct nikon_priv *priv, uint32_t data, uint32_t ls_ch);
 
void nikon_update_eeprom_bank(struct nikon_priv *priv, uint8_t bank, uint32_t ls_ch);
 
#ifdef __cplusplus
}
#endif
 
#endif