tmk_core/protocol/lufa/LUFA-git/Demos/Host/LowLevel/StillImageHost/Lib/StillImageCommands.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2014.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2014  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaims all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 /** \file
  32  *
  33  *  Header file for StillImageCommands.c.
  34  */
  35
  36 #ifndef _STILL_IMAGE_COMMANDS_H_
  37 #define _STILL_IMAGE_COMMANDS_H_
  38
  39         /* Includes: */
  40                 #include <LUFA/Drivers/USB/USB.h>
  41
  42                 #include "PIMACodes.h"
  43                 #include "../StillImageHost.h"
  44
  45         /* Macros: */
  46                 /** Timeout period between the issuing of a command to a device, and the reception of the first packet. */
  47                 #define COMMAND_DATA_TIMEOUT_MS        10000
  48
  49         /* External Variables: */
  50                 extern PIMA_Container_t PIMA_SendBlock;
  51                 extern PIMA_Container_t PIMA_ReceivedBlock;
  52                 extern PIMA_Container_t PIMA_EventBlock;
  53
  54         /* Function Prototypes: */
  55                 void    SImage_SendBlockHeader(void);
  56                 uint8_t SImage_ReceiveBlockHeader(void);
  57                 uint8_t SImage_ReceiveEventHeader(void);
  58                 uint8_t SImage_SendData(void* const Buffer,
  59                                         const uint16_t Bytes);
  60                 uint8_t SImage_ReadData(void* const Buffer,
  61                                         const uint16_t Bytes);
  62                 bool    SImage_IsEventReceived(void);
  63
  64 #endif
  65