410 lines
12 KiB
C

/*******************************************************************************
File Name:
nmdrv.c
Summary:
This module contains WINC3400 M2M driver APIs implementation.
Description:
This module contains WINC3400 M2M driver APIs implementation.
*******************************************************************************/
//DOM-IGNORE-BEGIN
/*******************************************************************************
* Copyright (C) 2021 Microchip Technology Inc. and its subsidiaries.
*
* Subject to your compliance with these terms, you may use Microchip software
* and any derivatives exclusively with Microchip products. It is your
* responsibility to comply with third party license terms applicable to your
* use of third party software (including open source software) that may
* accompany Microchip software.
*
* THIS SOFTWARE IS SUPPLIED BY MICROCHIP "AS IS". NO WARRANTIES, WHETHER
* EXPRESS, IMPLIED OR STATUTORY, APPLY TO THIS SOFTWARE, INCLUDING ANY IMPLIED
* WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY, AND FITNESS FOR A
* PARTICULAR PURPOSE.
*
* IN NO EVENT WILL MICROCHIP BE LIABLE FOR ANY INDIRECT, SPECIAL, PUNITIVE,
* INCIDENTAL OR CONSEQUENTIAL LOSS, DAMAGE, COST OR EXPENSE OF ANY KIND
* WHATSOEVER RELATED TO THE SOFTWARE, HOWEVER CAUSED, EVEN IF MICROCHIP HAS
* BEEN ADVISED OF THE POSSIBILITY OR THE DAMAGES ARE FORESEEABLE. TO THE
* FULLEST EXTENT ALLOWED BY LAW, MICROCHIP'S TOTAL LIABILITY ON ALL CLAIMS IN
* ANY WAY RELATED TO THIS SOFTWARE WILL NOT EXCEED THE AMOUNT OF FEES, IF ANY,
* THAT YOU HAVE PAID DIRECTLY TO MICROCHIP FOR THIS SOFTWARE.
*******************************************************************************/
#include "nm_common.h"
#include "nmbus.h"
#include "nm_bsp.h"
#include "nmdrv.h"
#include "nmasic.h"
#include "m2m_types.h"
#include "nmspi.h"
static tenuNmState genuNmState = NM_STATE_DEINIT;
/**
* @fn nm_get_hif_info(uint16_t *pu16FwHifInfo, uint16_t *pu16OtaHifInfo);
* @brief Get Hif info of images in both partitions (Firmware and Ota).
* @param[out] pu16FwHifInfo
* Pointer holding Hif info of image in the active partition.
* @param[out] pu16OtaHifInfo
* Pointer holding Hif info of image in the inactive partition.
* @return @ref M2M_SUCCESS in case of success and Negative error code in case of failure
*/
int8_t nm_get_hif_info(uint16_t *pu16FwHifInfo, uint16_t *pu16OtaHifInfo)
{
int8_t ret = M2M_SUCCESS;
uint32_t reg = 0;
ret = nm_read_reg_with_ret(NMI_REV_REG, &reg);
if(ret == M2M_SUCCESS)
{
if(pu16FwHifInfo != NULL)
{
*pu16FwHifInfo = (uint16_t)reg;
}
if(pu16OtaHifInfo)
{
*pu16OtaHifInfo = (uint16_t)(reg>>16);
}
}
return ret;
}
/**
* @fn nm_get_firmware_full_info(tstrM2mRev* M2mRev)
* @brief Get Firmware version info
* @param[out] M2mRev
* Pointer holds address of structure @ref tstrM2mRev that contains the firmware version parameters
*/
int8_t nm_get_firmware_full_info(tstrM2mRev *pstrRev)
{
uint16_t fw_hif_info = 0;
uint32_t reg = 0;
int8_t ret = M2M_SUCCESS;
tstrGpRegs strgp = {0};
memset((uint8_t*)pstrRev, 0, sizeof(tstrM2mRev));
nm_get_hif_info(&fw_hif_info, NULL);
M2M_INFO("Fw HIF: %04x\r\n", fw_hif_info);
if(M2M_GET_HIF_BLOCK(fw_hif_info) == M2M_HIF_BLOCK_VALUE)
{
ret = nm_read_reg_with_ret(rNMI_GP_REG_0, &reg);
if(ret == M2M_SUCCESS)
{
if(reg != 0)
{
ret = nm_read_block(reg|0x30000, (uint8_t*)&strgp, sizeof(tstrGpRegs));
if(ret == M2M_SUCCESS)
{
reg = strgp.u32Firmware_Ota_rev;
reg &= 0x0000ffff;
if(reg != 0)
{
ret = nm_read_block(reg|0x30000, (uint8_t*)pstrRev, sizeof(tstrM2mRev));
if(ret == M2M_SUCCESS)
{
M2M_INFO("Firmware HIF (%u) : %u.%u\r\n", M2M_GET_HIF_BLOCK(pstrRev->u16FirmwareHifInfo), M2M_GET_HIF_MAJOR(pstrRev->u16FirmwareHifInfo), M2M_GET_HIF_MINOR(pstrRev->u16FirmwareHifInfo));
M2M_INFO("Firmware ver : %u.%u.%u\r\n", pstrRev->u8FirmwareMajor, pstrRev->u8FirmwareMinor, pstrRev->u8FirmwarePatch);
M2M_INFO("Firmware Build %s Time %s\r\n", pstrRev->BuildDate, pstrRev->BuildTime);
/* Check Hif info is consistent */
if(fw_hif_info != pstrRev->u16FirmwareHifInfo)
{
ret = M2M_ERR_FAIL;
M2M_ERR("Inconsistent Firmware Version\r\n");
}
}
}
else
{
ret = M2M_ERR_FAIL;
}
}
}
else
{
ret = M2M_ERR_FAIL;
}
}
}
else
{
ret = M2M_ERR_FAIL;
}
if(ret != M2M_SUCCESS)
{
M2M_ERR("Unknown Firmware Version\r\n");
}
return ret;
}
/**
* @fn nm_get_ota_firmware_info(tstrM2mRev* pstrRev)
* @brief Get Firmware version info
* @param[out] M2mRev
* Pointer holds address of structure @ref tstrM2mRev that contains the firmware version parameters
*/
int8_t nm_get_ota_firmware_info(tstrM2mRev *pstrRev)
{
uint16_t ota_hif_info = 0;
uint32_t reg = 0;
int8_t ret = M2M_SUCCESS;
tstrGpRegs strgp = {0};
memset((uint8_t*)pstrRev, 0, sizeof(tstrM2mRev));
nm_get_hif_info(NULL, &ota_hif_info);
M2M_INFO("OTA HIF: %04x\r\n", ota_hif_info);
if(M2M_GET_HIF_BLOCK(ota_hif_info) == M2M_HIF_BLOCK_VALUE)
{
ret = nm_read_reg_with_ret(rNMI_GP_REG_0, &reg);
if(ret == M2M_SUCCESS)
{
if(reg != 0)
{
ret = nm_read_block(reg|0x30000, (uint8_t*)&strgp, sizeof(tstrGpRegs));
if(ret == M2M_SUCCESS)
{
reg = strgp.u32Firmware_Ota_rev;
reg >>= 16;
if(reg != 0)
{
ret = nm_read_block(reg|0x30000, (uint8_t*)pstrRev, sizeof(tstrM2mRev));
if(ret == M2M_SUCCESS)
{
M2M_INFO("OTA HIF (%u) : %u.%u\r\n", M2M_GET_HIF_BLOCK(pstrRev->u16FirmwareHifInfo), M2M_GET_HIF_MAJOR(pstrRev->u16FirmwareHifInfo), M2M_GET_HIF_MINOR(pstrRev->u16FirmwareHifInfo));
M2M_INFO("OTA ver : %u.%u.%u\r\n", pstrRev->u8FirmwareMajor, pstrRev->u8FirmwareMinor, pstrRev->u8FirmwarePatch);
M2M_INFO("OTA Build %s Time %s\r\n", pstrRev->BuildDate, pstrRev->BuildTime);
/* Check Hif info is consistent */
if(ota_hif_info != pstrRev->u16FirmwareHifInfo)
{
ret = M2M_ERR_FAIL;
M2M_ERR("Inconsistent OTA Version\r\n");
}
}
}
else
{
ret = M2M_ERR_FAIL;
}
}
}
else
{
ret = M2M_ERR_FAIL;
}
}
}
else
{
ret = M2M_ERR_FAIL;
}
if(ret != M2M_SUCCESS)
{
M2M_INFO("No valid OTA image\r\n");
}
return ret;
}
/**
* @fn nm_drv_init_download_mode
* @brief Initialize NMC1000 driver in download mode
* @return @ref M2M_SUCCESS in case of success and Negative error code in case of failure
*/
int8_t nm_drv_init_download_mode(void)
{
int8_t ret = M2M_SUCCESS;
ret = nm_bus_iface_init(NULL);
if (M2M_SUCCESS != ret) {
M2M_ERR("[nmi start]: fail init bus\r\n");
goto ERR1;
}
nm_spi_lock_init();
/* Must do this after global reset to set SPI data packet size. */
nm_spi_init();
M2M_INFO("Chip ID %lx\r\n", nmi_get_chipid());
/*disable all interrupt in ROM (to disable uart) in 2b0 chip*/
nm_write_reg(0x20300, 0);
genuNmState = NM_STATE_INIT;
ERR1:
return ret;
}
int8_t nm_drv_init_hold(void)
{
int8_t ret = M2M_SUCCESS;
nm_spi_lock_init();
ret = nm_bus_iface_init(NULL);
if (M2M_SUCCESS != ret) {
M2M_ERR("[nmi start]: fail init bus\r\n");
goto ERR1;
}
#ifdef BUS_ONLY
return;
#endif
#ifdef NO_HW_CHIP_EN
ret = chip_wake();
nm_sleep(10);
if (M2M_SUCCESS != ret) {
M2M_ERR("[nmi start]: fail chip_wakeup\r\n");
goto ERR2;
}
/**
Go...
**/
ret = chip_reset();
if (M2M_SUCCESS != ret) {
goto ERR2;
}
#endif
M2M_INFO("Chip ID %lx\r\n", nmi_get_chipid());
/* Must do this after global reset to set SPI data packet size. */
nm_spi_init();
/*return power save to default value*/
chip_idle();
genuNmState = NM_STATE_INIT;
return ret;
#ifdef NO_HW_CHIP_EN
ERR2:
nm_bus_iface_deinit();
#endif
ERR1:
return ret;
}
int8_t nm_drv_init_start(void * arg)
{
int8_t ret = M2M_SUCCESS;
uint8_t u8Mode = M2M_WIFI_MODE_NORMAL;
if(NULL != arg)
{
u8Mode = *((uint8_t *)arg);
if(u8Mode < M2M_WIFI_MODE_NORMAL || u8Mode >= M2M_WIFI_MODE_MAX)
u8Mode = M2M_WIFI_MODE_NORMAL;
}
ret = cpu_start();
if (M2M_SUCCESS != ret) {
goto ERR2;
}
ret = wait_for_bootrom(u8Mode);
if (M2M_SUCCESS != ret) {
goto ERR2;
}
ret = wait_for_firmware_start(u8Mode);
if (M2M_SUCCESS != ret) {
goto ERR2;
}
if(M2M_WIFI_MODE_CONFIG == u8Mode) {
goto ERR1;
} else {
/*continue running*/
}
ret = enable_interrupts();
if (M2M_SUCCESS != ret) {
M2M_ERR("failed to enable interrupts..\r\n");
goto ERR2;
}
genuNmState = NM_STATE_START;
return ret;
ERR2:
nm_bus_iface_deinit();
nm_spi_deinit();
ERR1:
return ret;
}
/**
* @fn nm_drv_init
* @brief Initialize NMC1000 driver
* @param[in] arg
* Generic argument passed on to nm_drv_init_start
* @return @ref M2M_SUCCESS in case of success and Negative error code in case of failure
*/
int8_t nm_drv_init(void* arg)
{
int8_t ret = M2M_SUCCESS;
ret = nm_drv_init_hold();
if(ret == M2M_SUCCESS)
ret = nm_drv_init_start(arg);
return ret;
}
/**
* @fn nm_drv_deinit
* @brief Deinitialize NMC1000 driver
*/
int8_t nm_drv_deinit(void* arg)
{
int8_t ret;
ret = chip_deinit();
if (M2M_SUCCESS != ret) {
M2M_ERR("[nmi stop]: chip_deinit fail\r\n");
goto ERR1;
}
ret = nm_bus_iface_deinit();
if (M2M_SUCCESS != ret) {
M2M_ERR("[nmi stop]: fail init bus\r\n");
goto ERR1;
}
/* Must do this after global reset to set SPI data packet size. */
nm_spi_deinit();
ERR1:
genuNmState = NM_STATE_DEINIT;
return ret;
}
/**
* @fn nm_cpu_start(void)
* @brief Start CPU from the WINC module
* @return @ref M2M_SUCCESS in case of success and Negative error code in case of failure
*/
int8_t nm_cpu_start(void)
{
int8_t ret;
ret = cpu_start();
return ret;
}
/**
* @fn nm_get_state(void)
* @brief Get the current state of the WINC module
* @return The current state of the WINC module
*/
tenuNmState nm_get_state(void)
{
return genuNmState;
}
//DOM-IGNORE-END