Add new tag for the LUFA-120219-BETA release.
[pub/USBasp.git] / Projects / AVRISP-MKII / Lib / V2ProtocolParams.c
index b8c5930..c9b305c 100644 (file)
@@ -1,21 +1,21 @@
 /*
              LUFA Library
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2010.
-              
+     Copyright (C) Dean Camera, 2012.
+
   dean [at] fourwalledcubicle [dot] com
   dean [at] fourwalledcubicle [dot] com
-      www.fourwalledcubicle.com
+           www.lufa-lib.org
 */
 
 /*
 */
 
 /*
-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2012  Dean Camera (dean [at] fourwalledcubicle [dot] com)
 
 
-  Permission to use, copy, modify, distribute, and sell this 
+  Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted
   software and its documentation for any purpose is hereby granted
-  without fee, provided that the above copyright notice appear in 
+  without fee, provided that the above copyright notice appear in
   all copies and that both that the copyright notice and this
   all copies and that both that the copyright notice and this
-  permission notice and warranty disclaimer appear in supporting 
-  documentation, and that the name of the author not be used in 
-  advertising or publicity pertaining to distribution of the 
+  permission notice and warranty disclaimer appear in supporting
+  documentation, and that the name of the author not be used in
+  advertising or publicity pertaining to distribution of the
   software without specific, written prior permission.
 
   The author disclaim all warranties with regard to this
   software without specific, written prior permission.
 
   The author disclaim all warranties with regard to this
 #include "V2ProtocolParams.h"
 
 /* Non-Volatile Parameter Values for EEPROM storage */
 #include "V2ProtocolParams.h"
 
 /* Non-Volatile Parameter Values for EEPROM storage */
-uint8_t EEMEM EEPROM_Rest_Polarity = 0x00;
+static uint8_t EEMEM EEPROM_Reset_Polarity = 0x00;
 
 /* Volatile Parameter Values for RAM storage */
 
 /* Volatile Parameter Values for RAM storage */
-static ParameterItem_t ParameterTable[] = 
+static ParameterItem_t ParameterTable[] =
        {
                { .ParamID          = PARAM_BUILD_NUMBER_LOW,
                  .ParamPrivileges  = PARAM_PRIV_READ,
        {
                { .ParamID          = PARAM_BUILD_NUMBER_LOW,
                  .ParamPrivileges  = PARAM_PRIV_READ,
-                 .ParamValue       = (LUFA_VERSION_INTEGER >> 8)        },
+                 .ParamValue       = 0                                  },
 
                { .ParamID          = PARAM_BUILD_NUMBER_HIGH,
                  .ParamPrivileges  = PARAM_PRIV_READ,
 
                { .ParamID          = PARAM_BUILD_NUMBER_HIGH,
                  .ParamPrivileges  = PARAM_PRIV_READ,
-                 .ParamValue       = (LUFA_VERSION_INTEGER & 0xFF),     },
+                 .ParamValue       = 0                                  },
 
                { .ParamID          = PARAM_HW_VER,
                  .ParamPrivileges  = PARAM_PRIV_READ,
 
                { .ParamID          = PARAM_HW_VER,
                  .ParamPrivileges  = PARAM_PRIV_READ,
@@ -68,18 +68,18 @@ static ParameterItem_t ParameterTable[] =
 
                { .ParamID          = PARAM_SCK_DURATION,
                  .ParamPrivileges  = PARAM_PRIV_READ | PARAM_PRIV_WRITE,
 
                { .ParamID          = PARAM_SCK_DURATION,
                  .ParamPrivileges  = PARAM_PRIV_READ | PARAM_PRIV_WRITE,
-                 .ParamValue       = (TOTAL_ISP_PROGRAMMING_SPEEDS - 1) },
+                 .ParamValue       = 6                                  },
 
                { .ParamID          = PARAM_RESET_POLARITY,
 
                { .ParamID          = PARAM_RESET_POLARITY,
-                 .ParamPrivileges  = PARAM_PRIV_WRITE,
-                 .ParamValue       = 0x00                               },
+                 .ParamPrivileges  = PARAM_PRIV_READ | PARAM_PRIV_WRITE,
+                 .ParamValue       = 0x01                               },
 
                { .ParamID          = PARAM_STATUS_TGT_CONN,
                  .ParamPrivileges  = PARAM_PRIV_READ,
                  .ParamValue       = STATUS_ISP_READY                   },
 
                { .ParamID          = PARAM_DISCHARGEDELAY,
 
                { .ParamID          = PARAM_STATUS_TGT_CONN,
                  .ParamPrivileges  = PARAM_PRIV_READ,
                  .ParamValue       = STATUS_ISP_READY                   },
 
                { .ParamID          = PARAM_DISCHARGEDELAY,
-                 .ParamPrivileges  = PARAM_PRIV_WRITE,
+                 .ParamPrivileges  = PARAM_PRIV_READ | PARAM_PRIV_WRITE,
                  .ParamValue       = 0x00                               },
        };
 
                  .ParamValue       = 0x00                               },
        };
 
@@ -87,9 +87,8 @@ static ParameterItem_t ParameterTable[] =
 /** Loads saved non-volatile parameter values from the EEPROM into the parameter table, as needed. */
 void V2Params_LoadNonVolatileParamValues(void)
 {
 /** Loads saved non-volatile parameter values from the EEPROM into the parameter table, as needed. */
 void V2Params_LoadNonVolatileParamValues(void)
 {
-       /* Target RESET line polarity is a non-volatile value, retrieve current parameter value from EEPROM -
-        *   NB: Cannot call V2Protocol_SetParameterValue() here, as that will cause another EEPROM write! */
-       V2Params_GetParamFromTable(PARAM_RESET_POLARITY)->ParamValue = eeprom_read_byte(&EEPROM_Rest_Polarity);
+       /* Target RESET line polarity is a non-volatile value, retrieve current parameter value from EEPROM */
+       V2Params_GetParamFromTable(PARAM_RESET_POLARITY)->ParamValue = eeprom_read_byte(&EEPROM_Reset_Polarity);
 }
 
 /** Updates any parameter values that are sourced from hardware rather than explicitly set by the host, such as
 }
 
 /** Updates any parameter values that are sourced from hardware rather than explicitly set by the host, such as
@@ -99,7 +98,7 @@ void V2Params_UpdateParamValues(void)
 {
        #if (defined(ADC) && !defined(NO_VTARGET_DETECT))
        /* Update VTARGET parameter with the latest ADC conversion of VTARGET on supported AVR models */
 {
        #if (defined(ADC) && !defined(NO_VTARGET_DETECT))
        /* Update VTARGET parameter with the latest ADC conversion of VTARGET on supported AVR models */
-       V2Params_GetParamFromTable(PARAM_VTARGET)->ParamValue = ((5 * 10 * ADC_GetResult()) / 1024);
+       V2Params_GetParamFromTable(PARAM_VTARGET)->ParamValue = (((uint16_t)(VTARGET_REF_VOLTS * 10 * VTARGET_SCALE_FACTOR) * ADC_GetResult()) / 1024);
        #endif
 }
 
        #endif
 }
 
@@ -109,12 +108,12 @@ void V2Params_UpdateParamValues(void)
  *
  *  \param[in] ParamID  Parameter ID whose privileges are to be retrieved from the table
  *
  *
  *  \param[in] ParamID  Parameter ID whose privileges are to be retrieved from the table
  *
- *  \return Privileges for the requested parameter, as a mask of PARAM_PRIV_* masks
- */ 
+ *  \return Privileges for the requested parameter, as a mask of \c PARAM_PRIV_* masks
+ */
 uint8_t V2Params_GetParameterPrivileges(const uint8_t ParamID)
 {
        ParameterItem_t* ParamInfo = V2Params_GetParamFromTable(ParamID);
 uint8_t V2Params_GetParameterPrivileges(const uint8_t ParamID)
 {
        ParameterItem_t* ParamInfo = V2Params_GetParamFromTable(ParamID);
-       
+
        if (ParamInfo == NULL)
          return 0;
 
        if (ParamInfo == NULL)
          return 0;
 
@@ -123,28 +122,37 @@ uint8_t V2Params_GetParameterPrivileges(const uint8_t ParamID)
 
 /** Retrieves the current value for a given parameter in the parameter table.
  *
 
 /** Retrieves the current value for a given parameter in the parameter table.
  *
+ *  \note This function does not first check for read privileges - if the value is being sent to the host via a
+ *        GET PARAM command, \ref V2Params_GetParameterPrivileges() should be called first to ensure that the
+ *        parameter is host-readable.
+ *
  *  \param[in] ParamID  Parameter ID whose value is to be retrieved from the table
  *
  *  \return Current value of the parameter in the table, or 0 if not found
  *  \param[in] ParamID  Parameter ID whose value is to be retrieved from the table
  *
  *  \return Current value of the parameter in the table, or 0 if not found
- */ 
+ */
 uint8_t V2Params_GetParameterValue(const uint8_t ParamID)
 {
        ParameterItem_t* ParamInfo = V2Params_GetParamFromTable(ParamID);
 uint8_t V2Params_GetParameterValue(const uint8_t ParamID)
 {
        ParameterItem_t* ParamInfo = V2Params_GetParamFromTable(ParamID);
-       
+
        if (ParamInfo == NULL)
          return 0;
        if (ParamInfo == NULL)
          return 0;
-       
+
        return ParamInfo->ParamValue;
 }
 
 /** Sets the value for a given parameter in the parameter table.
  *
        return ParamInfo->ParamValue;
 }
 
 /** Sets the value for a given parameter in the parameter table.
  *
+ *  \note This function does not first check for write privileges - if the value is being sourced from the host
+ *        via a SET PARAM command, \ref V2Params_GetParameterPrivileges() should be called first to ensure that the
+ *        parameter is host-writable.
+ *
  *  \param[in] ParamID  Parameter ID whose value is to be set in the table
  *  \param[in] Value    New value to set the parameter to
  *
  *  \return Pointer to the associated parameter information from the parameter table if found, NULL otherwise
  */
  *  \param[in] ParamID  Parameter ID whose value is to be set in the table
  *  \param[in] Value    New value to set the parameter to
  *
  *  \return Pointer to the associated parameter information from the parameter table if found, NULL otherwise
  */
-void V2Params_SetParameterValue(const uint8_t ParamID, const uint8_t Value)
+void V2Params_SetParameterValue(const uint8_t ParamID,
+                                const uint8_t Value)
 {
        ParameterItem_t* ParamInfo = V2Params_GetParamFromTable(ParamID);
 
 {
        ParameterItem_t* ParamInfo = V2Params_GetParamFromTable(ParamID);
 
@@ -155,7 +163,7 @@ void V2Params_SetParameterValue(const uint8_t ParamID, const uint8_t Value)
 
        /* The target RESET line polarity is a non-volatile parameter, save to EEPROM when changed */
        if (ParamID == PARAM_RESET_POLARITY)
 
        /* The target RESET line polarity is a non-volatile parameter, save to EEPROM when changed */
        if (ParamID == PARAM_RESET_POLARITY)
-         eeprom_write_byte(&EEPROM_Rest_Polarity, Value);  
+         eeprom_update_byte(&EEPROM_Reset_Polarity, Value);
 }
 
 /** Retrieves a parameter entry (including ID, value and privileges) from the parameter table that matches the given
 }
 
 /** Retrieves a parameter entry (including ID, value and privileges) from the parameter table that matches the given
@@ -174,9 +182,10 @@ static ParameterItem_t* V2Params_GetParamFromTable(const uint8_t ParamID)
        {
                if (ParamID == CurrTableItem->ParamID)
                  return CurrTableItem;
        {
                if (ParamID == CurrTableItem->ParamID)
                  return CurrTableItem;
-               
+
                CurrTableItem++;
        }
 
        return NULL;
 }
                CurrTableItem++;
        }
 
        return NULL;
 }
+