firmware/docs/main_8h_source.html

#ifndef MAIN_H

#define MAIN_H


/*

 * This macro is used to set verbose mode during compile time.

 * Ensure that it is commented out for release versions.

 */

//#define VERBOSE_MODE                                  (0)


/* Include all needed Cypress libraries */

#include "cyu3types.h"

#include "cyu3usbconst.h"

#include "cyu3externcstart.h"

#include "cyu3system.h"

#include "cyu3os.h"

#include "cyu3dma.h"

#include "cyu3error.h"

#include "cyu3usb.h"

#include "cyu3i2c.h"

#include "cyu3spi.h"

#include "cyu3uart.h"

#include "cyu3utils.h"

#include "cyu3gpio.h"

#include "cyu3vic.h"

#include "cyu3pib.h"

#include "stdlib.h"

#include "sys/unistd.h"


/* Include all Analog Devices produced project header files */

#include "AppThread.h"

#include "PinFunctions.h"

#include "SpiFunctions.h"

#include "StreamFunctions.h"

#include "StreamThread.h"

#include "Flash.h"

#include "ErrorLog.h"

#include "I2cFunctions.h"

#include "HelperFunctions.h"


/* Lower level register access includes */

#include "gpio_regs.h"

#include "spi_regs.h"

#include "gctlaon_regs.h"


typedef enum FX3BoardType

{

    CypressFX3Board = 0,


    iSensorFX3Board_A = 1,


    iSensorFX3Board_B = 2,


    iSensorFX3Board_C = 3,


    iSensorFX3Board_D = 4,


    iSensorFX3Board_E = 5,


    iSensorFX3Board_F = 6,


    iSensorFX3Board_G = 7,


    iSensorFX3Board_H = 8


}FX3BoardType;


typedef enum PartTye

{

    ADcmXL1021 = 0,


    ADcmXL2021,


    ADcmXL3021,


    IMU,


    LegacyIMU


}PartType;


typedef struct FX3PinMap

{

    uint16_t ADI_PIN_RESET;


    uint16_t ADI_PIN_DIO1;


    uint16_t ADI_PIN_DIO2;


    uint16_t ADI_PIN_DIO3;


    uint16_t ADI_PIN_DIO4;


    uint16_t FX3_PIN_GPIO1;


    uint16_t FX3_PIN_GPIO2;


    uint16_t FX3_PIN_GPIO3;


    uint16_t FX3_PIN_GPIO4;

}FX3PinMap;


typedef struct BoardState

{

    CyU3PSpiConfig_t SpiConfig;


    PartType DutType;


    uint16_t UsbBufferSize;


    CyBool_t AppActive;


    uint32_t TimerPinConfig;


    uint32_t StallTime;


    uint16_t DrPin;


    CyBool_t DrActive;


    CyBool_t DrPolarity;


    CyBool_t WatchDogEnabled;


    uint32_t WatchDogPeriodMs;


    uint32_t WatchDogTicks;


    uint32_t BootTime;


    FX3BoardType BoardType;


    FX3PinMap PinMap;


    uint32_t I2CBitRate;


    uint16_t I2CRetryCount;


}BoardState;


typedef struct StreamState

{

    uint32_t BytesPerFrame;


    CyBool_t PinExitEnable;


    CyBool_t PinStartEnable;


    uint32_t NumRealTimeCaptures;


    uint16_t TransferWordLength;


    uint32_t TransferByteLength;


    uint16_t RoundedByteTransferLength;


    uint32_t NumCaptures;


    uint32_t NumBuffers;


    uint16_t BytesPerBuffer;


    uint8_t *RegList;


    uint16_t BytesPerUsbPacket;


    CyU3PI2cPreamble_t I2CStreamPreamble;


}StreamState;


/*

 * Vendor Command Request Code Definitions

 */


#define ADI_I2C_SET_BIT_RATE                    (0x10)


#define ADI_I2C_READ_BYTES                      (0x11)


#define ADI_I2C_WRITE_BYTES                     (0x12)


#define ADI_I2C_READ_STREAM                     (0x13)


#define ADI_I2C_RETRY_COUNT                     (0x14)


#define ADI_FIRMWARE_ID_CHECK                   (0xB0)


#define ADI_HARD_RESET                          (0xB1)


#define ADI_SET_SPI_CONFIG                      (0xB2)


#define ADI_READ_SPI_CONFIG                     (0xB3)


#define ADI_GET_STATUS                          (0xB4)


#define ADI_SERIAL_NUMBER_CHECK                 (0xB5)


#define ADI_WARM_RESET                          (0xB6)


#define ADI_SET_DUT_SUPPLY                      (0xB7)


#define ADI_GET_BUILD_DATE                      (0xB8)


#define ADI_SET_BOOT_TIME                       (0xB9)


#define ADI_GET_BOARD_TYPE                      (0xBA)


#define ADI_STREAM_GENERIC_DATA                 (0xC0)


#define ADI_STREAM_BURST_DATA                   (0xC1)


#define ADI_READ_PIN                            (0xC3)


#define ADI_READ_TIMER_VALUE                    (0xC4)


#define ADI_PULSE_DRIVE                         (0xC5)


#define ADI_PULSE_WAIT                          (0xC6)


#define ADI_SET_PIN                             (0xC7)


#define ADI_MEASURE_DR                          (0xC8)


#define ADI_PIN_DELAY_MEASURE                   (0xCF)


#define ADI_STREAM_REALTIME                     (0xD0)


#define ADI_NULL_COMMAND                        (0xD1)


#define ADI_SET_PIN_RESISTOR                    (0xD2)


#define ADI_READ_BYTES                          (0xF0)


#define ADI_WRITE_BYTE                          (0xF1)


#define ADI_CLEAR_FLASH_LOG                     (0xF2)


#define ADI_READ_FLASH                          (0xF3)


#define ADI_TRANSFER_BYTES                      (0xCA)


#define ADI_TRANSFER_STREAM                     (0xCC)


#define ADI_PWM_CMD                             (0xC9)


#define ADI_BUSY_MEASURE                        (0xCB)


#define ADI_BITBANG_SPI                         (0xCD)


#define ADI_RESET_SPI                           (0xCE)


/*

 * Clock defines

 */


#define S_TO_TICKS_MULT                         (10078400)


#define MS_TO_TICKS_MULT                        (10078)


#define ADI_GENERIC_STALL_OFFSET                (25)


#define ADI_MICROSECONDS_SLEEP_OFFSET           (14)


#define ADI_TIMER_PIN_INDEX                     (0x0)


/*

 * Endpoint Related Defines

 */


#define ADI_STREAMING_ENDPOINT                  (0x81)


#define ADI_FROM_PC_ENDPOINT                    (0x1)


#define ADI_TO_PC_ENDPOINT                      (0x82)


#define CY_FX_BULK_BURST                        (8)


/*

 * FX3 control registers

 */


#define  GCTL_WPD_CFG                           (*(uvint32_t *)(0xE0051028))


#define  GCTL_WPD_CFG_UPPR                       (*(uvint32_t *)(0xE0051028 + 0x4))


#define GCTL_WPU_CFG                             (*(uvint32_t *)(0xE0051020))


#define GCTL_WPU_CFG_UPPR                        (*(uvint32_t *)(0xE0051020 + 0x4))


#define EFUSE_DIE_ID                             (uvint32_t *)0xE0055010


/*

 * USB Descriptor buffers

 */

extern const uint8_t CyFxUSB20DeviceDscr[];

extern const uint8_t CyFxUSB30DeviceDscr[];

extern const uint8_t CyFxUSBDeviceQualDscr[];

extern const uint8_t CyFxUSBFSConfigDscr[];

extern const uint8_t CyFxUSBHSConfigDscr[];

extern const uint8_t CyFxUSBBOSDscr[];

extern const uint8_t CyFxUSBSSConfigDscr[];

extern const uint8_t CyFxUSBStringLangIDDscr[];

extern const uint8_t CyFxUSBManufactureDscr[];

extern const uint8_t CyFxUSBProductDscr[];

extern uint8_t CyFxUSBSerialNumDesc[];


/* Initialization and configuration functions. */

void AdiAppStart();

void AdiAppStop();

void AdiAppErrorHandler (CyU3PReturnStatus_t status);

FX3BoardType AdiGetFX3BoardType();


/* Event Handlers */

CyBool_t AdiControlEndpointHandler(uint32_t setupdat0, uint32_t setupdat1);

void AdiBulkEndpointHandler(CyU3PUsbEpEvtType evType,CyU3PUSBSpeed_t usbSpeed, uint8_t epNum);

void AdiUSBEventHandler(CyU3PUsbEventType_t evtype, uint16_t evdata);

CyBool_t AdiLPMRequestHandler(CyU3PUsbLinkPowerMode link_mode);

void AdiGPIOEventHandler(uint8_t gpioId);


#define UNUSED(x) (void)(x)


#include <cyu3externcend.h>


#endif