ipcam_packet.h

Go to the documentation of this file.

/*********************************************************************
* Software License Agreement (BSD License)
*
*  Copyright (c) 2009, 2010 Willow Garage, Inc.
*  All rights reserved.
*
*  Redistribution and use in source and binary forms, with or without
*  modification, are permitted provided that the following conditions
*  are met:
*
*   * Redistributions of source code must retain the above copyright
*     notice, this list of conditions and the following disclaimer.
*   * Redistributions in binary form must reproduce the above
*     copyright notice, this list of conditions and the following
*     disclaimer in the documentation and/or other materials provided
*     with the distribution.
*   * Neither the name of the Willow Garage nor the names of its
*     contributors may be used to endorse or promote products derived
*     from this software without specific prior written permission.
*
*  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
*  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
*  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
*  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
*  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
*  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
*  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
*  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
*  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
*  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
*  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
*  POSSIBILITY OF SUCH DAMAGE.
*********************************************************************/

#ifndef _IPCAM_PACKET_H_
#define _IPCAM_PACKET_H_

#include "build.h"

#ifdef DEVICE_BUILD
#warning Building for DEVICE

#include "ipcam.h"
#include "ipcam_network.h"
#include "ipcam_flash.h"

//Make sure that LIBRARY_BUILD isn't also defined (only one build type should be defined)
#ifdef LIBRARY_BUILD
#error Multiple builds defined
#endif

#endif //DEVICE_BUILD

#define FLASH_MAX_PAGENO 4095
#define FLASH_PAGE_SIZE 264

#define FLASH_NAME_PAGENO FLASH_MAX_PAGENO
#define FLASH_CALIBRATION_PAGENO (FLASH_MAX_PAGENO - 2)
#define CAMERA_NAME_LEN 40

#ifdef LIBRARY_BUILD
//#warning Building for LIBRARY

#include <sys/socket.h>
#include <netinet/in.h>
#include <arpa/inet.h>

// Simple typedefs for basic network types. These are defined in ipcam_network.h on the camera.
typedef uint32_t IPAddress;
typedef uint8_t MACAddress[6];
typedef uint16_t UDPPort;

typedef struct {
    MACAddress mac;
    IPAddress addr;
    UDPPort port;
} NetHost;

//Make sure that DEVICE_BUILD isn't also defined (only one build type should be defined)
#ifdef DEVICE_BUILD
#error Multiple builds defined
#endif

#endif //LIBRARY_BUILD

#define WG_MAGIC_NO 0x00DEAF42UL

#define WG_CAMCMD_PORT 1627

#define PKTT_DISCOVER      0
#define PKTT_CONFIGURE     1
#define PKTT_VIDSTART      2
#define PKTT_VIDSTOP       3
#define PKTT_RESET         4
#define PKTT_TIMEREQ       5
#define PKTT_FLASHREAD     6
#define PKTT_FLASHWRITE    7
#define PKTT_TRIGCTRL      8
#define PKTT_SENSORRD      9
#define PKTT_SENSORWR      10
#define PKTT_SENSORSEL     11
#define PKTT_IMGRMODE      12
#define PKTT_IMGRSETRES    13
#define PKTT_SYSCONFIG     14
#define PKTT_RECONFIG_FPGA 15
#define PKT_MAX_ID PKTT_RECONFIG_FPGA

#define PKTT_ANNOUNCE   0x80
#define PKTT_TIMEREPLY  0x81
#define PKTT_STATUS     0x82
#define PKTT_FLASHDATA  0x83
#define PKTT_SENSORDATA 0x84

 #if CAMERA_NAME_LEN != 40
 #error CAMERA_NAME_LEN should be 40.
 #endif

 typedef struct PACKED_ATTRIBUTE {
    char cam_name[CAMERA_NAME_LEN];  
    IPAddress cam_addr;                 
    uint16_t checksum;               
 } IdentityFlashPage;

typedef struct PACKED_ATTRIBUTE {
    uint32_t magic_no;      
    uint32_t type;          
    char hrt[16];           
    NetHost reply_to;       
} PacketGeneric;

#ifdef DEVICE_BUILD  // The host uses the Linux network stack so doesn't require this section

typedef struct PACKED_ATTRIBUTE {
    EMACHeader emacHdr;
    IPHeader ipHdr;
    UDPHeader udpHdr;
} NetHeader;


typedef struct PACKED_ATTRIBUTE {
    NetHeader hdr;
    PacketGeneric gPkt;
} GenericFrame;
#endif //DEVICE_BUILD

typedef struct PACKED_ATTRIBUTE {
    PacketGeneric hdr;

    IPAddress ip_addr;

} PacketDiscover;

typedef struct PACKED_ATTRIBUTE {
    PacketGeneric hdr;

    uint32_t product_id;        
    uint32_t ser_no;            

    uint32_t ip_addr;           

} PacketConfigure;


typedef struct PACKED_ATTRIBUTE {
    PacketGeneric hdr;

    NetHost receiver;           
} PacketVidStart;

typedef struct PACKED_ATTRIBUTE { PacketGeneric hdr; } PacketVidStop;

typedef struct PACKED_ATTRIBUTE { PacketGeneric hdr; } PacketReset;

typedef struct PACKED_ATTRIBUTE { PacketGeneric hdr; } PacketTimeRequest;

typedef struct PACKED_ATTRIBUTE {
    PacketGeneric hdr;

    uint32_t address;
} PacketFlashRequest;

typedef struct PACKED_ATTRIBUTE {
    PacketGeneric hdr;

    uint32_t address;                       
    uint8_t data[FLASH_PAGE_SIZE];          
} PacketFlashPayload;

typedef struct PACKED_ATTRIBUTE {
    PacketGeneric hdr;

    uint32_t trig_state;
} PacketTrigControl;

typedef struct PACKED_ATTRIBUTE {
    PacketGeneric hdr;

    uint8_t address;
} PacketSensorRequest;

typedef struct PACKED_ATTRIBUTE {
    PacketGeneric hdr;

    uint8_t address;            
    uint16_t data;              
} PacketSensorData;

typedef struct PACKED_ATTRIBUTE {
    PacketGeneric hdr;

    uint8_t index;          
    uint32_t address;       
} PacketSensorSelect;

typedef struct PACKED_ATTRIBUTE {
    PacketGeneric hdr;

    uint32_t mode;          
} PacketImagerMode;



typedef struct PACKED_ATTRIBUTE {
    PacketGeneric hdr;

    uint16_t horizontal;        
    uint16_t vertical;          
} PacketImagerSetRes;

typedef struct PACKED_ATTRIBUTE {
    PacketGeneric hdr;

    MACAddress mac;
    uint32_t serial;
} PacketSysConfig;

typedef struct PACKED_ATTRIBUTE { PacketGeneric hdr; } PacketReconfigureFPGA;

#define PKT_STATUST_OK      0           ///< Command completed successfully
#define PKT_STATUST_ERROR   1           ///< Command could not be completed. See status_code for details

#define PKT_ERROR_TIMEOUT   0           ///< No valid response was received during the allotted interval
#define PKT_ERROR_SYSERR    1           ///< An internal system error occurred
#define PKT_ERROR_INVALID   2           ///< Packet is not valid in this mode

typedef struct PACKED_ATTRIBUTE {
    PacketGeneric hdr;

    uint32_t status_type;               
    uint32_t status_code;               
} PacketStatus;


typedef struct PACKED_ATTRIBUTE {
    PacketGeneric hdr;

    uint32_t ticks_hi;              
    uint32_t ticks_lo;              

    uint32_t ticks_per_sec;         
} PacketTimer;

typedef struct PACKED_ATTRIBUTE {
    PacketGeneric hdr;

    MACAddress mac;                 
    uint32_t product_id;            
    uint32_t ser_no;                
    char product_name[40];          
    char camera_name[40];           
    IPAddress camera_ip;            

    uint32_t hw_version;

    uint32_t fw_version;

    struct in_addr prev_host;       

} PacketAnnounce;


#define IMAGER_MAGICLINE_MASK 0xFFF0

#define IMAGER_LINENO_EOF 0xFFFF

#define IMAGER_LINENO_ERR 0xFFFE

#define IMAGER_LINENO_OVF 0xFFFD

#define IMAGER_LINENO_ABORT 0xFFFC

#define IMAGER_LINENO_SHORT 0xFFFB

#define IMAGER_LINENO_XOR 0xFFFA


typedef struct PACKED_ATTRIBUTE {
      uint32_t frame_number;        
      uint16_t line_number;         
      uint16_t horiz_resolution;    
      uint16_t vert_resolution;     
} HeaderVideoLine;


typedef struct PACKED_ATTRIBUTE {
    HeaderVideoLine header;
    uint8_t data[752];
} PacketVideoLine;



#define I2C_REGS_PER_FRAME 4

typedef struct PACKED_ATTRIBUTE {
    HeaderVideoLine header;         

    uint32_t ticks_hi;              
    uint32_t ticks_lo;              

    uint32_t ticks_per_sec;         

    uint16_t i2c[I2C_REGS_PER_FRAME];   
    uint32_t i2c_valid;                 
} PacketEOF;


#define I2C_AUTO_REG_UNUSED ((uint32_t)-1)


#endif //_IPCAM_PACKET_H_