flsopskd.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2025 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 __FLSOPSKD__H__
#define __FLSOPSKD__H__
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#include <stdio.h>
#include <stdbool.h>
#include <kernel/dpl/HwiP.h>
#include <drivers/hw_include/cslr_flsopskd.h>
 
#define FLSOPSKD_EXPECTED_FW_VERSION (0x10000U)
 
typedef struct FLSOPSKD_Params_s
{
    uint8_t eraseOpCode; 
    uint8_t eraseExOpCode;
    uint16_t pageSizeInBytes; 
    uint32_t eraseSizeInBytes; 
    uint32_t pollTimeout; 
} FLSOPSKD_Params;
 
typedef struct FLSOPSKD_Handle_s
{
    uint32_t lastOperationXipDowntime; 
    uint32_t lastOperationPollCount; 
    FLSOPSKD_Params params; 
}FLSOPSKD_Handle;
 
uint32_t FLSOPSKD_usrGetTicks();
 
int32_t FLSOPSKD_Params_init(FLSOPSKD_Params *pParams);
 
int32_t FLSOPSKD_init(FLSOPSKD_Handle *pHandle, FLSOPSKD_Params *pParams);
 
int32_t FLSOPSKD_write(FLSOPSKD_Handle *pHandle, uint32_t destAddr, uint8_t * pSrcBuffer, uint32_t bytesToWrite);
 
int32_t FLSOPSKD_erase(FLSOPSKD_Handle *pHandle, uint32_t eraseOffsetInBytes);
 
 
int32_t FLSOPSKD_getFwVersion(FLSOPSKD_Handle *pHandle, volatile uint32_t *pVersion);
 
int32_t FLSOPSKD_busyPoll(FLSOPSKD_Handle *pHandle);
 
int32_t FLSOPSKD_perfGetDowntime(FLSOPSKD_Handle *pHandle, uint32_t *memLoc);
 
int32_t FLSOPSKD_perfGetPollCounts(FLSOPSKD_Handle *pHandle, uint32_t *memLoc);
 
int32_t FLSOPSKD_deinit(FLSOPSKD_Handle *pHandle);
 
#endif
 
#ifdef __cplusplus
}
#endif