Projects/AVRISP-MKII/Lib/V2ProtocolParams.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2020.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2020  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 V2ProtocolParams.c.
  34  */
  35
  36 #ifndef _V2_PROTOCOL_PARAMS_
  37 #define _V2_PROTOCOL_PARAMS_
  38
  39         /* Includes: */
  40                 #include <avr/io.h>
  41                 #include <avr/eeprom.h>
  42
  43                 #if defined(ADC)
  44                         #include <LUFA/Drivers/Peripheral/ADC.h>
  45                 #endif
  46
  47                 #include "V2Protocol.h"
  48                 #include "V2ProtocolConstants.h"
  49                 #include "ISP/ISPTarget.h"
  50                 #include "Config/AppConfig.h"
  51
  52         /* Macros: */
  53                 /** Parameter privilege mask to allow the host PC to read the parameter's value. */
  54                 #define PARAM_PRIV_READ     (1 << 0)
  55
  56                 /** Parameter privilege mask to allow the host PC to change the parameter's value. */
  57                 #define PARAM_PRIV_WRITE    (1 << 1)
  58
  59                 /** Total number of parameters in the parameter table */
  60                 #define TABLE_PARAM_COUNT   (sizeof(ParameterTable) / sizeof(ParameterTable[0]))
  61
  62                 #if (!defined(FIRMWARE_VERSION_MINOR) || defined(__DOXYGEN__))
  63                         /** Minor firmware version, reported to the host on request; must match the version
  64                          *  the host is expecting, or it (may) reject further communications with the programmer. */
  65                         #define FIRMWARE_VERSION_MINOR   0x18
  66                 #endif
  67
  68         /* Type Defines: */
  69                 /** Type define for a parameter table entry indicating a PC readable or writable device parameter. */
  70                 typedef struct
  71                 {
  72                         const uint8_t ParamID; /**< Parameter ID number to uniquely identify the parameter within the device */
  73                         const uint8_t ParamPrivileges;  /**< Parameter privileges to allow the host to read or write the parameter's value */
  74                         uint8_t ParamValue; /**< Current parameter's value within the device */
  75                 } ParameterItem_t;
  76
  77         /* Function Prototypes: */
  78                 void    V2Params_LoadNonVolatileParamValues(void);
  79                 void    V2Params_UpdateParamValues(void);
  80
  81                 uint8_t V2Params_GetParameterPrivileges(const uint8_t ParamID);
  82                 uint8_t V2Params_GetParameterValue(const uint8_t ParamID);
  83                 void    V2Params_SetParameterValue(const uint8_t ParamID,
  84                                                    const uint8_t Value);
  85
  86                 #if defined(INCLUDE_FROM_V2PROTOCOL_PARAMS_C)
  87                         static ParameterItem_t* const V2Params_GetParamFromTable(const uint8_t ParamID);
  88                 #endif
  89
  90 #endif
  91