diff --git a/Lib/projector/LC4500API/API.cpp b/Lib/projector/LC4500API/API.cpp new file mode 100644 index 0000000..e70d4e8 --- /dev/null +++ b/Lib/projector/LC4500API/API.cpp @@ -0,0 +1,1833 @@ +/* + * API.cpp + * + * This module provides C callable APIs for each of the command supported by LightCrafter4500 platform and detailed in the programmer's guide. + * + * Copyright (C) 2013 Texas Instruments Incorporated - http://www.ti.com/ + * ALL RIGHTS RESERVED + * +*/ + +#include "API.h" +#include "string.h" +#include "usb.h" +#include "Common.h" +#include + +extern unsigned char OutputBuffer[]; +extern unsigned char InputBuffer[]; + +CmdFormat CmdList[255] = +{ + { 0x1A, 0x00, 0x01 }, //SOURCE_SEL, + { 0x1A, 0x02, 0x01 }, //PIXEL_FORMAT, + { 0x1A, 0x03, 0x01 }, //CLK_SEL, + { 0x1A, 0x37, 0x01 }, //CHANNEL_SWAP, + { 0x1A, 0x04, 0x01 }, //FPD_MODE, + { 0, 0, 0 }, //CURTAIN_COLOR, + { 0x02, 0x00, 0x01 }, //POWER_CONTROL, + { 0x10, 0x08, 0x01 }, //FLIP_LONG, + { 0x10, 0x09, 0x01 }, //FLIP_SHORT, + { 0x12, 0x03, 0x01 }, //TPG_SEL, + { 0x1A, 0x05, 0x01 }, //PWM_INVERT, + { 0x1A, 0x07, 0x01 }, //LED_ENABLE, + { 0x02, 0x05, 0x00 }, //GET_VERSION, + { 0x08, 0x02, 0x00 }, //SW_RESET, + { 0, 0, 0 }, //DMD_PARK, + { 0, 0, 0 }, //BUFFER_FREEZE, + { 0x1A, 0x0A, 0x00 }, //STATUS_HW, + { 0x1A, 0x0B, 0x00 }, //STATUS_SYS, + { 0x1A, 0x0C, 0x00 }, //STATUS_MAIN, + { 0, 0, 0 }, //CSC_DATA, + { 0, 0, 0 }, //GAMMA_CTL, + { 0, 0, 0 }, //BC_CTL, + { 0x1A, 0x10, 0x01 }, //PWM_ENABLE, + { 0x1A, 0x11, 0x06 }, //PWM_SETUP, + { 0x1A, 0x12, 0x05 }, //PWM_CAPTURE_CONFIG, + { 0x1A, 0x38, 0x02 }, //GPIO_CONFIG, + { 0x0B, 0x01, 0x03 }, //LED_CURRENT, + { 0x10, 0x00, 0x10 }, //DISP_CONFIG, + { 0, 0, 0 }, //TEMP_CONFIG, + { 0, 0, 0 }, //TEMP_READ, + { 0x1A, 0x16, 0x09 }, //MEM_CONTROL, + { 0, 0, 0 }, //I2C_CONTROL, + { 0x1A, 0x1A, 0x01 }, //LUT_VALID, + { 0x1A, 0x1B, 0x01 }, //DISP_MODE, + { 0x1A, 0x1D, 0x03 }, //TRIG_OUT1_CTL, + { 0x1A, 0x1E, 0x03 }, //TRIG_OUT2_CTL, + { 0x1A, 0x1F, 0x02 }, //RED_STROBE_DLY, + { 0x1A, 0x20, 0x02 }, //GRN_STROBE_DLY, + { 0x1A, 0x21, 0x02 }, //BLU_STROBE_DLY, + { 0x1A, 0x22, 0x01 }, //PAT_DISP_MODE, + { 0x1A, 0x23, 0x01 }, //PAT_TRIG_MODE, + { 0x1A, 0x24, 0x01 }, //PAT_START_STOP, + { 0, 0, 0 }, //BUFFER_SWAP, + { 0, 0, 0 }, //BUFFER_WR_DISABLE, + { 0, 0, 0 }, //CURRENT_RD_BUFFER, + { 0x1A, 0x29, 0x08 }, //PAT_EXPO_PRD, + { 0x1A, 0x30, 0x01 }, //INVERT_DATA, + { 0x1A, 0x31, 0x04 }, //PAT_CONFIG, + { 0x1A, 0x32, 0x01 }, //MBOX_ADDRESS, + { 0x1A, 0x33, 0x01 }, //MBOX_CONTROL, + { 0x1A, 0x34, 0x00 }, //MBOX_DATA, + { 0x1A, 0x35, 0x04 }, //TRIG_IN1_DELAY, + { 0, 0, 0 }, //TRIG_IN2_CONTROL, + { 0x1A, 0x39, 0x01 }, //SPLASH_LOAD, + { 0x1A, 0x3A, 0x02 }, //SPLASH_LOAD_TIMING, + { 0x08, 0x07, 0x03 }, //GPCLK_CONFIG, + { 0, 0, 0 }, //PULSE_GPIO_23, + { 0, 0, 0 }, //ENABLE_LCR_DEBUG, + { 0x12, 0x04, 0x0C }, //TPG_COLOR, + { 0x1A, 0x13, 0x05 }, //PWM_CAPTURE_READ, + { 0x30, 0x01, 0x00 }, //PROG_MODE, + { 0x00, 0x00, 0x00 }, //BL_STATUS + { 0x00, 0x23, 0x01 }, //BL_SPL_MODE + { 0x00, 0x15, 0x01 }, //BL_GET_MANID, + { 0x00, 0x15, 0x01 }, //BL_GET_DEVID, + { 0x00, 0x15, 0x01 }, //BL_GET_CHKSUM, + { 0x00, 0x29, 0x04 }, //BL_SETSECTADDR, + { 0x00, 0x28, 0x00 }, //BL_SECT_ERASE, + { 0x00, 0x2C, 0x04 }, //BL_SET_DNLDSIZE, + { 0x00, 0x25, 0x00 }, //BL_DNLD_DATA, + { 0x00, 0x2F, 0x01 }, //BL_FLASH_TYPE, + { 0x00, 0x26, 0x00 }, //BL_CALC_CHKSUM, + { 0x00, 0x30, 0x01 } //BL_PROG_MODE, +}; + +static unsigned char seqNum=0; +static unsigned int PatLut[128] = {0}; +static unsigned int PatLutIndex = 0; + +int LCR_Write() +{ + return USB_Write(); +} + +int LCR_Read() +{ + int ret_val; + hidMessageStruct *pMsg = (hidMessageStruct *)InputBuffer; + if(USB_Write() > 0) + { + ret_val = USB_Read(); + + if((pMsg->head.flags.nack == 1) || (pMsg->head.length == 0)) + return -2; + else + return ret_val; + } + return -1; +} + +int LCR_ContinueRead() +{ + return USB_Read(); +} + +int LCR_SendMsg(hidMessageStruct *pMsg) +{ + int maxDataSize = USB_MAX_PACKET_SIZE-sizeof(pMsg->head); + int dataBytesSent = MIN(pMsg->head.length, maxDataSize); //Send all data or max possible + + OutputBuffer[0]=0; // First byte is the report number + memcpy(&OutputBuffer[1], pMsg, (sizeof(pMsg->head) + dataBytesSent)); + + if(LCR_Write() < 0) + return -1; + + //dataBytesSent = maxDataSize; + + while(dataBytesSent < pMsg->head.length) + { + memcpy(&OutputBuffer[1], &pMsg->text.data[dataBytesSent], USB_MAX_PACKET_SIZE); + if(LCR_Write() < 0) + return -1; + dataBytesSent += USB_MAX_PACKET_SIZE; + } + return dataBytesSent+sizeof(pMsg->head); +} + +int LCR_PrepReadCmd(LCR_CMD cmd) +{ + hidMessageStruct msg; + + msg.head.flags.rw = 1; //Read + msg.head.flags.reply = 1; //Host wants a reply from device + msg.head.flags.dest = 0; //Projector Control Endpoint + msg.head.flags.reserved = 0; + msg.head.flags.nack = 0; + msg.head.seq = 0; + + msg.text.cmd = (CmdList[cmd].CMD2 << 8) | CmdList[cmd].CMD3; + msg.head.length = 2; + + if(cmd == BL_GET_MANID) + { + msg.text.data[2] = 0x0C; + msg.head.length += 1; + } + else if (cmd == BL_GET_DEVID) + { + msg.text.data[2] = 0x0D; + msg.head.length += 1; + } + else if (cmd == BL_GET_CHKSUM) + { + msg.text.data[2] = 0x00; + msg.head.length += 1; + } + + OutputBuffer[0]=0; // First byte is the report number + memcpy(&OutputBuffer[1], &msg, (sizeof(msg.head)+sizeof(msg.text.cmd) + msg.head.length)); + return 0; +} + +int LCR_PrepReadCmdWithParam(LCR_CMD cmd, unsigned char param) +{ + hidMessageStruct msg; + + msg.head.flags.rw = 1; //Read + msg.head.flags.reply = 1; //Host wants a reply from device + msg.head.flags.dest = 0; //Projector Control Endpoint + msg.head.flags.reserved = 0; + msg.head.flags.nack = 0; + msg.head.seq = 0; + + msg.text.cmd = (CmdList[cmd].CMD2 << 8) | CmdList[cmd].CMD3; + msg.head.length = 3; + + msg.text.data[2] = param; + + OutputBuffer[0]=0; // First byte is the report number + memcpy(&OutputBuffer[1], &msg, (sizeof(msg.head)+sizeof(msg.text.cmd) + msg.head.length)); + return 0; +} + +int LCR_PrepMemReadCmd(unsigned int addr) +{ + hidMessageStruct msg; + + msg.head.flags.rw = 1; //Read + msg.head.flags.reply = 1; //Host wants a reply from device + msg.head.flags.dest = 0; //Projector Control Endpoint + msg.head.flags.reserved = 0; + msg.head.flags.nack = 0; + msg.head.seq = 0; + + msg.text.cmd = (CmdList[MEM_CONTROL].CMD2 << 8) | CmdList[MEM_CONTROL].CMD3; + msg.head.length = 6; + + msg.text.data[2] = addr; + msg.text.data[3] = addr >>8; + msg.text.data[4] = addr >>16; + msg.text.data[5] = addr >>24; + + OutputBuffer[0]=0; // First byte is the report number + memcpy(&OutputBuffer[1], &msg, (sizeof(msg.head)+sizeof(msg.text.cmd) + msg.head.length)); + return 0; +} + +int LCR_PrepWriteCmd(hidMessageStruct *pMsg, LCR_CMD cmd) +{ + pMsg->head.flags.rw = 0; //Write + pMsg->head.flags.reply = 0; //Host wants a reply from device + pMsg->head.flags.dest = 0; //Projector Control Endpoint + pMsg->head.flags.reserved = 0; + pMsg->head.flags.nack = 0; + pMsg->head.seq = seqNum++; + + pMsg->text.cmd = (CmdList[cmd].CMD2 << 8) | CmdList[cmd].CMD3; + pMsg->head.length = CmdList[cmd].len + 2; + + return 0; +} + +int LCR_GetVersion(unsigned int *pApp_ver, unsigned int *pAPI_ver, unsigned int *pSWConfig_ver, unsigned int *pSeqConfig_ver) +{ + hidMessageStruct msg; + + LCR_PrepReadCmd(GET_VERSION); + + if(LCR_Read() > 0) + { + memcpy(&msg, InputBuffer, 65); + + *pApp_ver = *(unsigned int *)&msg.text.data[0]; + *pAPI_ver = *(unsigned int *)&msg.text.data[4]; + *pSWConfig_ver = *(unsigned int *)&msg.text.data[8]; + *pSeqConfig_ver = *(unsigned int *)&msg.text.data[12]; + return 0; + } + return -1; +} + +int LCR_GetLedEnables(bool *pSeqCtrl, bool *pRed, bool *pGreen, bool *pBlue) +{ + hidMessageStruct msg; + + LCR_PrepReadCmd(LED_ENABLE); + + if(LCR_Read() > 0) + { + memcpy(&msg, InputBuffer, 65); + + if(msg.text.data[0] & BIT0) + *pRed = true; + else + *pRed = false; + + if(msg.text.data[0] & BIT1) + *pGreen = true; + else + *pGreen = false; + + if(msg.text.data[0] & BIT2) + *pBlue = true; + else + *pBlue = false; + + if(msg.text.data[0] & BIT3) + *pSeqCtrl = true; + else + *pSeqCtrl = false; + return 0; + } + return -1; +} + + +int LCR_SetLedEnables(bool SeqCtrl, bool Red, bool Green, bool Blue) +{ + hidMessageStruct msg; + unsigned char Enable=0; + + if(SeqCtrl) + Enable |= BIT3; + if(Red) + Enable |= BIT0; + if(Green) + Enable |= BIT1; + if(Blue) + Enable |= BIT2; + + msg.text.data[2] = Enable; + LCR_PrepWriteCmd(&msg, LED_ENABLE); + + return LCR_SendMsg(&msg); +} + +int LCR_GetLedCurrents(unsigned char *pRed, unsigned char *pGreen, unsigned char *pBlue) +{ + hidMessageStruct msg; + + LCR_PrepReadCmd(LED_CURRENT); + if(LCR_Read() > 0) + { + memcpy(&msg, InputBuffer, 65); + + *pRed = msg.text.data[0]; + *pGreen = msg.text.data[1]; + *pBlue = msg.text.data[2]; + + return 0; + } + return -1; +} + + +int LCR_SetLedCurrents(unsigned char RedCurrent, unsigned char GreenCurrent, unsigned char BlueCurrent) +{ + hidMessageStruct msg; + + msg.text.data[2] = RedCurrent; + msg.text.data[3] = GreenCurrent; + msg.text.data[4] = BlueCurrent; + + LCR_PrepWriteCmd(&msg, LED_CURRENT); + + return LCR_SendMsg(&msg); +} + +bool LCR_GetLongAxisImageFlip(void) +{ + hidMessageStruct msg; + + LCR_PrepReadCmd(FLIP_LONG); + if(LCR_Read() > 0) + { + memcpy(&msg, InputBuffer, 65); + + if ((msg.text.data[0] & BIT0) == BIT0) + return true; + else + return false; + } + return false; +} + +bool LCR_GetShortAxisImageFlip(void) +{ + hidMessageStruct msg; + + LCR_PrepReadCmd(FLIP_SHORT); + if(LCR_Read() > 0) + { + memcpy(&msg, InputBuffer, 65); + + if ((msg.text.data[0] & BIT0) == BIT0) + return true; + else + return false; + } + return false; +} + + +int LCR_SetLongAxisImageFlip(bool Flip) +{ + hidMessageStruct msg; + + if(Flip) + msg.text.data[2] = BIT0; + else + msg.text.data[2] = 0; + + LCR_PrepWriteCmd(&msg, FLIP_LONG); + + return LCR_SendMsg(&msg); +} + +int LCR_SetShortAxisImageFlip(bool Flip) +{ + hidMessageStruct msg; + + if(Flip) + msg.text.data[2] = BIT0; + else + msg.text.data[2] = 0; + + LCR_PrepWriteCmd(&msg, FLIP_SHORT); + + return LCR_SendMsg(&msg); +} + +int LCR_SetProgrammingMode(bool EnterProgMode) +{ + hidMessageStruct msg; + + if(EnterProgMode) + msg.text.data[2] = 1; + else + msg.text.data[2] = 2; + + LCR_PrepWriteCmd(&msg, PROG_MODE); + + return LCR_SendMsg(&msg); +} + +int LCR_ExitProgrammingMode(void) +{ + hidMessageStruct msg; + + msg.text.data[2] = 2; + LCR_PrepWriteCmd(&msg, BL_PROG_MODE); + + return LCR_SendMsg(&msg); +} + + +int LCR_GetProgrammingMode(bool *ProgMode) +{ + hidMessageStruct msg; + + LCR_PrepReadCmd(PROG_MODE); + + if(LCR_Read() > 0) + { + memcpy(&msg, InputBuffer, 65); + + if(msg.text.data[0] == 1) + *ProgMode = true; + else + *ProgMode = false; + return 0; + } + return -1; +} + +int LCR_GetFlashManID(unsigned short *pManID) +{ + hidMessageStruct msg; + + LCR_PrepReadCmd(BL_GET_MANID); + if(LCR_Read() > 0) + { + memcpy(&msg, InputBuffer, 65); + + *pManID = msg.text.data[6]; + *pManID |= (unsigned short)msg.text.data[7] << 8; + return 0; + } + return -1; +} + +int LCR_GetFlashDevID(unsigned long long *pDevID) +{ + hidMessageStruct msg; + + LCR_PrepReadCmd(BL_GET_DEVID); + if(LCR_Read() > 0) + { + memcpy(&msg, InputBuffer, 65); + + *pDevID = msg.text.data[6]; + *pDevID |= (unsigned long long)msg.text.data[7] << 8; + *pDevID |= (unsigned long long)msg.text.data[8] << 16; + *pDevID |= (unsigned long long)msg.text.data[9] << 24; + *pDevID |= (unsigned long long)msg.text.data[12] << 32; + *pDevID |= (unsigned long long)msg.text.data[13] << 40; + *pDevID |= (unsigned long long)msg.text.data[14] << 48; + *pDevID |= (unsigned long long)msg.text.data[15] << 56; + return 0; + } + return -1; +} + +int LCR_GetBLStatus(unsigned char *BL_Status) +{ + hidMessageStruct msg; + + /* For some reason BL_STATUS readback is not working properly. + * However, after going through the bootloader code, I have ascertained that any + * readback is fine - Byte 0 is always teh bootloader status */ + LCR_PrepReadCmd(BL_GET_CHKSUM); + if(LCR_Read() > 0) + { + memcpy(&msg, InputBuffer, 65); + + *BL_Status = msg.text.data[0]; + return 0; + } + return -1; +} + +int LCR_BLSpecialMode(unsigned int Mode) +{ + hidMessageStruct msg; + + msg.text.data[2] = Mode; + + LCR_PrepWriteCmd(&msg, BL_SPL_MODE); + + return LCR_SendMsg(&msg); +} + +int LCR_SetFlashAddr(unsigned int Addr) +{ + hidMessageStruct msg; + + msg.text.data[2] = Addr; + msg.text.data[3] = Addr >> 8; + msg.text.data[4] = Addr >> 16; + msg.text.data[5] = Addr >> 24; + + LCR_PrepWriteCmd(&msg, BL_SET_SECTADDR); + + return LCR_SendMsg(&msg); +} + + int LCR_FlashSectorErase(void) + { + hidMessageStruct msg; + + LCR_PrepWriteCmd(&msg, BL_SECT_ERASE); + return LCR_SendMsg(&msg); + } + +int LCR_SetDownloadSize(unsigned int dataLen) +{ + hidMessageStruct msg; + + msg.text.data[2] = dataLen; + msg.text.data[3] = dataLen >> 8; + msg.text.data[4] = dataLen >> 16; + msg.text.data[5] = dataLen >> 24; + + LCR_PrepWriteCmd(&msg, BL_SET_DNLDSIZE); + + return LCR_SendMsg(&msg); +} + +int LCR_DownloadData(unsigned char *pByteArray, unsigned int dataLen) +{ + hidMessageStruct msg; + int retval; + unsigned int sendSize; + + sendSize = HID_MESSAGE_MAX_SIZE - sizeof(msg.head)- sizeof(msg.text.cmd) - 2;//The last -2 is to workaround a bug in bootloader. + + if(dataLen > sendSize) + dataLen = sendSize; + + CmdList[BL_DNLD_DATA].len = dataLen; + memcpy(&msg.text.data[2], pByteArray, dataLen); + + LCR_PrepWriteCmd(&msg, BL_DNLD_DATA); + + retval = LCR_SendMsg(&msg); + if(retval > 0) + return dataLen; + + return -1; +} + +void LCR_WaitForFlashReady() +{ + unsigned char BLstatus=STAT_BIT_FLASH_BUSY; + + do + { + LCR_GetBLStatus(&BLstatus); + } + while((BLstatus & STAT_BIT_FLASH_BUSY) == STAT_BIT_FLASH_BUSY);//Wait for flash busy flag to go off +} + +int LCR_SetFlashType(unsigned char Type) +{ + hidMessageStruct msg; + + msg.text.data[2] = Type; + + LCR_PrepWriteCmd(&msg, BL_FLASH_TYPE); + + return LCR_SendMsg(&msg); +} + +int LCR_CalculateFlashChecksum(void) +{ + hidMessageStruct msg; + + LCR_PrepWriteCmd(&msg, BL_CALC_CHKSUM); + + if(LCR_SendMsg(&msg) <= 0) + return -1; + + return 0; + +} + +int LCR_GetFlashChecksum(unsigned int*checksum) +{ + hidMessageStruct msg; +#if 0 + LCR_PrepWriteCmd(&msg, BL_CALC_CHKSUM); + if(LCR_SendMsg(&msg) <= 0) + return -1; + LCR_WaitForFlashReady(); +#endif + LCR_PrepReadCmd(BL_GET_CHKSUM); + if(LCR_Read() > 0) + { + memcpy(&msg, InputBuffer, 65); + + *checksum = msg.text.data[6]; + *checksum |= (unsigned int)msg.text.data[7] << 8; + *checksum |= (unsigned int)msg.text.data[8] << 16; + *checksum |= (unsigned int)msg.text.data[9] << 24; + return 0; + } + return -1; +} + +int LCR_GetStatus(unsigned char *pHWStatus, unsigned char *pSysStatus, unsigned char *pMainStatus) +{ + hidMessageStruct msg; + + LCR_PrepReadCmd(STATUS_HW); + if(LCR_Read() > 0) + { + memcpy(&msg, InputBuffer, 65); + + *pHWStatus = msg.text.data[0]; + } + else + return -1; + + LCR_PrepReadCmd(STATUS_SYS); + if(LCR_Read() > 0) + { + memcpy(&msg, InputBuffer, 65); + + *pSysStatus = msg.text.data[0]; + } + else + return -1; + + LCR_PrepReadCmd(STATUS_MAIN); + if(LCR_Read() > 0) + { + memcpy(&msg, InputBuffer, 65); + + *pMainStatus = msg.text.data[0]; + } + else + return -1; + + return 0; +} + +int LCR_SoftwareReset(void) +{ + hidMessageStruct msg; + + LCR_PrepWriteCmd(&msg, SW_RESET); + + return LCR_SendMsg(&msg); +} + +int LCR_SetMode(bool SLmode) +{ + hidMessageStruct msg; + + msg.text.data[2] = SLmode; + LCR_PrepWriteCmd(&msg, DISP_MODE); + + return LCR_SendMsg(&msg); +} + +int LCR_GetMode(bool *pMode) +{ + hidMessageStruct msg; + + LCR_PrepReadCmd(DISP_MODE); + if(LCR_Read() > 0) + { + memcpy(&msg, InputBuffer, 65); + *pMode = (msg.text.data[0] != 0); + return 0; + } + return -1; +} + +int LCR_SetPowerMode(bool Standby) +{ + hidMessageStruct msg; + + msg.text.data[2] = Standby; + LCR_PrepWriteCmd(&msg, POWER_CONTROL); + + return LCR_SendMsg(&msg); +} + +int LCR_SetRedLEDStrobeDelay(unsigned char rising, unsigned char falling) +{ + hidMessageStruct msg; + + msg.text.data[2] = rising; + msg.text.data[3] = falling; + + LCR_PrepWriteCmd(&msg, RED_STROBE_DLY); + + return LCR_SendMsg(&msg); +} + +int LCR_SetGreenLEDStrobeDelay(unsigned char rising, unsigned char falling) +{ + hidMessageStruct msg; + + msg.text.data[2] = rising; + msg.text.data[3] = falling; + + LCR_PrepWriteCmd(&msg, GRN_STROBE_DLY); + + return LCR_SendMsg(&msg); +} + +int LCR_SetBlueLEDStrobeDelay(unsigned char rising, unsigned char falling) +{ + hidMessageStruct msg; + + msg.text.data[2] = rising; + msg.text.data[3] = falling; + + LCR_PrepWriteCmd(&msg, BLU_STROBE_DLY); + + return LCR_SendMsg(&msg); +} + +int LCR_GetRedLEDStrobeDelay(unsigned char *pRising, unsigned char *pFalling) +{ + hidMessageStruct msg; + + LCR_PrepReadCmd(RED_STROBE_DLY); + + if(LCR_Read() > 0) + { + memcpy(&msg, InputBuffer, 65); + *pRising = msg.text.data[0]; + *pFalling = msg.text.data[1]; + return 0; + } + return -1; +} + +int LCR_GetGreenLEDStrobeDelay(unsigned char *pRising, unsigned char *pFalling) +{ + hidMessageStruct msg; + + LCR_PrepReadCmd(GRN_STROBE_DLY); + + if(LCR_Read() > 0) + { + memcpy(&msg, InputBuffer, 65); + *pRising = msg.text.data[0]; + *pFalling = msg.text.data[1]; + return 0; + } + return -1; +} + +int LCR_GetBlueLEDStrobeDelay(unsigned char *pRising, unsigned char *pFalling) +{ + hidMessageStruct msg; + + LCR_PrepReadCmd(BLU_STROBE_DLY); + + if(LCR_Read() > 0) + { + memcpy(&msg, InputBuffer, 65); + *pRising = msg.text.data[0]; + *pFalling = msg.text.data[1]; + return 0; + } + return -1; +} + +int LCR_SetInputSource(unsigned int source, unsigned int portWidth) +{ + hidMessageStruct msg; + + msg.text.data[2] = source; + msg.text.data[2] |= portWidth << 3; + LCR_PrepWriteCmd(&msg, SOURCE_SEL); + + return LCR_SendMsg(&msg); +} + +int LCR_GetInputSource(unsigned int *pSource, unsigned int *pPortWidth) +{ + hidMessageStruct msg; + + LCR_PrepReadCmd(SOURCE_SEL); + + if(LCR_Read() > 0) + { + memcpy(&msg, InputBuffer, 65); + *pSource = msg.text.data[0] & (BIT0 | BIT1 | BIT2); + *pPortWidth = msg.text.data[0] >> 3; + return 0; + } + return -1; +} + +int LCR_SetPatternDisplayMode(bool external) +{ + hidMessageStruct msg; + + if(external) + msg.text.data[2] = 0; + else + msg.text.data[2] = 3; + + LCR_PrepWriteCmd(&msg, PAT_DISP_MODE); + + return LCR_SendMsg(&msg); +} + +int LCR_GetPatternDisplayMode(bool *external) +{ + hidMessageStruct msg; + + LCR_PrepReadCmd(PAT_DISP_MODE); + + if(LCR_Read() > 0) + { + memcpy(&msg, InputBuffer, 65); + if(msg.text.data[0] == 0) + *external = true; + else + *external = false; + return 0; + } + return -1; +} + +int LCR_SetPixelFormat(unsigned int format) +{ + hidMessageStruct msg; + + msg.text.data[2] = format; + LCR_PrepWriteCmd(&msg, PIXEL_FORMAT); + + return LCR_SendMsg(&msg); +} + +int LCR_GetPixelFormat(unsigned int *pFormat) +{ + hidMessageStruct msg; + + LCR_PrepReadCmd(PIXEL_FORMAT); + + if(LCR_Read() > 0) + { + memcpy(&msg, InputBuffer, 65); + *pFormat = msg.text.data[0] & (BIT0 | BIT1 | BIT2); + return 0; + } + return -1; +} + +int LCR_SetPortClock(unsigned int clock) +{ + hidMessageStruct msg; + + msg.text.data[2] = clock; + LCR_PrepWriteCmd(&msg, CLK_SEL); + + return LCR_SendMsg(&msg); +} + +int LCR_GetPortClock(unsigned int *pClock) +{ + hidMessageStruct msg; + + LCR_PrepReadCmd(CLK_SEL); + + if(LCR_Read() > 0) + { + memcpy(&msg, InputBuffer, 65); + *pClock = msg.text.data[0] & (BIT0 | BIT1 | BIT2); + return 0; + } + return -1; +} + +int LCR_SetDataChannelSwap(unsigned int port, unsigned int swap) +{ + hidMessageStruct msg; + + msg.text.data[2] = port << 7; + msg.text.data[2] |= swap & (BIT0 | BIT1 | BIT2); + LCR_PrepWriteCmd(&msg, CHANNEL_SWAP); + + return LCR_SendMsg(&msg); +} + +int LCR_GetDataChannelSwap(unsigned int *pPort, unsigned int *pSwap) +{ + hidMessageStruct msg; + + LCR_PrepReadCmd(CHANNEL_SWAP); + + if(LCR_Read() > 0) + { + memcpy(&msg, InputBuffer, 65); + *pSwap = msg.text.data[0] & (BIT0 | BIT1 | BIT2); + if(msg.text.data[0] & BIT7) + *pPort = 1; + else + *pPort = 0; + return 0; + } + return -1; +} + +int LCR_SetFPD_Mode_Field(unsigned int PixelMappingMode, bool SwapPolarity, unsigned int FieldSignalSelect) +{ + hidMessageStruct msg; + + msg.text.data[2] = PixelMappingMode << 6; + msg.text.data[2] |= FieldSignalSelect & (BIT0 | BIT1 | BIT2); + if(SwapPolarity) + msg.text.data[2] |= BIT3; + LCR_PrepWriteCmd(&msg, FPD_MODE); + + return LCR_SendMsg(&msg); +} + +int LCR_GetFPD_Mode_Field(unsigned int *pPixelMappingMode, bool *pSwapPolarity, unsigned int *pFieldSignalSelect) +{ + hidMessageStruct msg; + + LCR_PrepReadCmd(FPD_MODE); + + if(LCR_Read() > 0) + { + memcpy(&msg, InputBuffer, 65); + *pFieldSignalSelect = msg.text.data[0] & (BIT0 | BIT1 | BIT2); + if(msg.text.data[0] & BIT3) + *pSwapPolarity = 1; + else + *pSwapPolarity = 0; + *pPixelMappingMode = msg.text.data[0] >> 6; + return 0; + } + return -1; +} + +int LCR_SetTPGSelect(unsigned int pattern) +{ + hidMessageStruct msg; + + msg.text.data[2] = pattern; + LCR_PrepWriteCmd(&msg, TPG_SEL); + + return LCR_SendMsg(&msg); +} + +int LCR_GetTPGSelect(unsigned int *pPattern) +{ + hidMessageStruct msg; + + LCR_PrepReadCmd(TPG_SEL); + + if(LCR_Read() > 0) + { + memcpy(&msg, InputBuffer, 65); + *pPattern = msg.text.data[0] & (BIT0 | BIT1 | BIT2 | BIT3); + return 0; + } + return -1; +} + +int LCR_LoadSplash(unsigned int index) +{ + hidMessageStruct msg; + + msg.text.data[2] = index; + LCR_PrepWriteCmd(&msg, SPLASH_LOAD); + + return LCR_SendMsg(&msg); +} + +int LCR_GetSplashIndex(unsigned int *pIndex) +{ + hidMessageStruct msg; + + LCR_PrepReadCmd(SPLASH_LOAD); + + if(LCR_Read() > 0) + { + memcpy(&msg, InputBuffer, 65); + *pIndex = msg.text.data[0]; + return 0; + } + return -1; +} + +int LCR_SetDisplay(rectangle croppedArea, rectangle displayArea) +{ + hidMessageStruct msg; + + msg.text.data[2] = croppedArea.firstPixel & 0xFF; + msg.text.data[3] = croppedArea.firstPixel >> 8; + msg.text.data[4] = croppedArea.firstLine & 0xFF; + msg.text.data[5] = croppedArea.firstLine >> 8; + msg.text.data[6] = croppedArea.pixelsPerLine & 0xFF; + msg.text.data[7] = croppedArea.pixelsPerLine >> 8; + msg.text.data[8] = croppedArea.linesPerFrame & 0xFF; + msg.text.data[9] = croppedArea.linesPerFrame >> 8; + msg.text.data[10] = displayArea.firstPixel & 0xFF; + msg.text.data[11] = displayArea.firstPixel >> 8; + msg.text.data[12] = displayArea.firstLine & 0xFF; + msg.text.data[13] = displayArea.firstLine >> 8; + msg.text.data[14] = displayArea.pixelsPerLine & 0xFF; + msg.text.data[15] = displayArea.pixelsPerLine >> 8; + msg.text.data[16] = displayArea.linesPerFrame & 0xFF; + msg.text.data[17] = displayArea.linesPerFrame >> 8; + + LCR_PrepWriteCmd(&msg, DISP_CONFIG); + + return LCR_SendMsg(&msg); +} + +int LCR_GetDisplay(rectangle *pCroppedArea, rectangle *pDisplayArea) +{ + hidMessageStruct msg; + + LCR_PrepReadCmd(DISP_CONFIG); + + if(LCR_Read() > 0) + { + memcpy(&msg, InputBuffer, 65); + pCroppedArea->firstPixel = msg.text.data[0] | msg.text.data[1] << 8; + pCroppedArea->firstLine = msg.text.data[2] | msg.text.data[3] << 8; + pCroppedArea->pixelsPerLine = msg.text.data[4] | msg.text.data[5] << 8; + pCroppedArea->linesPerFrame = msg.text.data[6] | msg.text.data[7] << 8; + pDisplayArea->firstPixel = msg.text.data[8] | msg.text.data[9] << 8; + pDisplayArea->firstLine = msg.text.data[10] | msg.text.data[11] << 8; + pDisplayArea->pixelsPerLine = msg.text.data[12] | msg.text.data[13] << 8; + pDisplayArea->linesPerFrame = msg.text.data[14] | msg.text.data[15] << 8; + + return 0; + } + return -1; +} + +int LCR_SetTPGColor(unsigned short redFG, unsigned short greenFG, unsigned short blueFG, unsigned short redBG, unsigned short greenBG, unsigned short blueBG) +{ + hidMessageStruct msg; + + msg.text.data[2] = (char)redFG; + msg.text.data[3] = (char)(redFG >> 8); + msg.text.data[4] = (char)greenFG; + msg.text.data[5] = (char)(greenFG >> 8); + msg.text.data[6] = (char)blueFG; + msg.text.data[7] = (char)(blueFG >> 8); + msg.text.data[8] = (char)redBG; + msg.text.data[9] = (char)(redBG >> 8); + msg.text.data[10] = (char)greenBG; + msg.text.data[11] = (char)(greenBG >> 8); + msg.text.data[12] = (char)blueBG; + msg.text.data[13] = (char)(blueBG >> 8); + + LCR_PrepWriteCmd(&msg, TPG_COLOR); + + return LCR_SendMsg(&msg); +} + +int LCR_GetTPGColor(unsigned short *pRedFG, unsigned short *pGreenFG, unsigned short *pBlueFG, unsigned short *pRedBG, unsigned short *pGreenBG, unsigned short *pBlueBG) +{ + hidMessageStruct msg; + + LCR_PrepReadCmd(TPG_COLOR); + + if(LCR_Read() > 0) + { + memcpy(&msg, InputBuffer, 65); + *pRedFG = msg.text.data[0] | msg.text.data[1] << 8; + *pGreenFG = msg.text.data[2] | msg.text.data[3] << 8; + *pBlueFG = msg.text.data[4] | msg.text.data[5] << 8; + *pRedBG = msg.text.data[6] | msg.text.data[7] << 8; + *pGreenBG = msg.text.data[8] | msg.text.data[9] << 8; + *pBlueBG = msg.text.data[10] | msg.text.data[11] << 8; + + return 0; + } + return -1; +} + +int LCR_ClearPatLut(void) +{ + PatLutIndex = 0; + return 0; +} + +int LCR_AddToPatLut(int TrigType, int PatNum,int BitDepth,int LEDSelect,bool InvertPat, bool InsertBlack,bool BufSwap, bool trigOutPrev) +{ + unsigned int lutWord = 0; + + lutWord = TrigType & 3; + if(PatNum > 24) + return -1; + + lutWord |= ((PatNum & 0x3F) << 2); + if( (BitDepth > 8) || (BitDepth <= 0)) + return -1; + lutWord |= ((BitDepth & 0xF) << 8); + if(LEDSelect > 7) + return -1; + lutWord |= ((LEDSelect & 0x7) << 12); + if(InvertPat) + lutWord |= BIT16; + if(InsertBlack) + lutWord |= BIT17; + if(BufSwap) + lutWord |= BIT18; + if(trigOutPrev) + lutWord |= BIT19; + + PatLut[PatLutIndex++] = lutWord; + return 0; +} + +int LCR_GetPatLutItem(int index, int *pTrigType, int *pPatNum,int *pBitDepth,int *pLEDSelect,bool *pInvertPat, bool *pInsertBlack,bool *pBufSwap, bool *pTrigOutPrev) +{ + unsigned int lutWord; + + lutWord = PatLut[index]; + + *pTrigType = lutWord & 3; + *pPatNum = (lutWord >> 2) & 0x3F; + *pBitDepth = (lutWord >> 8) & 0xF; + *pLEDSelect = (lutWord >> 12) & 7; + *pInvertPat = ((lutWord & BIT16) == BIT16); + *pInsertBlack = ((lutWord & BIT17) == BIT17); + *pBufSwap = ((lutWord & BIT18) == BIT18); + *pTrigOutPrev = ((lutWord & BIT19) == BIT19); + + return 0; +} + +int LCR_OpenMailbox(int MboxNum) +{ + hidMessageStruct msg; + + msg.text.data[2] = MboxNum; + LCR_PrepWriteCmd(&msg, MBOX_CONTROL); + + return LCR_SendMsg(&msg); +} + +int LCR_CloseMailbox(void) +{ + hidMessageStruct msg; + + msg.text.data[2] = 0; + LCR_PrepWriteCmd(&msg, MBOX_CONTROL); + + return LCR_SendMsg(&msg); +} + +int LCR_MailboxSetAddr(int Addr) +{ + hidMessageStruct msg; + + if(Addr > 127) + return -1; + + msg.text.data[2] = Addr; + LCR_PrepWriteCmd(&msg, MBOX_ADDRESS); + + return LCR_SendMsg(&msg); +} + +int LCR_SendPatLut(void) +{ + hidMessageStruct msg; + int bytesToSend=PatLutIndex*3; + unsigned int i; + + if(LCR_OpenMailbox(2) < 0) + return -1; + LCR_MailboxSetAddr(0); + + CmdList[MBOX_DATA].len = bytesToSend; + LCR_PrepWriteCmd(&msg, MBOX_DATA); + + for(i=0; i>8; + msg.text.data[2+3*i+2] = PatLut[i]>>16; + } + + LCR_SendMsg(&msg); + LCR_CloseMailbox(); + return 0; +} + +int LCR_SendSplashLut(unsigned char *lutEntries, unsigned int numEntries) +{ + hidMessageStruct msg; + unsigned int i; + + if(numEntries < 1 || numEntries > 64) + return -1; + + LCR_OpenMailbox(1); + LCR_MailboxSetAddr(0); + + // Check for special case of 2 entries + if( numEntries == 2) + { + msg.text.data[2+0] = lutEntries[1]; + msg.text.data[2+1] = lutEntries[0]; + } + else + { + for(i=0; i < numEntries; i++) + { + msg.text.data[2+i] = lutEntries[i]; + } + } + + CmdList[MBOX_DATA].len = numEntries; + LCR_PrepWriteCmd(&msg, MBOX_DATA); + LCR_SendMsg(&msg); + LCR_CloseMailbox(); + + return 0; +} + + +int LCR_GetPatLut(int numEntries) +{ + hidMessageStruct msg; + unsigned int lutWord = 0; + int numBytes, i; + unsigned char *readBuf; + + if(numEntries > 128) + return -1; + + if(LCR_OpenMailbox(2) < 0) + return -1; + + if(LCR_MailboxSetAddr(0) < 0) + return -1; + + numBytes = sizeof(msg.head)+numEntries*3; + readBuf = (unsigned char *)&msg; + LCR_PrepReadCmd(MBOX_DATA); + + + if(LCR_Read() > 0) + { + memcpy(readBuf, InputBuffer, MIN(numBytes,64)); + readBuf+=64; + numBytes -=64; + } + else + { + LCR_CloseMailbox(); + return -1; + } + /* If packet is greater than 64 bytes, continue to read */ + while(numBytes > 0) + { + LCR_ContinueRead(); + memcpy(readBuf, InputBuffer, MIN(numBytes,64)); + readBuf+=64; + numBytes -=64; + } + + LCR_ClearPatLut(); + for(i=0; i 0) + { + memcpy(pLut, InputBuffer+sizeof(pMsg->head), MIN(numEntries,64-sizeof(pMsg->head))); + pLut+= (64-sizeof(pMsg->head)); + numEntries -= (64-sizeof(pMsg->head)); + } + else + { + LCR_CloseMailbox(); + return -1; + } + + /* If packet is greater than 64 bytes, continue to read */ + while(numEntries > 0) + { + LCR_ContinueRead(); + memcpy(pLut, InputBuffer, MIN(numEntries,64)); + pLut+=64; + numEntries -= 64; + } + + if(LCR_CloseMailbox() < 0) + return -1; + + return 0; +} + +int LCR_SetPatternTriggerMode(bool Vsync_or_Generated) +{ + hidMessageStruct msg; + + msg.text.data[2] = Vsync_or_Generated; + LCR_PrepWriteCmd(&msg, PAT_TRIG_MODE); + + return LCR_SendMsg(&msg); +} + +int LCR_GetPatternTriggerMode(bool *Vsync_or_Generated) +{ hidMessageStruct msg; + + LCR_PrepReadCmd(PAT_TRIG_MODE); + + if(LCR_Read() > 0) + { + memcpy(&msg, InputBuffer, 65); + *Vsync_or_Generated = (msg.text.data[0] != 0); + return 0; + } + return -1; +} + + +int LCR_PatternDisplay(int Action) +{ + hidMessageStruct msg; + + msg.text.data[2] = Action; + LCR_PrepWriteCmd(&msg, PAT_START_STOP); + + return LCR_SendMsg(&msg); +} + +int LCR_SetPatternConfig(unsigned int numLutEntries, bool repeat, unsigned int numPatsForTrigOut2, unsigned int numSplash) +{ + hidMessageStruct msg; + + msg.text.data[2] = numLutEntries-1; /* -1 because the firmware command takes 0-based indices (0 means 1) */ + msg.text.data[3] = repeat; + msg.text.data[4] = numPatsForTrigOut2 - 1; /* -1 because the firmware command takes 0-based indices (0 means 1) */ + msg.text.data[5] = numSplash - 1; /* -1 because the firmware command takes 0-based indices (0 means 1) */ + LCR_PrepWriteCmd(&msg, PAT_CONFIG); + + return LCR_SendMsg(&msg); +} + +int LCR_GetPatternConfig(unsigned int *pNumLutEntries, bool *pRepeat, unsigned int *pNumPatsForTrigOut2, unsigned int *pNumSplash) +{ + hidMessageStruct msg; + + LCR_PrepReadCmd(PAT_CONFIG); + + if(LCR_Read() > 0) + { + memcpy(&msg, InputBuffer, 65); + *pNumLutEntries = msg.text.data[0] + 1; /* +1 because the firmware gives 0-based indices (0 means 1) */ + *pRepeat = (msg.text.data[1] != 0); + *pNumPatsForTrigOut2 = msg.text.data[2]+1; /* +1 because the firmware gives 0-based indices (0 means 1) */ + *pNumSplash = msg.text.data[3]+1; /* +1 because the firmware gives 0-based indices (0 means 1) */ + return 0; + } + return -1; +} + +int LCR_SetExpsosure_FramePeriod(unsigned int exposurePeriod, unsigned int framePeriod) +{ + hidMessageStruct msg; + + msg.text.data[2] = exposurePeriod; + msg.text.data[3] = exposurePeriod>>8; + msg.text.data[4] = exposurePeriod>>16; + msg.text.data[5] = exposurePeriod>>24; + msg.text.data[6] = framePeriod; + msg.text.data[7] = framePeriod>>8; + msg.text.data[8] = framePeriod>>16; + msg.text.data[9] = framePeriod>>24; + LCR_PrepWriteCmd(&msg, PAT_EXPO_PRD); + + return LCR_SendMsg(&msg); +} + +int LCR_GetExposure_FramePeriod(unsigned int *pExposure, unsigned int *pFramePeriod) +{ + hidMessageStruct msg; + + LCR_PrepReadCmd(PAT_EXPO_PRD); + + if(LCR_Read() > 0) + { + memcpy(&msg, InputBuffer, 65); + *pExposure = msg.text.data[0] | msg.text.data[1] << 8 | msg.text.data[2] << 16 | msg.text.data[3] << 24; + *pFramePeriod = msg.text.data[4] | msg.text.data[5] << 8 | msg.text.data[6] << 16 | msg.text.data[7] << 24; + return 0; + } + return -1; +} + + +int LCR_SetTrigOutConfig(unsigned int trigOutNum, bool invert, unsigned int rising, unsigned int falling) +{ + hidMessageStruct msg; + + msg.text.data[2] = invert; + msg.text.data[3] = rising; + msg.text.data[4] = falling; + if(trigOutNum == 1) + LCR_PrepWriteCmd(&msg, TRIG_OUT1_CTL); + else if(trigOutNum==2) + LCR_PrepWriteCmd(&msg, TRIG_OUT2_CTL); + + return LCR_SendMsg(&msg); +} + +int LCR_GetTrigOutConfig(unsigned int trigOutNum, bool *pInvert,unsigned int *pRising, unsigned int *pFalling) +{ + hidMessageStruct msg; + + if(trigOutNum == 1) + LCR_PrepReadCmd(TRIG_OUT1_CTL); + else if(trigOutNum==2) + LCR_PrepReadCmd(TRIG_OUT2_CTL); + + if(LCR_Read() > 0) + { + memcpy(&msg, InputBuffer, 65); + *pInvert = (msg.text.data[0] != 0); + *pRising = msg.text.data[1]; + *pFalling = msg.text.data[2]; + return 0; + } + return -1; +} + +int LCR_ValidatePatLutData(unsigned int *pStatus) +{ + hidMessageStruct msg; + + LCR_PrepWriteCmd(&msg, LUT_VALID); + if(LCR_SendMsg(&msg) < 0) + return -1; + + LCR_PrepReadCmd(LUT_VALID); + if(LCR_Read() > 0) + { + memcpy(&msg, InputBuffer, 65); + *pStatus = msg.text.data[0]; + return 0; + } + return -1; +} + + +int LCR_SetTrigIn1Delay(unsigned int Delay) +{ + hidMessageStruct msg; + + msg.text.data[2] = Delay; + msg.text.data[3] = Delay >> 8; + msg.text.data[4] = Delay >> 16; + msg.text.data[5] = Delay >> 24; + LCR_PrepWriteCmd(&msg, TRIG_IN1_DELAY); + + return LCR_SendMsg(&msg); +} + +int LCR_GetTrigIn1Delay(unsigned int *pDelay) +{ + hidMessageStruct msg; + + LCR_PrepReadCmd(TRIG_IN1_DELAY); + + if(LCR_Read() > 0) + { + memcpy(&msg, InputBuffer, 65); + *pDelay = msg.text.data[0] | msg.text.data[1]<<8 | msg.text.data[2]<<16 | msg.text.data[3]<<24; + return 0; + } + return -1; +} + +int LCR_SetInvertData(bool invert) +{ + hidMessageStruct msg; + + msg.text.data[2] = invert; + LCR_PrepWriteCmd(&msg, INVERT_DATA); + + return LCR_SendMsg(&msg); +} + +int LCR_SetPWMConfig(unsigned int channel, unsigned int pulsePeriod, unsigned int dutyCycle) +{ + hidMessageStruct msg; + + msg.text.data[2] = channel; + msg.text.data[3] = pulsePeriod; + msg.text.data[4] = pulsePeriod >> 8; + msg.text.data[5] = pulsePeriod >> 16; + msg.text.data[6] = pulsePeriod >> 24; + msg.text.data[7] = dutyCycle; + + LCR_PrepWriteCmd(&msg, PWM_SETUP); + + return LCR_SendMsg(&msg); +} + +int LCR_GetPWMConfig(unsigned int channel, unsigned int *pPulsePeriod, unsigned int *pDutyCycle) +{ + hidMessageStruct msg; + + LCR_PrepReadCmdWithParam(PWM_SETUP, (unsigned char)channel); + if(LCR_Read() > 0) + { + memcpy(&msg, InputBuffer, 65); + *pPulsePeriod = msg.text.data[1] | msg.text.data[2] << 8 | msg.text.data[3] << 16 | msg.text.data[4] << 24; + *pDutyCycle = msg.text.data[5]; + return 0; + } + return -1; +} + +int LCR_SetPWMEnable(unsigned int channel, bool Enable) +{ + hidMessageStruct msg; + unsigned char value = 0; + + if(Enable) + value = BIT7; + + if(channel == 2) + value |= 2; + else if (channel != 0) + return -1; + + msg.text.data[2] = value; + LCR_PrepWriteCmd(&msg, PWM_ENABLE); + + return LCR_SendMsg(&msg); +} + +int LCR_GetPWMEnable(unsigned int channel, bool *pEnable) +{ + hidMessageStruct msg; + + LCR_PrepReadCmdWithParam(PWM_ENABLE, (unsigned char)channel); + + if(LCR_Read() > 0) + { + memcpy(&msg, InputBuffer, 65); + if(msg.text.data[0] & BIT7) + *pEnable = true; + else + *pEnable = false; + + return 0; + } + return -1; +} + +int LCR_SetPWMCaptureConfig(unsigned int channel, bool enable, unsigned int sampleRate) +{ + hidMessageStruct msg; + unsigned char value = 0; + + value = channel & 1; + + if(enable) + value |= BIT7; + + msg.text.data[2] = value; + msg.text.data[3] = sampleRate; + msg.text.data[4] = sampleRate >> 8; + msg.text.data[5] = sampleRate >> 16; + msg.text.data[6] = sampleRate >> 24; + LCR_PrepWriteCmd(&msg, PWM_CAPTURE_CONFIG); + + return LCR_SendMsg(&msg); +} + +int LCR_GetPWMCaptureConfig(unsigned int channel, bool *pEnabled, unsigned int *pSampleRate) +{ + hidMessageStruct msg; + + LCR_PrepReadCmdWithParam(PWM_CAPTURE_CONFIG, (unsigned char)channel); + + if(LCR_Read() > 0) + { + memcpy(&msg, InputBuffer, 65); + if(msg.text.data[0] & BIT7) + *pEnabled = true; + else + *pEnabled = false; + + *pSampleRate = msg.text.data[1] | msg.text.data[2] << 8 | msg.text.data[3] << 16 | msg.text.data[4] << 24; + + return 0; + } + return -1; +} + +int LCR_PWMCaptureRead(unsigned int channel, unsigned int *pLowPeriod, unsigned int *pHighPeriod) +{ + hidMessageStruct msg; + + LCR_PrepReadCmdWithParam(PWM_CAPTURE_READ, (unsigned char)channel); + + if(LCR_Read() > 0) + { + memcpy(&msg, InputBuffer, 65); + *pLowPeriod = msg.text.data[1] | msg.text.data[2] << 8; + *pHighPeriod = msg.text.data[3] | msg.text.data[4] << 8; + return 0; + } + return -1; +} + +int LCR_SetGPIOConfig(unsigned int pinNum, bool enAltFunc, bool altFunc1, bool dirOutput, bool outTypeOpenDrain, bool pinState) +{ + hidMessageStruct msg; + unsigned char value = 0; + + if(enAltFunc) + value |= BIT7; + if(altFunc1) + value |= BIT6; + if(dirOutput) + value |= BIT5; + if(outTypeOpenDrain) + value |= BIT4; + if(pinState) + value |= BIT3; + + msg.text.data[2] = pinNum; + msg.text.data[3] = value; + LCR_PrepWriteCmd(&msg, GPIO_CONFIG); + + return LCR_SendMsg(&msg); +} + +int LCR_GetGPIOConfig(unsigned int pinNum, bool *pEnAltFunc, bool *pAltFunc1, bool *pDirOutput, bool *pOutTypeOpenDrain, bool *pState) +{ + hidMessageStruct msg; + + LCR_PrepReadCmdWithParam(GPIO_CONFIG, (unsigned char)pinNum); + + if(LCR_Read() > 0) + { + memcpy(&msg, InputBuffer, 65); + *pEnAltFunc = ((msg.text.data[1] & BIT7) == BIT7); + *pAltFunc1 = ((msg.text.data[1] & BIT6) == BIT6); + *pDirOutput = ((msg.text.data[1] & BIT5) == BIT5); + *pOutTypeOpenDrain = ((msg.text.data[1] & BIT4) == BIT4); + if(*pDirOutput) + *pState = ((msg.text.data[1] & BIT3) == BIT3); + else + *pState = ((msg.text.data[1] & BIT2) == BIT2); + return 0; + } + return -1; +} + +int LCR_SetGeneralPurposeClockOutFreq(unsigned int clkId, bool enable, unsigned int clkDivider) +{ + hidMessageStruct msg; + + msg.text.data[2] = clkId; + msg.text.data[3] = enable; + msg.text.data[4] = clkDivider; + LCR_PrepWriteCmd(&msg, GPCLK_CONFIG); + + return LCR_SendMsg(&msg); +} + +int LCR_GetGeneralPurposeClockOutFreq(unsigned int clkId, bool *pEnabled, unsigned int *pClkDivider) +{ + hidMessageStruct msg; + + LCR_PrepReadCmdWithParam(GPCLK_CONFIG, (unsigned char)clkId); + + if(LCR_Read() > 0) + { + memcpy(&msg, InputBuffer, 65); + *pEnabled = (msg.text.data[0] != 0); + *pClkDivider = msg.text.data[1]; + return 0; + } + return -1; +} + +int LCR_SetPWMInvert(bool invert) +{ + hidMessageStruct msg; + + msg.text.data[2] = invert; + LCR_PrepWriteCmd(&msg, PWM_INVERT); + + return LCR_SendMsg(&msg); +} + +int LCR_GetPWMInvert(bool *inverted) +{ + hidMessageStruct msg; + + LCR_PrepReadCmd(PWM_INVERT); + + if(LCR_Read() > 0) + { + memcpy(&msg, InputBuffer, 65); + *inverted = (msg.text.data[0] != 0); + return 0; + } + return -1; +} + +int LCR_MemRead(unsigned int addr, unsigned int *readWord) +{ + hidMessageStruct msg; + + LCR_PrepMemReadCmd(addr); + if(LCR_Read() > 0) + { + memcpy(&msg, InputBuffer, 65); + *readWord = msg.text.data[0] | msg.text.data[1] << 8 | msg.text.data[2] << 16 | msg.text.data[3] << 24; + //*readWord = msg.text.data[3] | msg.text.data[2] << 8 | msg.text.data[1] << 16 | msg.text.data[0] << 24; //MSB first + return 0; + } + return -1; +} + +int LCR_MemWrite(unsigned int addr, unsigned int data) +{ + hidMessageStruct msg; + + msg.text.data[2] = 0; //absolute write + msg.text.data[3] = addr >> 24; //MSB first + msg.text.data[4] = addr >> 16; + msg.text.data[5] = addr >> 8; + msg.text.data[6] = addr; + msg.text.data[7] = data >> 24; //MSB first + msg.text.data[8] = data >> 16; + msg.text.data[9] = data >> 8; + msg.text.data[10] = data; + LCR_PrepWriteCmd(&msg, MEM_CONTROL); + + return LCR_SendMsg(&msg); +} + + int LCR_MeasureSplashLoadTiming(unsigned int startIndex, unsigned int numSplash) + { + hidMessageStruct msg; + + msg.text.data[2] = startIndex; + msg.text.data[3] = numSplash; + LCR_PrepWriteCmd(&msg, SPLASH_LOAD_TIMING); + + return LCR_SendMsg(&msg); + } + + int LCR_ReadSplashLoadTiming(unsigned int *pTimingData) + { + hidMessageStruct msg; + int i; + + LCR_PrepReadCmd(SPLASH_LOAD_TIMING); + + if(LCR_Read() > 0) + { + memcpy(&msg, InputBuffer, 65); + for(i=0; i<12; i++) + { + *(pTimingData+i) = (msg.text.data[4*i+0] | msg.text.data[4*i+1] << 8 | msg.text.data[4*i+2] << 16 | msg.text.data[4*i+3] << 24); + } + return 0; + } + return -1; + } diff --git a/Lib/projector/LC4500API/API.h b/Lib/projector/LC4500API/API.h new file mode 100644 index 0000000..872730a --- /dev/null +++ b/Lib/projector/LC4500API/API.h @@ -0,0 +1,259 @@ +/* + * API.h + * + * This module provides C callable APIs for each of the command supported by LightCrafter4500 platform and detailed in the programmer's guide. + * + * Copyright (C) 2013 Texas Instruments Incorporated - http://www.ti.com/ + * ALL RIGHTS RESERVED + * +*/ + +#ifndef API_H +#define API_H + +/* Bit masks. */ +#define BIT0 0x01 +#define BIT1 0x02 +#define BIT2 0x04 +#define BIT3 0x08 +#define BIT4 0x10 +#define BIT5 0x20 +#define BIT6 0x40 +#define BIT7 0x80 +#define BIT8 0x0100 +#define BIT9 0x0200 +#define BIT10 0x0400 +#define BIT11 0x0800 +#define BIT12 0x1000 +#define BIT13 0x2000 +#define BIT14 0x4000 +#define BIT15 0x8000 +#define BIT16 0x00010000 +#define BIT17 0x00020000 +#define BIT18 0x00040000 +#define BIT19 0x00080000 +#define BIT20 0x00100000 +#define BIT21 0x00200000 +#define BIT22 0x00400000 +#define BIT23 0x00800000 +#define BIT24 0x01000000 +#define BIT25 0x02000000 +#define BIT26 0x04000000 +#define BIT27 0x08000000 +#define BIT28 0x10000000 +#define BIT29 0x20000000 +#define BIT30 0x40000000 +#define BIT31 0x80000000 + +#define STAT_BIT_FLASH_BUSY BIT3 +#define HID_MESSAGE_MAX_SIZE 512 + +typedef struct _hidmessageStruct +{ + struct _hidhead + { + struct _packetcontrolStruct + { + unsigned char dest :3; /* 0 - ProjCtrl; 1 - RFC; 7 - Debugmsg */ + unsigned char reserved :2; + unsigned char nack :1; /* Command Handler Error */ + unsigned char reply :1; /* Host wants a reply from device */ + unsigned char rw :1; /* Write = 0; Read = 1 */ + }flags; + unsigned char seq; + unsigned short length; + }head; + union + { + unsigned short cmd; + unsigned char data[HID_MESSAGE_MAX_SIZE]; + }text; +}hidMessageStruct; + +typedef struct _readCmdData +{ + unsigned char CMD2; + unsigned char CMD3; + unsigned short len; +}CmdFormat; + +typedef struct _rectangle +{ + unsigned short firstPixel; + unsigned short firstLine; + unsigned short pixelsPerLine; + unsigned short linesPerFrame; +}rectangle; + +typedef enum +{ + SOURCE_SEL, + PIXEL_FORMAT, + CLK_SEL, + CHANNEL_SWAP, + FPD_MODE, + CURTAIN_COLOR, + POWER_CONTROL, + FLIP_LONG, + FLIP_SHORT, + TPG_SEL, + PWM_INVERT, + LED_ENABLE, + GET_VERSION, + SW_RESET, + DMD_PARK, + BUFFER_FREEZE, + STATUS_HW, + STATUS_SYS, + STATUS_MAIN, + CSC_DATA, + GAMMA_CTL, + BC_CTL, + PWM_ENABLE, + PWM_SETUP, + PWM_CAPTURE_CONFIG, + GPIO_CONFIG, + LED_CURRENT, + DISP_CONFIG, + TEMP_CONFIG, + TEMP_READ, + MEM_CONTROL, + I2C_CONTROL, + LUT_VALID, + DISP_MODE, + TRIG_OUT1_CTL, + TRIG_OUT2_CTL, + RED_STROBE_DLY, + GRN_STROBE_DLY, + BLU_STROBE_DLY, + PAT_DISP_MODE, + PAT_TRIG_MODE, + PAT_START_STOP, + BUFFER_SWAP, + BUFFER_WR_DISABLE, + CURRENT_RD_BUFFER, + PAT_EXPO_PRD, + INVERT_DATA, + PAT_CONFIG, + MBOX_ADDRESS, + MBOX_CONTROL, + MBOX_DATA, + TRIG_IN1_DELAY, + TRIG_IN2_CONTROL, + SPLASH_LOAD, + SPLASH_LOAD_TIMING, + GPCLK_CONFIG, + PULSE_GPIO_23, + ENABLE_LCR_DEBUG, + TPG_COLOR, + PWM_CAPTURE_READ, + PROG_MODE, + BL_STATUS, + BL_SPL_MODE, + BL_GET_MANID, + BL_GET_DEVID, + BL_GET_CHKSUM, + BL_SET_SECTADDR, + BL_SECT_ERASE, + BL_SET_DNLDSIZE, + BL_DNLD_DATA, + BL_FLASH_TYPE, + BL_CALC_CHKSUM, + BL_PROG_MODE, +}LCR_CMD; + +int LCR_SetInputSource(unsigned int source, unsigned int portWidth); +int LCR_GetInputSource(unsigned int *pSource, unsigned int *portWidth); +int LCR_SetPixelFormat(unsigned int format); +int LCR_GetPixelFormat(unsigned int *pFormat); +int LCR_SetPortClock(unsigned int clock); +int LCR_GetPortClock(unsigned int *pClock); +int LCR_SetDataChannelSwap(unsigned int port, unsigned int swap); +int LCR_GetDataChannelSwap(unsigned int *pPort, unsigned int *pSwap); +int LCR_SetFPD_Mode_Field(unsigned int PixelMappingMode, bool SwapPolarity, unsigned int FieldSignalSelect); +int LCR_GetFPD_Mode_Field(unsigned int *pPixelMappingMode, bool *pSwapPolarity, unsigned int *pFieldSignalSelect); +int LCR_SetPowerMode(bool); +int LCR_SetLongAxisImageFlip(bool); +bool LCR_GetLongAxisImageFlip(); +int LCR_SetShortAxisImageFlip(bool); +bool LCR_GetShortAxisImageFlip(); +int LCR_SetTPGSelect(unsigned int pattern); +int LCR_GetTPGSelect(unsigned int *pPattern); +int LCR_SetPWMInvert(bool invert); +int LCR_GetPWMInvert(bool *inverted); +int LCR_SetLedEnables(bool SeqCtrl, bool Red, bool Green, bool Blue); +int LCR_GetLedEnables(bool *pSeqCtrl, bool *pRed, bool *pGreen, bool *pBlue); +int LCR_GetVersion(unsigned int *pApp_ver, unsigned int *pAPI_ver, unsigned int *pSWConfig_ver, unsigned int *pSeqConfig_ver); +int LCR_SoftwareReset(void); +int LCR_GetStatus(unsigned char *pHWStatus, unsigned char *pSysStatus, unsigned char *pMainStatus); +int LCR_SetPWMEnable(unsigned int channel, bool Enable); +int LCR_GetPWMEnable(unsigned int channel, bool *pEnable); +int LCR_SetPWMConfig(unsigned int channel, unsigned int pulsePeriod, unsigned int dutyCycle); +int LCR_GetPWMConfig(unsigned int channel, unsigned int *pPulsePeriod, unsigned int *pDutyCycle); +int LCR_SetPWMCaptureConfig(unsigned int channel, bool enable, unsigned int sampleRate); +int LCR_GetPWMCaptureConfig(unsigned int channel, bool *pEnabled, unsigned int *pSampleRate); +int LCR_SetGPIOConfig(unsigned int pinNum, bool enAltFunc, bool altFunc1, bool dirOutput, bool outTypeOpenDrain, bool pinState); +int LCR_GetGPIOConfig(unsigned int pinNum, bool *pEnAltFunc, bool *pAltFunc1, bool *pDirOutput, bool *pOutTypeOpenDrain, bool *pState); +int LCR_GetLedCurrents(unsigned char *pRed, unsigned char *pGreen, unsigned char *pBlue); +int LCR_SetLedCurrents(unsigned char RedCurrent, unsigned char GreenCurrent, unsigned char BlueCurrent); +int LCR_SetDisplay(rectangle croppedArea, rectangle displayArea); +int LCR_GetDisplay(rectangle *pCroppedArea, rectangle *pDisplayArea); +int LCR_MemRead(unsigned int addr, unsigned int *readWord); +int LCR_MemWrite(unsigned int addr, unsigned int data); +int LCR_ValidatePatLutData(unsigned int *pStatus); +int LCR_SetPatternDisplayMode(bool external); +int LCR_GetPatternDisplayMode(bool *external); +int LCR_SetTrigOutConfig(unsigned int trigOutNum, bool invert, unsigned int rising, unsigned int falling); +int LCR_GetTrigOutConfig(unsigned int trigOutNum, bool *pInvert,unsigned int *pRising, unsigned int *pFalling); +int LCR_SetRedLEDStrobeDelay(unsigned char rising, unsigned char falling); +int LCR_SetGreenLEDStrobeDelay(unsigned char rising, unsigned char falling); +int LCR_SetBlueLEDStrobeDelay(unsigned char rising, unsigned char falling); +int LCR_GetRedLEDStrobeDelay(unsigned char *, unsigned char *); +int LCR_GetGreenLEDStrobeDelay(unsigned char *, unsigned char *); +int LCR_GetBlueLEDStrobeDelay(unsigned char *, unsigned char *); +int LCR_SetProgrammingMode(bool EnterProgMode); +int LCR_ExitProgrammingMode(void); +int LCR_GetProgrammingMode(bool *ProgMode); +int LCR_GetFlashManID(unsigned short *manID); +int LCR_GetFlashDevID(unsigned long long *devID); +int LCR_GetBLStatus(unsigned char *BL_Status); +int LCR_BLSpecialMode(unsigned int Mode); +int LCR_SetFlashAddr(unsigned int Addr); +int LCR_FlashSectorErase(void); +int LCR_SetDownloadSize(unsigned int dataLen); +int LCR_DownloadData(unsigned char *pByteArray, unsigned int dataLen); +void LCR_WaitForFlashReady(void); +int LCR_SetFlashType(unsigned char Type); +int LCR_CalculateFlashChecksum(void); +int LCR_GetFlashChecksum(unsigned int*checksum); +int LCR_SetMode(bool SLmode); +int LCR_GetMode(bool *pMode); +int LCR_LoadSplash(unsigned int index); +int LCR_GetSplashIndex(unsigned int *pIndex); +int LCR_SetTPGColor(unsigned short redFG, unsigned short greenFG, unsigned short blueFG, unsigned short redBG, unsigned short greenBG, unsigned short blueBG); +int LCR_GetTPGColor(unsigned short *pRedFG, unsigned short *pGreenFG, unsigned short *pBlueFG, unsigned short *pRedBG, unsigned short *pGreenBG, unsigned short *pBlueBG); +int LCR_ClearPatLut(void); +int LCR_AddToPatLut(int TrigType, int PatNum,int BitDepth,int LEDSelect,bool InvertPat, bool InsertBlack,bool BufSwap, bool trigOutPrev); +int LCR_GetPatLutItem(int index, int *pTrigType, int *pPatNum,int *pBitDepth,int *pLEDSelect,bool *pInvertPat, bool *pInsertBlack,bool *pBufSwap, bool *pTrigOutPrev); +int LCR_SendPatLut(void); +int LCR_SendSplashLut(unsigned char *lutEntries, unsigned int numEntries); +int LCR_GetPatLut(int numEntries); +int LCR_GetSplashLut(unsigned char *pLut, int numEntries); +int LCR_SetPatternTriggerMode(bool); +int LCR_GetPatternTriggerMode(bool *); +int LCR_PatternDisplay(int Action); +int LCR_SetPatternConfig(unsigned int numLutEntries, bool repeat, unsigned int numPatsForTrigOut2, unsigned int numSplash); +int LCR_GetPatternConfig(unsigned int *pNumLutEntries, bool *pRepeat, unsigned int *pNumPatsForTrigOut2, unsigned int *pNumSplash); +int LCR_SetExpsosure_FramePeriod(unsigned int exposurePeriod, unsigned int framePeriod); +int LCR_GetExposure_FramePeriod(unsigned int *pExposure, unsigned int *pFramePeriod); +int LCR_SetTrigIn1Delay(unsigned int Delay); +int LCR_GetTrigIn1Delay(unsigned int *pDelay); +int LCR_SetInvertData(bool invert); +int LCR_PWMCaptureRead(unsigned int channel, unsigned int *pLowPeriod, unsigned int *pHighPeriod); +int LCR_SetGeneralPurposeClockOutFreq(unsigned int clkId, bool enable, unsigned int clkDivider); +int LCR_GetGeneralPurposeClockOutFreq(unsigned int clkId, bool *pEnabled, unsigned int *pClkDivider); +int LCR_MeasureSplashLoadTiming(unsigned int startIndex, unsigned int numSplash); +int LCR_ReadSplashLoadTiming(unsigned int *pTimingData); + + +#endif // API_H diff --git a/Lib/projector/LC4500API/Common.h b/Lib/projector/LC4500API/Common.h new file mode 100644 index 0000000..094241e --- /dev/null +++ b/Lib/projector/LC4500API/Common.h @@ -0,0 +1,108 @@ +/* + * Common.h + * + * This module provides the common defines used by all the modules. + * + * Copyright (C) 2013 Texas Instruments Incorporated - http://www.ti.com/ + * ALL RIGHTS RESERVED + * +*/ + +#ifndef COMMON_H_ +#define COMMON_H_ + +#include +#include +#include + + +#ifdef __cplusplus +extern "C" { +#endif + +#define TRUE 1 +#define FALSE 0 + +typedef enum +{ + IMAGE_PIX_FORMAT_RGB32, + IMAGE_PIX_FORMAT_GREY8, + IMAGE_PIX_FORMAT_GREY10, + IMAGE_PIX_FORMAT_UYVY16, + IMAGE_PIX_FORMAT_RGB16, + IMAGE_PIX_FORMAT_SBGGR, + IMAGE_PIX_FORMAT_RGB24, +} ImagePixFormat_t; + +typedef struct +{ + unsigned char *Buffer; + unsigned Width; + unsigned Height; + unsigned LineWidth; + ImagePixFormat_t PixFormat; +}Image_t; + + +typedef int BOOL; +typedef unsigned uint32; +typedef unsigned char uint8; +typedef unsigned short uint16; + +typedef uint16 PatternCount_t; + +#define MIN(a, b) ((a) < (b) ? (a) : (b)) +#define MAX(a, b) ((a) > (b) ? (a) : (b)) +#define ALIGN_BYTES_PREV(x, b) ((x) & ~(uint32)((b) - 1)) +#define ALIGN_BYTES_NEXT(x, b) (((x) + ((b)-1)) & ~(uint32)((b) - 1)) + +#define GET_BYTE0(x) ((x) & 0xFF) +#define GET_BYTE1(x) (((x) >> 8) & 0xFF) +#define GET_BYTE2(x) (((x) >> 16) & 0xFF) +#define GET_BYTE3(x) (((x) >> 24) & 0xFF) + +#define PARSE_WORD16_LE(Arr) MAKE_WORD16((Arr)[1], (Arr)[0]) +#define PARSE_WORD16_BE(Arr) MAKE_WORD16((Arr)[0], (Arr)[1]) +#define PARSE_WORD24_LE(Arr) MAKE_WORD32(0, (Arr)[2], (Arr)[1], (Arr)[0]) +#define PARSE_WORD24_BE(Arr) MAKE_WORD32(0, (Arr)[0], (Arr)[1], (Arr)[2]) +#define PARSE_WORD32_LE(Arr) MAKE_WORD32((Arr)[3], (Arr)[2], (Arr)[1], (Arr)[0]) +#define PARSE_WORD32_BE(Arr) MAKE_WORD32((Arr)[0], (Arr)[1], (Arr)[2], (Arr)[3]) + +#define MAKE_WORD16(b1, b0) (((b1) << 8) | (b0)) +#define MAKE_WORD32(b3, b2, b1, b0) (((uint32)(b3)<<24)|((uint32)(b2)<<16)|((uint32)(b1)<<8)|(b0)) + +#define ARRAY_SIZE(x) (sizeof(x)/sizeof(*x)) +#define DIV_ROUND(x, y) (((x)+(y)/2)/(y)) +#define DIV_CEIL(x, y) (((x)+(y)-1)/(y)) +#define POW_OF_2(x) (1ul << (x)) + +#define IS_POW_OF_2(x) (((x) & ((x)-1)) == 0) + +// Generate bit mask of n bits starting from s bit +#define GEN_BIT_MASK(s, n) (((1ul << (n)) - 1) << (s)) + +// Merge bits b into a according to mask +#define MERGE_BITS(a, b, mask) ((a) ^ (((a) ^ (b)) & (mask))) + +#define STRUCT_CLEAR(s) (memset(&(s), 0, sizeof(s))) +#define BIT_REVERSE(x) CMN_BitRevLUT[(uint8)(x)] + +#define STR(x) STR_(x) +#define STR_(x) #x + +extern const uint8 CMN_BitRevLUT[]; +void PrintArray(char const *Prefix, uint8 const *Array, unsigned Size, BOOL Hex); +uint32 GetImagePixel(Image_t *Image, int x, int y); +uint32 Next2Power(uint32 Value); +unsigned Hex2BinArray(char *HexStr, unsigned Size, uint8 *BinArray); +int TrimString(char const *Input, char *Output); +int WriteTextToFile(char const *File, int Num, char const *Text); +int ReadTextFromFile(char const *File, int Num, char *Text, int Len); +BOOL FileExist(char const *File, int Num); + +#ifdef __cplusplus +} +#endif + + +#endif /* COMMON_H_ */ diff --git a/Lib/projector/LC4500API/hid.Win.c b/Lib/projector/LC4500API/hid.Win.c new file mode 100644 index 0000000..4b0465b --- /dev/null +++ b/Lib/projector/LC4500API/hid.Win.c @@ -0,0 +1,936 @@ +/******************************************************* + HIDAPI - Multi-Platform library for + communication with HID devices. + Alan Ott + Signal 11 Software + 8/22/2009 + Copyright 2009, All Rights Reserved. + + At the discretion of the user of this library, + this software may be licensed under the terms of the + GNU General Public License v3, a BSD-Style license, or the + original HIDAPI license as outlined in the LICENSE.txt, + LICENSE-gpl3.txt, LICENSE-bsd.txt, and LICENSE-orig.txt + files located at the root of the source distribution. + These files may also be found in the public source + code repository located at: + http://github.com/signal11/hidapi . +********************************************************/ + +#include + +#ifndef _NTDEF_ +typedef LONG NTSTATUS; +#endif + +#ifdef __MINGW32__ +#include +#include +#endif + +#ifdef __CYGWIN__ +#include +#define _wcsdup wcsdup +#endif + +/*#define HIDAPI_USE_DDK*/ + +#ifdef __cplusplus +extern "C" { +#endif + #include + #include + #ifdef HIDAPI_USE_DDK + #include + #endif + + /* Copied from inc/ddk/hidclass.h, part of the Windows DDK. */ + #define HID_OUT_CTL_CODE(id) \ + CTL_CODE(FILE_DEVICE_KEYBOARD, (id), METHOD_OUT_DIRECT, FILE_ANY_ACCESS) + #define IOCTL_HID_GET_FEATURE HID_OUT_CTL_CODE(100) + +#ifdef __cplusplus +} /* extern "C" */ +#endif + +#include +#include + + +#include "hidapi.h" + +#ifdef _MSC_VER + /* Thanks Microsoft, but I know how to use strncpy(). */ + #pragma warning(disable:4996) +#endif + +#ifdef __cplusplus +extern "C" { +#endif + +#ifndef HIDAPI_USE_DDK + /* Since we're not building with the DDK, and the HID header + files aren't part of the SDK, we have to define all this + stuff here. In lookup_functions(), the function pointers + defined below are set. */ + typedef struct _HIDD_ATTRIBUTES{ + ULONG Size; + USHORT VendorID; + USHORT ProductID; + USHORT VersionNumber; + } HIDD_ATTRIBUTES, *PHIDD_ATTRIBUTES; + + typedef USHORT USAGE; + typedef struct _HIDP_CAPS { + USAGE Usage; + USAGE UsagePage; + USHORT InputReportByteLength; + USHORT OutputReportByteLength; + USHORT FeatureReportByteLength; + USHORT Reserved[17]; + USHORT fields_not_used_by_hidapi[10]; + } HIDP_CAPS, *PHIDP_CAPS; + typedef void* PHIDP_PREPARSED_DATA; + #define HIDP_STATUS_SUCCESS 0x110000 + + typedef BOOLEAN (__stdcall *HidD_GetAttributes_)(HANDLE device, PHIDD_ATTRIBUTES attrib); + typedef BOOLEAN (__stdcall *HidD_GetSerialNumberString_)(HANDLE device, PVOID buffer, ULONG buffer_len); + typedef BOOLEAN (__stdcall *HidD_GetManufacturerString_)(HANDLE handle, PVOID buffer, ULONG buffer_len); + typedef BOOLEAN (__stdcall *HidD_GetProductString_)(HANDLE handle, PVOID buffer, ULONG buffer_len); + typedef BOOLEAN (__stdcall *HidD_SetFeature_)(HANDLE handle, PVOID data, ULONG length); + typedef BOOLEAN (__stdcall *HidD_GetFeature_)(HANDLE handle, PVOID data, ULONG length); + typedef BOOLEAN (__stdcall *HidD_GetIndexedString_)(HANDLE handle, ULONG string_index, PVOID buffer, ULONG buffer_len); + typedef BOOLEAN (__stdcall *HidD_GetPreparsedData_)(HANDLE handle, PHIDP_PREPARSED_DATA *preparsed_data); + typedef BOOLEAN (__stdcall *HidD_FreePreparsedData_)(PHIDP_PREPARSED_DATA preparsed_data); + typedef NTSTATUS (__stdcall *HidP_GetCaps_)(PHIDP_PREPARSED_DATA preparsed_data, HIDP_CAPS *caps); + typedef BOOLEAN (__stdcall *HidD_SetNumInputBuffers_)(HANDLE handle, ULONG number_buffers); + + static HidD_GetAttributes_ HidD_GetAttributes; + static HidD_GetSerialNumberString_ HidD_GetSerialNumberString; + static HidD_GetManufacturerString_ HidD_GetManufacturerString; + static HidD_GetProductString_ HidD_GetProductString; + static HidD_SetFeature_ HidD_SetFeature; + static HidD_GetFeature_ HidD_GetFeature; + static HidD_GetIndexedString_ HidD_GetIndexedString; + static HidD_GetPreparsedData_ HidD_GetPreparsedData; + static HidD_FreePreparsedData_ HidD_FreePreparsedData; + static HidP_GetCaps_ HidP_GetCaps; + static HidD_SetNumInputBuffers_ HidD_SetNumInputBuffers; + + static HMODULE lib_handle = NULL; + static BOOLEAN initialized = FALSE; +#endif /* HIDAPI_USE_DDK */ + +struct hid_device_ { + HANDLE device_handle; + BOOL blocking; + USHORT output_report_length; + size_t input_report_length; + void *last_error_str; + DWORD last_error_num; + BOOL read_pending; + char *read_buf; + OVERLAPPED ol; +}; + +static hid_device *new_hid_device() +{ + hid_device *dev = (hid_device*) calloc(1, sizeof(hid_device)); + dev->device_handle = INVALID_HANDLE_VALUE; + dev->blocking = TRUE; + dev->output_report_length = 0; + dev->input_report_length = 0; + dev->last_error_str = NULL; + dev->last_error_num = 0; + dev->read_pending = FALSE; + dev->read_buf = NULL; + memset(&dev->ol, 0, sizeof(dev->ol)); + dev->ol.hEvent = CreateEvent(NULL, FALSE, FALSE /*inital state f=nonsignaled*/, NULL); + + return dev; +} + +static void free_hid_device(hid_device *dev) +{ + CloseHandle(dev->ol.hEvent); + CloseHandle(dev->device_handle); + LocalFree(dev->last_error_str); + free(dev->read_buf); + free(dev); +} + +static void register_error(hid_device *device, const char *op) +{ + WCHAR *ptr, *msg; + + FormatMessageW(FORMAT_MESSAGE_ALLOCATE_BUFFER | + FORMAT_MESSAGE_FROM_SYSTEM | + FORMAT_MESSAGE_IGNORE_INSERTS, + NULL, + GetLastError(), + MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT), + (LPVOID)&msg, 0/*sz*/, + NULL); + + /* Get rid of the CR and LF that FormatMessage() sticks at the + end of the message. Thanks Microsoft! */ + ptr = msg; + while (*ptr) { + if (*ptr == '\r') { + *ptr = 0x0000; + break; + } + ptr++; + } + + /* Store the message off in the Device entry so that + the hid_error() function can pick it up. */ + LocalFree(device->last_error_str); + device->last_error_str = msg; +} + +#ifndef HIDAPI_USE_DDK +static int lookup_functions() +{ + lib_handle = LoadLibraryA("hid.dll"); + if (lib_handle) { +#define RESOLVE(x) x = (x##_)GetProcAddress(lib_handle, #x); if (!x) return -1; + RESOLVE(HidD_GetAttributes); + RESOLVE(HidD_GetSerialNumberString); + RESOLVE(HidD_GetManufacturerString); + RESOLVE(HidD_GetProductString); + RESOLVE(HidD_SetFeature); + RESOLVE(HidD_GetFeature); + RESOLVE(HidD_GetIndexedString); + RESOLVE(HidD_GetPreparsedData); + RESOLVE(HidD_FreePreparsedData); + RESOLVE(HidP_GetCaps); + RESOLVE(HidD_SetNumInputBuffers); +#undef RESOLVE + } + else + return -1; + + return 0; +} +#endif + +static HANDLE open_device(const char *path, BOOL enumerate) +{ + HANDLE handle; + DWORD desired_access = (enumerate)? 0: (GENERIC_WRITE | GENERIC_READ); + DWORD share_mode = (enumerate)? + FILE_SHARE_READ|FILE_SHARE_WRITE: + FILE_SHARE_READ; + + handle = CreateFileA(path, + desired_access, + share_mode, + NULL, + OPEN_EXISTING, + FILE_FLAG_OVERLAPPED,/*FILE_ATTRIBUTE_NORMAL,*/ + 0); + + return handle; +} + +int HID_API_EXPORT hid_init(void) +{ +#ifndef HIDAPI_USE_DDK + if (!initialized) { + if (lookup_functions() < 0) { + hid_exit(); + return -1; + } + initialized = TRUE; + } +#endif + return 0; +} + +int HID_API_EXPORT hid_exit(void) +{ +#ifndef HIDAPI_USE_DDK + if (lib_handle) + FreeLibrary(lib_handle); + lib_handle = NULL; + initialized = FALSE; +#endif + return 0; +} + +struct hid_device_info HID_API_EXPORT * HID_API_CALL hid_enumerate(unsigned short vendor_id, unsigned short product_id) +{ + BOOL res; + struct hid_device_info *root = NULL; /* return object */ + struct hid_device_info *cur_dev = NULL; + + /* Windows objects for interacting with the driver. */ + GUID InterfaceClassGuid = {0x4d1e55b2, 0xf16f, 0x11cf, {0x88, 0xcb, 0x00, 0x11, 0x11, 0x00, 0x00, 0x30} }; + SP_DEVINFO_DATA devinfo_data; + SP_DEVICE_INTERFACE_DATA device_interface_data; + SP_DEVICE_INTERFACE_DETAIL_DATA_A *device_interface_detail_data = NULL; + HDEVINFO device_info_set = INVALID_HANDLE_VALUE; + int device_index = 0; + int i; + + if (hid_init() < 0) + return NULL; + + /* Initialize the Windows objects. */ + memset(&devinfo_data, 0x0, sizeof(devinfo_data)); + devinfo_data.cbSize = sizeof(SP_DEVINFO_DATA); + device_interface_data.cbSize = sizeof(SP_DEVICE_INTERFACE_DATA); + + /* Get information for all the devices belonging to the HID class. */ + device_info_set = SetupDiGetClassDevsA(&InterfaceClassGuid, NULL, NULL, DIGCF_PRESENT | DIGCF_DEVICEINTERFACE); + + /* Iterate over each device in the HID class, looking for the right one. */ + + for (;;) { + HANDLE write_handle = INVALID_HANDLE_VALUE; + DWORD required_size = 0; + HIDD_ATTRIBUTES attrib; + + res = SetupDiEnumDeviceInterfaces(device_info_set, + NULL, + &InterfaceClassGuid, + device_index, + &device_interface_data); + + if (!res) { + /* A return of FALSE from this function means that + there are no more devices. */ + break; + } + + /* Call with 0-sized detail size, and let the function + tell us how long the detail struct needs to be. The + size is put in &required_size. */ + res = SetupDiGetDeviceInterfaceDetailA(device_info_set, + &device_interface_data, + NULL, + 0, + &required_size, + NULL); + + /* Allocate a long enough structure for device_interface_detail_data. */ + device_interface_detail_data = (SP_DEVICE_INTERFACE_DETAIL_DATA_A*) malloc(required_size); + device_interface_detail_data->cbSize = sizeof(SP_DEVICE_INTERFACE_DETAIL_DATA_A); + + /* Get the detailed data for this device. The detail data gives us + the device path for this device, which is then passed into + CreateFile() to get a handle to the device. */ + res = SetupDiGetDeviceInterfaceDetailA(device_info_set, + &device_interface_data, + device_interface_detail_data, + required_size, + NULL, + NULL); + + if (!res) { + /* register_error(dev, "Unable to call SetupDiGetDeviceInterfaceDetail"); + Continue to the next device. */ + goto cont; + } + + /* Make sure this device is of Setup Class "HIDClass" and has a + driver bound to it. */ + for (i = 0; ; i++) { + char driver_name[256]; + + /* Populate devinfo_data. This function will return failure + when there are no more interfaces left. */ + res = SetupDiEnumDeviceInfo(device_info_set, i, &devinfo_data); + if (!res) + goto cont; + + res = SetupDiGetDeviceRegistryPropertyA(device_info_set, &devinfo_data, + SPDRP_CLASS, NULL, (PBYTE)driver_name, sizeof(driver_name), NULL); + if (!res) + goto cont; + + if (strcmp(driver_name, "HIDClass") == 0) { + /* See if there's a driver bound. */ + res = SetupDiGetDeviceRegistryPropertyA(device_info_set, &devinfo_data, + SPDRP_DRIVER, NULL, (PBYTE)driver_name, sizeof(driver_name), NULL); + if (res) + break; + } + } + + //wprintf(L"HandleName: %s\n", device_interface_detail_data->DevicePath); + + /* Open a handle to the device */ + write_handle = open_device(device_interface_detail_data->DevicePath, TRUE); + + /* Check validity of write_handle. */ + if (write_handle == INVALID_HANDLE_VALUE) { + /* Unable to open the device. */ + //register_error(dev, "CreateFile"); + goto cont_close; + } + + + /* Get the Vendor ID and Product ID for this device. */ + attrib.Size = sizeof(HIDD_ATTRIBUTES); + HidD_GetAttributes(write_handle, &attrib); + //wprintf(L"Product/Vendor: %x %x\n", attrib.ProductID, attrib.VendorID); + + /* Check the VID/PID to see if we should add this + device to the enumeration list. */ + if ((vendor_id == 0x0 || attrib.VendorID == vendor_id) && + (product_id == 0x0 || attrib.ProductID == product_id)) { + + #define WSTR_LEN 512 + const char *str; + struct hid_device_info *tmp; + PHIDP_PREPARSED_DATA pp_data = NULL; + HIDP_CAPS caps; + BOOLEAN res; + NTSTATUS nt_res; + wchar_t wstr[WSTR_LEN]; /* TODO: Determine Size */ + size_t len; + + /* VID/PID match. Create the record. */ + tmp = (struct hid_device_info*) calloc(1, sizeof(struct hid_device_info)); + if (cur_dev) { + cur_dev->next = tmp; + } + else { + root = tmp; + } + cur_dev = tmp; + + /* Get the Usage Page and Usage for this device. */ + res = HidD_GetPreparsedData(write_handle, &pp_data); + if (res) { + nt_res = HidP_GetCaps(pp_data, &caps); + if (nt_res == HIDP_STATUS_SUCCESS) { + cur_dev->usage_page = caps.UsagePage; + cur_dev->usage = caps.Usage; + } + + HidD_FreePreparsedData(pp_data); + } + + /* Fill out the record */ + cur_dev->next = NULL; + str = device_interface_detail_data->DevicePath; + if (str) { + len = strlen(str); + cur_dev->path = (char*) calloc(len+1, sizeof(char)); + strncpy(cur_dev->path, str, len+1); + cur_dev->path[len] = '\0'; + } + else + cur_dev->path = NULL; + + /* Serial Number */ + res = HidD_GetSerialNumberString(write_handle, wstr, sizeof(wstr)); + wstr[WSTR_LEN-1] = 0x0000; + if (res) { + cur_dev->serial_number = _wcsdup(wstr); + } + + /* Manufacturer String */ + res = HidD_GetManufacturerString(write_handle, wstr, sizeof(wstr)); + wstr[WSTR_LEN-1] = 0x0000; + if (res) { + cur_dev->manufacturer_string = _wcsdup(wstr); + } + + /* Product String */ + res = HidD_GetProductString(write_handle, wstr, sizeof(wstr)); + wstr[WSTR_LEN-1] = 0x0000; + if (res) { + cur_dev->product_string = _wcsdup(wstr); + } + + /* VID/PID */ + cur_dev->vendor_id = attrib.VendorID; + cur_dev->product_id = attrib.ProductID; + + /* Release Number */ + cur_dev->release_number = attrib.VersionNumber; + + /* Interface Number. It can sometimes be parsed out of the path + on Windows if a device has multiple interfaces. See + http://msdn.microsoft.com/en-us/windows/hardware/gg487473 or + search for "Hardware IDs for HID Devices" at MSDN. If it's not + in the path, it's set to -1. */ + cur_dev->interface_number = -1; + if (cur_dev->path) { + char *interface_component = strstr(cur_dev->path, "&mi_"); + if (interface_component) { + char *hex_str = interface_component + 4; + char *endptr = NULL; + cur_dev->interface_number = strtol(hex_str, &endptr, 16); + if (endptr == hex_str) { + /* The parsing failed. Set interface_number to -1. */ + cur_dev->interface_number = -1; + } + } + } + } + +cont_close: + CloseHandle(write_handle); +cont: + /* We no longer need the detail data. It can be freed */ + free(device_interface_detail_data); + + device_index++; + + } + + /* Close the device information handle. */ + SetupDiDestroyDeviceInfoList(device_info_set); + + return root; + +} + +void HID_API_EXPORT HID_API_CALL hid_free_enumeration(struct hid_device_info *devs) +{ + /* TODO: Merge this with the Linux version. This function is platform-independent. */ + struct hid_device_info *d = devs; + while (d) { + struct hid_device_info *next = d->next; + free(d->path); + free(d->serial_number); + free(d->manufacturer_string); + free(d->product_string); + free(d); + d = next; + } +} + + +HID_API_EXPORT hid_device * HID_API_CALL hid_open(unsigned short vendor_id, unsigned short product_id, const wchar_t *serial_number) +{ + /* TODO: Merge this functions with the Linux version. This function should be platform independent. */ + struct hid_device_info *devs, *cur_dev; + const char *path_to_open = NULL; + hid_device *handle = NULL; + + devs = hid_enumerate(vendor_id, product_id); + cur_dev = devs; + while (cur_dev) { + if (cur_dev->vendor_id == vendor_id && + cur_dev->product_id == product_id) { + if (serial_number) { + if (wcscmp(serial_number, cur_dev->serial_number) == 0) { + path_to_open = cur_dev->path; + break; + } + } + else { + path_to_open = cur_dev->path; + break; + } + } + cur_dev = cur_dev->next; + } + + if (path_to_open) { + /* Open the device */ + handle = hid_open_path(path_to_open); + } + + hid_free_enumeration(devs); + + return handle; +} + +HID_API_EXPORT hid_device * HID_API_CALL hid_open_path(const char *path) +{ + hid_device *dev; + HIDP_CAPS caps; + PHIDP_PREPARSED_DATA pp_data = NULL; + BOOLEAN res; + NTSTATUS nt_res; + + if (hid_init() < 0) { + return NULL; + } + + dev = new_hid_device(); + + /* Open a handle to the device */ + dev->device_handle = open_device(path, FALSE); + + /* Check validity of write_handle. */ + if (dev->device_handle == INVALID_HANDLE_VALUE) { + /* Unable to open the device. */ + register_error(dev, "CreateFile"); + goto err; + } + + /* Set the Input Report buffer size to 64 reports. */ + res = HidD_SetNumInputBuffers(dev->device_handle, 64); + if (!res) { + register_error(dev, "HidD_SetNumInputBuffers"); + goto err; + } + + /* Get the Input Report length for the device. */ + res = HidD_GetPreparsedData(dev->device_handle, &pp_data); + if (!res) { + register_error(dev, "HidD_GetPreparsedData"); + goto err; + } + nt_res = HidP_GetCaps(pp_data, &caps); + if (nt_res != HIDP_STATUS_SUCCESS) { + register_error(dev, "HidP_GetCaps"); + goto err_pp_data; + } + dev->output_report_length = caps.OutputReportByteLength; + dev->input_report_length = caps.InputReportByteLength; + HidD_FreePreparsedData(pp_data); + + dev->read_buf = (char*) malloc(dev->input_report_length); + + return dev; + +err_pp_data: + HidD_FreePreparsedData(pp_data); +err: + free_hid_device(dev); + return NULL; +} + +int HID_API_EXPORT HID_API_CALL hid_write(hid_device *dev, const unsigned char *data, size_t length) +{ + DWORD bytes_written; + BOOL res; + + OVERLAPPED ol; + unsigned char *buf; + memset(&ol, 0, sizeof(ol)); + + /* Make sure the right number of bytes are passed to WriteFile. Windows + expects the number of bytes which are in the _longest_ report (plus + one for the report number) bytes even if the data is a report + which is shorter than that. Windows gives us this value in + caps.OutputReportByteLength. If a user passes in fewer bytes than this, + create a temporary buffer which is the proper size. */ + if (length >= dev->output_report_length) { + /* The user passed the right number of bytes. Use the buffer as-is. */ + buf = (unsigned char *) data; + } else { + /* Create a temporary buffer and copy the user's data + into it, padding the rest with zeros. */ + buf = (unsigned char *) malloc(dev->output_report_length); + memcpy(buf, data, length); + memset(buf + length, 0, dev->output_report_length - length); + length = dev->output_report_length; + } + + res = WriteFile(dev->device_handle, buf, length, NULL, &ol); + + if (!res) { + if (GetLastError() != ERROR_IO_PENDING) { + /* WriteFile() failed. Return error. */ + register_error(dev, "WriteFile"); + bytes_written = -1; + goto end_of_function; + } + } + + /* Wait here until the write is done. This makes + hid_write() synchronous. */ + res = GetOverlappedResult(dev->device_handle, &ol, &bytes_written, TRUE/*wait*/); + if (!res) { + /* The Write operation failed. */ + register_error(dev, "WriteFile"); + bytes_written = -1; + goto end_of_function; + } + +end_of_function: + if (buf != data) + free(buf); + + return bytes_written; +} + + +int HID_API_EXPORT HID_API_CALL hid_read_timeout(hid_device *dev, unsigned char *data, size_t length, int milliseconds) +{ + DWORD bytes_read = 0; + size_t copy_len = 0; + BOOL res; + + /* Copy the handle for convenience. */ + HANDLE ev = dev->ol.hEvent; + + if (!dev->read_pending) { + /* Start an Overlapped I/O read. */ + dev->read_pending = TRUE; + memset(dev->read_buf, 0, dev->input_report_length); + ResetEvent(ev); + res = ReadFile(dev->device_handle, dev->read_buf, dev->input_report_length, &bytes_read, &dev->ol); + + if (!res) { + if (GetLastError() != ERROR_IO_PENDING) { + /* ReadFile() has failed. + Clean up and return error. */ + CancelIo(dev->device_handle); + dev->read_pending = FALSE; + goto end_of_function; + } + } + } + + if (milliseconds >= 0) { + /* See if there is any data yet. */ + res = WaitForSingleObject(ev, milliseconds); + if (res != WAIT_OBJECT_0) { + /* There was no data this time. Return zero bytes available, + but leave the Overlapped I/O running. */ + return 0; + } + } + + /* Either WaitForSingleObject() told us that ReadFile has completed, or + we are in non-blocking mode. Get the number of bytes read. The actual + data has been copied to the data[] array which was passed to ReadFile(). */ + res = GetOverlappedResult(dev->device_handle, &dev->ol, &bytes_read, TRUE/*wait*/); + + /* Set pending back to false, even if GetOverlappedResult() returned error. */ + dev->read_pending = FALSE; + + if (res && bytes_read > 0) { + if (dev->read_buf[0] == 0x0) { + /* If report numbers aren't being used, but Windows sticks a report + number (0x0) on the beginning of the report anyway. To make this + work like the other platforms, and to make it work more like the + HID spec, we'll skip over this byte. */ + bytes_read--; + copy_len = length > bytes_read ? bytes_read : length; + memcpy(data, dev->read_buf+1, copy_len); + } + else { + /* Copy the whole buffer, report number and all. */ + copy_len = length > bytes_read ? bytes_read : length; + memcpy(data, dev->read_buf, copy_len); + } + } + +end_of_function: + if (!res) { + register_error(dev, "GetOverlappedResult"); + return -1; + } + + return copy_len; +} + +int HID_API_EXPORT HID_API_CALL hid_read(hid_device *dev, unsigned char *data, size_t length) +{ + return hid_read_timeout(dev, data, length, (dev->blocking)? -1: 0); +} + +int HID_API_EXPORT HID_API_CALL hid_set_nonblocking(hid_device *dev, int nonblock) +{ + dev->blocking = !nonblock; + return 0; /* Success */ +} + +int HID_API_EXPORT HID_API_CALL hid_send_feature_report(hid_device *dev, const unsigned char *data, size_t length) +{ + BOOL res = HidD_SetFeature(dev->device_handle, (PVOID)data, length); + if (!res) { + register_error(dev, "HidD_SetFeature"); + return -1; + } + + return length; +} + + +int HID_API_EXPORT HID_API_CALL hid_get_feature_report(hid_device *dev, unsigned char *data, size_t length) +{ + BOOL res; +#if 0 + res = HidD_GetFeature(dev->device_handle, data, length); + if (!res) { + register_error(dev, "HidD_GetFeature"); + return -1; + } + return 0; /* HidD_GetFeature() doesn't give us an actual length, unfortunately */ +#else + DWORD bytes_returned; + + OVERLAPPED ol; + memset(&ol, 0, sizeof(ol)); + + res = DeviceIoControl(dev->device_handle, + IOCTL_HID_GET_FEATURE, + data, length, + data, length, + &bytes_returned, &ol); + + if (!res) { + if (GetLastError() != ERROR_IO_PENDING) { + /* DeviceIoControl() failed. Return error. */ + register_error(dev, "Send Feature Report DeviceIoControl"); + return -1; + } + } + + /* Wait here until the write is done. This makes + hid_get_feature_report() synchronous. */ + res = GetOverlappedResult(dev->device_handle, &ol, &bytes_returned, TRUE/*wait*/); + if (!res) { + /* The operation failed. */ + register_error(dev, "Send Feature Report GetOverLappedResult"); + return -1; + } + + /* bytes_returned does not include the first byte which contains the + report ID. The data buffer actually contains one more byte than + bytes_returned. */ + bytes_returned++; + + return bytes_returned; +#endif +} + +void HID_API_EXPORT HID_API_CALL hid_close(hid_device *dev) +{ + if (!dev) + return; + CancelIo(dev->device_handle); + free_hid_device(dev); +} + +int HID_API_EXPORT_CALL HID_API_CALL hid_get_manufacturer_string(hid_device *dev, wchar_t *string, size_t maxlen) +{ + BOOL res; + + res = HidD_GetManufacturerString(dev->device_handle, string, sizeof(wchar_t) * maxlen); + if (!res) { + register_error(dev, "HidD_GetManufacturerString"); + return -1; + } + + return 0; +} + +int HID_API_EXPORT_CALL HID_API_CALL hid_get_product_string(hid_device *dev, wchar_t *string, size_t maxlen) +{ + BOOL res; + + res = HidD_GetProductString(dev->device_handle, string, sizeof(wchar_t) * maxlen); + if (!res) { + register_error(dev, "HidD_GetProductString"); + return -1; + } + + return 0; +} + +int HID_API_EXPORT_CALL HID_API_CALL hid_get_serial_number_string(hid_device *dev, wchar_t *string, size_t maxlen) +{ + BOOL res; + + res = HidD_GetSerialNumberString(dev->device_handle, string, sizeof(wchar_t) * maxlen); + if (!res) { + register_error(dev, "HidD_GetSerialNumberString"); + return -1; + } + + return 0; +} + +int HID_API_EXPORT_CALL HID_API_CALL hid_get_indexed_string(hid_device *dev, int string_index, wchar_t *string, size_t maxlen) +{ + BOOL res; + + res = HidD_GetIndexedString(dev->device_handle, string_index, string, sizeof(wchar_t) * maxlen); + if (!res) { + register_error(dev, "HidD_GetIndexedString"); + return -1; + } + + return 0; +} + + +HID_API_EXPORT const wchar_t * HID_API_CALL hid_error(hid_device *dev) +{ + return (wchar_t*)dev->last_error_str; +} + + +/*#define PICPGM*/ +/*#define S11*/ +#define P32 +#ifdef S11 + unsigned short VendorID = 0xa0a0; + unsigned short ProductID = 0x0001; +#endif + +#ifdef P32 + unsigned short VendorID = 0x04d8; + unsigned short ProductID = 0x3f; +#endif + + +#ifdef PICPGM + unsigned short VendorID = 0x04d8; + unsigned short ProductID = 0x0033; +#endif + + +#if 0 +int __cdecl main(int argc, char* argv[]) +{ + int res; + unsigned char buf[65]; + + UNREFERENCED_PARAMETER(argc); + UNREFERENCED_PARAMETER(argv); + + /* Set up the command buffer. */ + memset(buf,0x00,sizeof(buf)); + buf[0] = 0; + buf[1] = 0x81; + + + /* Open the device. */ + int handle = open(VendorID, ProductID, L"12345"); + if (handle < 0) + printf("unable to open device\n"); + + + /* Toggle LED (cmd 0x80) */ + buf[1] = 0x80; + res = write(handle, buf, 65); + if (res < 0) + printf("Unable to write()\n"); + + /* Request state (cmd 0x81) */ + buf[1] = 0x81; + write(handle, buf, 65); + if (res < 0) + printf("Unable to write() (2)\n"); + + /* Read requested state */ + read(handle, buf, 65); + if (res < 0) + printf("Unable to read()\n"); + + /* Print out the returned buffer. */ + for (int i = 0; i < 4; i++) + printf("buf[%d]: %d\n", i, buf[i]); + + return 0; +} +#endif + +#ifdef __cplusplus +} /* extern "C" */ +#endif diff --git a/Lib/projector/LC4500API/hidapi.h b/Lib/projector/LC4500API/hidapi.h new file mode 100644 index 0000000..e58e8a4 --- /dev/null +++ b/Lib/projector/LC4500API/hidapi.h @@ -0,0 +1,385 @@ +/******************************************************* + HIDAPI - Multi-Platform library for + communication with HID devices. + + Alan Ott + Signal 11 Software + + 8/22/2009 + + Copyright 2009, All Rights Reserved. + + At the discretion of the user of this library, + this software may be licensed under the terms of the + GNU Public License v3, a BSD-Style license, or the + original HIDAPI license as outlined in the LICENSE.txt, + LICENSE-gpl3.txt, LICENSE-bsd.txt, and LICENSE-orig.txt + files located at the root of the source distribution. + These files may also be found in the public source + code repository located at: + http://github.com/signal11/hidapi . +********************************************************/ + +/** @file + * @defgroup API hidapi API + */ + +#ifndef HIDAPI_H__ +#define HIDAPI_H__ + +#include + +#ifdef _WIN32 + #define HID_API_EXPORT __declspec(dllexport) + #define HID_API_CALL +#else + #define HID_API_EXPORT /**< API export macro */ + #define HID_API_CALL /**< API call macro */ +#endif + +#define HID_API_EXPORT_CALL HID_API_EXPORT HID_API_CALL /**< API export and call macro*/ + +#ifdef __cplusplus +extern "C" { +#endif + struct hid_device_; + typedef struct hid_device_ hid_device; /**< opaque hidapi structure */ + + /** hidapi info structure */ + struct hid_device_info { + /** Platform-specific device path */ + char *path; + /** Device Vendor ID */ + unsigned short vendor_id; + /** Device Product ID */ + unsigned short product_id; + /** Serial Number */ + wchar_t *serial_number; + /** Device Release Number in binary-coded decimal, + also known as Device Version Number */ + unsigned short release_number; + /** Manufacturer String */ + wchar_t *manufacturer_string; + /** Product string */ + wchar_t *product_string; + /** Usage Page for this Device/Interface + (Windows/Mac only). */ + unsigned short usage_page; + /** Usage for this Device/Interface + (Windows/Mac only).*/ + unsigned short usage; + /** The USB interface which this logical device + represents. Valid on both Linux implementations + in all cases, and valid on the Windows implementation + only if the device contains more than one interface. */ + int interface_number; + + /** Pointer to the next device */ + struct hid_device_info *next; + }; + + + /** @brief Initialize the HIDAPI library. + + This function initializes the HIDAPI library. Calling it is not + strictly necessary, as it will be called automatically by + hid_enumerate() and any of the hid_open_*() functions if it is + needed. This function should be called at the beginning of + execution however, if there is a chance of HIDAPI handles + being opened by different threads simultaneously. + + @ingroup API + + @returns + This function returns 0 on success and -1 on error. + */ + int HID_API_EXPORT HID_API_CALL hid_init(void); + + /** @brief Finalize the HIDAPI library. + + This function frees all of the static data associated with + HIDAPI. It should be called at the end of execution to avoid + memory leaks. + + @ingroup API + + @returns + This function returns 0 on success and -1 on error. + */ + int HID_API_EXPORT HID_API_CALL hid_exit(void); + + /** @brief Enumerate the HID Devices. + + This function returns a linked list of all the HID devices + attached to the system which match vendor_id and product_id. + If @p vendor_id is set to 0 then any vendor matches. + If @p product_id is set to 0 then any product matches. + If @p vendor_id and @p product_id are both set to 0, then + all HID devices will be returned. + + @ingroup API + @param vendor_id The Vendor ID (VID) of the types of device + to open. + @param product_id The Product ID (PID) of the types of + device to open. + + @returns + This function returns a pointer to a linked list of type + struct #hid_device, containing information about the HID devices + attached to the system, or NULL in the case of failure. Free + this linked list by calling hid_free_enumeration(). + */ + struct hid_device_info HID_API_EXPORT * HID_API_CALL hid_enumerate(unsigned short vendor_id, unsigned short product_id); + + /** @brief Free an enumeration Linked List + + This function frees a linked list created by hid_enumerate(). + + @ingroup API + @param devs Pointer to a list of struct_device returned from + hid_enumerate(). + */ + void HID_API_EXPORT HID_API_CALL hid_free_enumeration(struct hid_device_info *devs); + + /** @brief Open a HID device using a Vendor ID (VID), Product ID + (PID) and optionally a serial number. + + If @p serial_number is NULL, the first device with the + specified VID and PID is opened. + + @ingroup API + @param vendor_id The Vendor ID (VID) of the device to open. + @param product_id The Product ID (PID) of the device to open. + @param serial_number The Serial Number of the device to open + (Optionally NULL). + + @returns + This function returns a pointer to a #hid_device object on + success or NULL on failure. + */ + HID_API_EXPORT hid_device * HID_API_CALL hid_open(unsigned short vendor_id, unsigned short product_id, const wchar_t *serial_number); + + /** @brief Open a HID device by its path name. + + The path name be determined by calling hid_enumerate(), or a + platform-specific path name can be used (eg: /dev/hidraw0 on + Linux). + + @ingroup API + @param path The path name of the device to open + + @returns + This function returns a pointer to a #hid_device object on + success or NULL on failure. + */ + HID_API_EXPORT hid_device * HID_API_CALL hid_open_path(const char *path); + + /** @brief Write an Output report to a HID device. + + The first byte of @p data[] must contain the Report ID. For + devices which only support a single report, this must be set + to 0x0. The remaining bytes contain the report data. Since + the Report ID is mandatory, calls to hid_write() will always + contain one more byte than the report contains. For example, + if a hid report is 16 bytes long, 17 bytes must be passed to + hid_write(), the Report ID (or 0x0, for devices with a + single report), followed by the report data (16 bytes). In + this example, the length passed in would be 17. + + hid_write() will send the data on the first OUT endpoint, if + one exists. If it does not, it will send the data through + the Control Endpoint (Endpoint 0). + + @ingroup API + @param device A device handle returned from hid_open(). + @param data The data to send, including the report number as + the first byte. + @param length The length in bytes of the data to send. + + @returns + This function returns the actual number of bytes written and + -1 on error. + */ + int HID_API_EXPORT HID_API_CALL hid_write(hid_device *device, const unsigned char *data, size_t length); + + /** @brief Read an Input report from a HID device with timeout. + + Input reports are returned + to the host through the INTERRUPT IN endpoint. The first byte will + contain the Report number if the device uses numbered reports. + + @ingroup API + @param device A device handle returned from hid_open(). + @param data A buffer to put the read data into. + @param length The number of bytes to read. For devices with + multiple reports, make sure to read an extra byte for + the report number. + @param milliseconds timeout in milliseconds or -1 for blocking wait. + + @returns + This function returns the actual number of bytes read and + -1 on error. + */ + int HID_API_EXPORT HID_API_CALL hid_read_timeout(hid_device *dev, unsigned char *data, size_t length, int milliseconds); + + /** @brief Read an Input report from a HID device. + + Input reports are returned + to the host through the INTERRUPT IN endpoint. The first byte will + contain the Report number if the device uses numbered reports. + + @ingroup API + @param device A device handle returned from hid_open(). + @param data A buffer to put the read data into. + @param length The number of bytes to read. For devices with + multiple reports, make sure to read an extra byte for + the report number. + + @returns + This function returns the actual number of bytes read and + -1 on error. + */ + int HID_API_EXPORT HID_API_CALL hid_read(hid_device *device, unsigned char *data, size_t length); + + /** @brief Set the device handle to be non-blocking. + + In non-blocking mode calls to hid_read() will return + immediately with a value of 0 if there is no data to be + read. In blocking mode, hid_read() will wait (block) until + there is data to read before returning. + + Nonblocking can be turned on and off at any time. + + @ingroup API + @param device A device handle returned from hid_open(). + @param nonblock enable or not the nonblocking reads + - 1 to enable nonblocking + - 0 to disable nonblocking. + + @returns + This function returns 0 on success and -1 on error. + */ + int HID_API_EXPORT HID_API_CALL hid_set_nonblocking(hid_device *device, int nonblock); + + /** @brief Send a Feature report to the device. + + Feature reports are sent over the Control endpoint as a + Set_Report transfer. The first byte of @p data[] must + contain the Report ID. For devices which only support a + single report, this must be set to 0x0. The remaining bytes + contain the report data. Since the Report ID is mandatory, + calls to hid_send_feature_report() will always contain one + more byte than the report contains. For example, if a hid + report is 16 bytes long, 17 bytes must be passed to + hid_send_feature_report(): the Report ID (or 0x0, for + devices which do not use numbered reports), followed by the + report data (16 bytes). In this example, the length passed + in would be 17. + + @ingroup API + @param device A device handle returned from hid_open(). + @param data The data to send, including the report number as + the first byte. + @param length The length in bytes of the data to send, including + the report number. + + @returns + This function returns the actual number of bytes written and + -1 on error. + */ + int HID_API_EXPORT HID_API_CALL hid_send_feature_report(hid_device *device, const unsigned char *data, size_t length); + + /** @brief Get a feature report from a HID device. + + Make sure to set the first byte of @p data[] to the Report + ID of the report to be read. Make sure to allow space for + this extra byte in @p data[]. + + @ingroup API + @param device A device handle returned from hid_open(). + @param data A buffer to put the read data into, including + the Report ID. Set the first byte of @p data[] to the + Report ID of the report to be read. + @param length The number of bytes to read, including an + extra byte for the report ID. The buffer can be longer + than the actual report. + + @returns + This function returns the number of bytes read and + -1 on error. + */ + int HID_API_EXPORT HID_API_CALL hid_get_feature_report(hid_device *device, unsigned char *data, size_t length); + + /** @brief Close a HID device. + + @ingroup API + @param device A device handle returned from hid_open(). + */ + void HID_API_EXPORT HID_API_CALL hid_close(hid_device *device); + + /** @brief Get The Manufacturer String from a HID device. + + @ingroup API + @param device A device handle returned from hid_open(). + @param string A wide string buffer to put the data into. + @param maxlen The length of the buffer in multiples of wchar_t. + + @returns + This function returns 0 on success and -1 on error. + */ + int HID_API_EXPORT_CALL hid_get_manufacturer_string(hid_device *device, wchar_t *string, size_t maxlen); + + /** @brief Get The Product String from a HID device. + + @ingroup API + @param device A device handle returned from hid_open(). + @param string A wide string buffer to put the data into. + @param maxlen The length of the buffer in multiples of wchar_t. + + @returns + This function returns 0 on success and -1 on error. + */ + int HID_API_EXPORT_CALL hid_get_product_string(hid_device *device, wchar_t *string, size_t maxlen); + + /** @brief Get The Serial Number String from a HID device. + + @ingroup API + @param device A device handle returned from hid_open(). + @param string A wide string buffer to put the data into. + @param maxlen The length of the buffer in multiples of wchar_t. + + @returns + This function returns 0 on success and -1 on error. + */ + int HID_API_EXPORT_CALL hid_get_serial_number_string(hid_device *device, wchar_t *string, size_t maxlen); + + /** @brief Get a string from a HID device, based on its string index. + + @ingroup API + @param device A device handle returned from hid_open(). + @param string_index The index of the string to get. + @param string A wide string buffer to put the data into. + @param maxlen The length of the buffer in multiples of wchar_t. + + @returns + This function returns 0 on success and -1 on error. + */ + int HID_API_EXPORT_CALL hid_get_indexed_string(hid_device *device, int string_index, wchar_t *string, size_t maxlen); + + /** @brief Get a string describing the last error which occurred. + + @ingroup API + @param device A device handle returned from hid_open(). + + @returns + This function returns a string containing the last error + which occurred or NULL if none has occurred. + */ + HID_API_EXPORT const wchar_t* HID_API_CALL hid_error(hid_device *device); + +#ifdef __cplusplus +} +#endif + +#endif + diff --git a/Lib/projector/LC4500API/usb.cpp b/Lib/projector/LC4500API/usb.cpp new file mode 100644 index 0000000..ab5b1bb --- /dev/null +++ b/Lib/projector/LC4500API/usb.cpp @@ -0,0 +1,85 @@ +/* + * usb.cpp + * + * This module has the wrapper functions to access USB driver functions. + * + * Copyright (C) 2013 Texas Instruments Incorporated - http://www.ti.com/ + * ALL RIGHTS RESERVED + * +*/ + +//#ifdef Q_OS_WIN32 +//#include +//#endif +//#include +//#include +#include "usb.h" +//#include +//#include +#include "hidapi.h" + +/*************************************************** +* GLOBAL VARIABLES +****************************************************/ +static hid_device *DeviceHandle; //Handle to write +//In/Out buffers equal to HID endpoint size + 1 +//First byte is for Windows internal use and it is always 0 +unsigned char OutputBuffer[USB_MAX_PACKET_SIZE+1]; +unsigned char InputBuffer[USB_MAX_PACKET_SIZE+1]; + +static bool USBConnected = false; //Boolean true when device is connected + +bool USB_IsConnected() +{ + return USBConnected; +} + +int USB_Init(void) +{ + return hid_init(); +} + +int USB_Exit(void) +{ + return hid_exit(); +} + +int USB_Open() +{ + // Open the device using the VID, PID, + // and optionally the Serial number. + DeviceHandle = hid_open(MY_VID, MY_PID, NULL); + + if(DeviceHandle == NULL) + { + USBConnected = false; + return -1; + } + USBConnected = true; + return 0; +} + +int USB_Write() +{ + if(DeviceHandle == NULL) + return -1; + + return hid_write(DeviceHandle, OutputBuffer, USB_MIN_PACKET_SIZE+1); + +} + +int USB_Read() +{ + if(DeviceHandle == NULL) + return -1; + + return hid_read_timeout(DeviceHandle, InputBuffer, USB_MIN_PACKET_SIZE+1, 2000); +} + +int USB_Close() +{ + hid_close(DeviceHandle); + USBConnected = false; + + return 0; +} diff --git a/Lib/projector/LC4500API/usb.h b/Lib/projector/LC4500API/usb.h new file mode 100644 index 0000000..5b464b7 --- /dev/null +++ b/Lib/projector/LC4500API/usb.h @@ -0,0 +1,28 @@ +/* + * usb.h + * + * This module has the wrapper functions to access USB driver functions. + * + * Copyright (C) 2013 Texas Instruments Incorporated - http://www.ti.com/ + * ALL RIGHTS RESERVED + * +*/ + +#ifndef USB_H +#define USB_H + +#define USB_MIN_PACKET_SIZE 64 +#define USB_MAX_PACKET_SIZE 64 + +#define MY_VID 0x0451 +#define MY_PID 0x6401 + +int USB_Open(void); +bool USB_IsConnected(); +int USB_Write(); +int USB_Read(); +int USB_Close(); +int USB_Init(); +int USB_Exit(); + +#endif //USB_H diff --git a/Lib/projector/Projector.h b/Lib/projector/Projector.h new file mode 100644 index 0000000..c304bf7 --- /dev/null +++ b/Lib/projector/Projector.h @@ -0,0 +1,24 @@ +#ifndef PROJECTOR_H +#define PROJECTOR_H + +#include +#include + +// Abstract Projector base class +class Projector { + public: + // Interface function + Projector(){} + // Define preset pattern sequence + virtual void setPattern(unsigned int patternNumber , const unsigned char *tex , unsigned int texWidth , unsigned int texHeight) = 0; + virtual void displayPattern(unsigned int patternNumber) = 0; + // Upload and display pattern on the fly + virtual void displayTexture(const unsigned char *tex , unsigned int width , unsigned int height) = 0; + // Monochrome color display + virtual void displayBlack() = 0; + virtual void displayWhite() = 0; + virtual void getScreenRes(unsigned int *nx , unsigned int *ny) = 0; + virtual ~Projector(){} +}; + +#endif diff --git a/Lib/projector/ProjectorLC4500.cpp b/Lib/projector/ProjectorLC4500.cpp new file mode 100644 index 0000000..6a6e959 --- /dev/null +++ b/Lib/projector/ProjectorLC4500.cpp @@ -0,0 +1,83 @@ +#include "ProjectorLC4500.h" + +#include + +#include "LC4500API/API.h" +#include "LC4500API/usb.h" + +void showError(std::string err){ + std::cerr << "lc4500startup: " << err.c_str() << std::endl; +} + + +ProjectorLC4500::ProjectorLC4500(unsigned int): nPatterns(0) , isRunning(false){ + + std::cout << "ProjectorLC4500: preparing LightCrafter 4500 for duty... " << std::endl; + + // Initialize usb connection + if(USB_Init()){ + showError("Could not init USB!"); + } + if(USB_Open()){ + showError("Could not connect!"); + } + if(!USB_IsConnected()){ + showError("Could not connect."); + } + + // Make sure LC is not in standby + const bool standby = false; + if(!LCR_SetPowerMode(standby)){ + showError("Error Setting Power Mode"); + } + + LCR_SetMode(false); + LCR_SetInputSource(2 , 0); + LCR_SetPixelFormat(0); +} + +void ProjectorLC4500::setPattern(unsigned int patternNumber , const unsigned char *tex , unsigned int texWidth ,unsigned int texHeight){ + +} + +void ProjectorLC4500::displayPattern(unsigned int PatNum){ + LCR_LoadSplash(PatNum); + rectangle croppedArea , displayArea; + croppedArea.firstPixel = 0; + croppedArea.firstLine = 0; + croppedArea.pixelsPerLine = 912; + croppedArea.linesPerFrame = 1140; + displayArea.firstPixel = 0; + displayArea.firstLine = 0; + displayArea.pixelsPerLine = 1280; + displayArea.linesPerFrame = 800; + LCR_SetDisplay(croppedArea , displayArea); +} + +void ProjectorLC4500::displayTexture(const unsigned char *tex , unsigned int texWidth , unsigned int texHeight){ + +} + +void ProjectorLC4500::displayBlack(){ + +} + +void ProjectorLC4500::displayWhite(){ + +} + +void ProjectorLC4500::getScreenRes(unsigned int *nx , unsigned int *ny){ + *nx = 912; + *ny = 1140; +} + +ProjectorLC4500::~ProjectorLC4500(){ + + // Stop pattern sequence + LCR_PatternDisplay(0); + + USB_Close(); + USB_Exit(); + +} + diff --git a/Lib/projector/ProjectorLC4500.h b/Lib/projector/ProjectorLC4500.h new file mode 100644 index 0000000..7f96e07 --- /dev/null +++ b/Lib/projector/ProjectorLC4500.h @@ -0,0 +1,29 @@ +#ifndef PROJECTORLC4500_H +#define PROJECTORLC4500_H + +#include +#include +#include + +#include "Projector.h" + +// Projecotr implementation for LightCrafter 4500 USB Api +class ProjectorLC4500 : public Projector { + public: + // Interface function + ProjectorLC4500(unsigned int); + // Define preset pattern sequence and upload to GPU + void setPattern(unsigned int patternNumber ,const unsigned char *tex ,unsigned int texWidth , unsigned int texHeight); + void displayPattern(unsigned int patternNumber); + // Upload and display pattern on the fly + void displayTexture(const unsigned char *tex , unsigned int width , unsigned int height); + void displayBlack(); + void displayWhite(); + void getScreenRes(unsigned int *nx , unsigned int *ny); + ~ProjectorLC4500(); + private: + unsigned int nPatterns; + bool isRunning; +}; + +#endif