Rename PDIProtocol.c/.h to XPROGProtocol.c/.h as it will now handle both TPI and...

[pub/USBasp.git] / Projects / AVRISP / Lib / V2ProtocolParams.c

diff --git a/Projects/AVRISP/Lib/V2ProtocolParams.c b/Projects/AVRISP/Lib/V2ProtocolParams.c
index 2d646a9..6b7f84a 100644 (file)
--- a/Projects/AVRISP/Lib/V2ProtocolParams.c
+++ b/Projects/AVRISP/Lib/V2ProtocolParams.c
@@ -44,43 +44,43 @@ static ParameterItem_t ParameterTable[] =
        {\r
                { .ParamID          = PARAM_BUILD_NUMBER_LOW,\r
                  .ParamValue       = (LUFA_VERSION_INTEGER >> 8),\r
        {\r
                { .ParamID          = PARAM_BUILD_NUMBER_LOW,\r
                  .ParamValue       = (LUFA_VERSION_INTEGER >> 8),\r

-                 .ParamPrivellages = PARAM_PRIV_READ                    },\r
+                 .ParamPrivileges  = PARAM_PRIV_READ                    },\r

 \r
                { .ParamID          = PARAM_BUILD_NUMBER_HIGH,\r
                  .ParamValue       = (LUFA_VERSION_INTEGER & 0xFF),\r
 \r
                { .ParamID          = PARAM_BUILD_NUMBER_HIGH,\r
                  .ParamValue       = (LUFA_VERSION_INTEGER & 0xFF),\r

-                 .ParamPrivellages = PARAM_PRIV_READ                    },\r
+                 .ParamPrivileges  = PARAM_PRIV_READ                    },\r

 \r
                { .ParamID          = PARAM_HW_VER,\r
                  .ParamValue       = 0x00,\r
 \r
                { .ParamID          = PARAM_HW_VER,\r
                  .ParamValue       = 0x00,\r

-                 .ParamPrivellages = PARAM_PRIV_READ                    },\r
+                 .ParamPrivileges  = PARAM_PRIV_READ                    },\r

 \r
                { .ParamID          = PARAM_SW_MAJOR,\r
                  .ParamValue       = 0x01,\r
 \r
                { .ParamID          = PARAM_SW_MAJOR,\r
                  .ParamValue       = 0x01,\r

-                 .ParamPrivellages = PARAM_PRIV_READ                    },\r
+                 .ParamPrivileges  = PARAM_PRIV_READ                    },\r

 \r
                { .ParamID          = PARAM_SW_MINOR,\r
 \r
                { .ParamID          = PARAM_SW_MINOR,\r

-                 .ParamValue       = 0x0C,\r
-                 .ParamPrivellages = PARAM_PRIV_READ                    },\r
+                 .ParamValue       = 0x0D,\r
+                 .ParamPrivileges  = PARAM_PRIV_READ                    },\r

 \r
                { .ParamID          = PARAM_VTARGET,\r
                  .ParamValue       = 0x32,\r
 \r
                { .ParamID          = PARAM_VTARGET,\r
                  .ParamValue       = 0x32,\r

-                 .ParamPrivellages = PARAM_PRIV_READ                    },\r
+                 .ParamPrivileges  = PARAM_PRIV_READ                    },\r

 \r
                { .ParamID          = PARAM_SCK_DURATION,\r
 \r
                { .ParamID          = PARAM_SCK_DURATION,\r

-                 .ParamValue       = (TOTAL_PROGRAMMING_SPEEDS - 1),\r
-                 .ParamPrivellages = PARAM_PRIV_READ | PARAM_PRIV_WRITE },\r
+                 .ParamValue       = (TOTAL_ISP_PROGRAMMING_SPEEDS - 1),\r
+                 .ParamPrivileges  = PARAM_PRIV_READ | PARAM_PRIV_WRITE },\r

 \r
                { .ParamID          = PARAM_RESET_POLARITY,\r
                  .ParamValue       = 0x00,\r
 \r
                { .ParamID          = PARAM_RESET_POLARITY,\r
                  .ParamValue       = 0x00,\r

-                 .ParamPrivellages = PARAM_PRIV_WRITE                   },\r
+                 .ParamPrivileges  = PARAM_PRIV_WRITE                   },\r

 \r
                { .ParamID          = PARAM_STATUS_TGT_CONN,\r
                  .ParamValue       = 0x00,\r
 \r
                { .ParamID          = PARAM_STATUS_TGT_CONN,\r
                  .ParamValue       = 0x00,\r

-                 .ParamPrivellages = PARAM_PRIV_READ                    },\r
+                 .ParamPrivileges  = PARAM_PRIV_READ                    },\r

 \r
                { .ParamID          = PARAM_DISCHARGEDELAY,\r
                  .ParamValue       = 0x00,\r
 \r
                { .ParamID          = PARAM_DISCHARGEDELAY,\r
                  .ParamValue       = 0x00,\r

-                 .ParamPrivellages = PARAM_PRIV_WRITE                   },\r
+                 .ParamPrivileges  = PARAM_PRIV_WRITE                   },\r

        };\r
 \r
 \r
        };\r
 \r
 \r


@@ -88,8 +88,7 @@ static ParameterItem_t ParameterTable[] =
 void V2Params_LoadNonVolatileParamValues(void)\r
 {\r
        /* Target RESET line polarity is a non-volatile value, retrieve current parameter value from EEPROM -\r
 void V2Params_LoadNonVolatileParamValues(void)\r
 {\r
        /* Target RESET line polarity is a non-volatile value, retrieve current parameter value from EEPROM -\r

-        *   NB: Cannot call V2Protocol_SetParameterValue() here, as that will cause another EEPROM write!\r
-        */\r
+        *   NB: Cannot call V2Protocol_SetParameterValue() here, as that will cause another EEPROM write! */\r

        V2Params_GetParamFromTable(PARAM_RESET_POLARITY)->ParamValue = eeprom_read_byte(&EEPROM_Rest_Polarity);\r
 }\r
 \r
        V2Params_GetParamFromTable(PARAM_RESET_POLARITY)->ParamValue = eeprom_read_byte(&EEPROM_Rest_Polarity);\r
 }\r
 \r


@@ -104,35 +103,35 @@ void V2Params_UpdateParamValues(void)
        #endif\r
 }\r
 \r
        #endif\r
 }\r
 \r

-/** Retrieves the host PC read/write privellages for a given parameter in the parameter table. This should\r
+/** Retrieves the host PC read/write privileges for a given parameter in the parameter table. This should\r

  *  be called before calls to \ref V2Params_GetParameterValue() or \ref V2Params_SetParameterValue() when\r
  *  getting or setting parameter values in response to requests from the host.\r
  *\r
  *  be called before calls to \ref V2Params_GetParameterValue() or \ref V2Params_SetParameterValue() when\r
  *  getting or setting parameter values in response to requests from the host.\r
  *\r

- *  \param ParamID  Parameter ID whose privellages are to be retrieved from the table\r
+ *  \param[in] ParamID  Parameter ID whose privileges are to be retrieved from the table\r

  *\r
  *\r

- *  \return Privellages for the requested parameter, as a mask of PARAM_PRIV_* masks\r
+ *  \return Privileges for the requested parameter, as a mask of PARAM_PRIV_* masks\r

  */ \r
  */ \r

-uint8_t V2Params_GetParameterPrivellages(uint8_t ParamID)\r
+uint8_t V2Params_GetParameterPrivileges(const uint8_t ParamID)\r

 {\r
        ParameterItem_t* ParamInfo = V2Params_GetParamFromTable(ParamID);\r
        \r
        if (ParamInfo == NULL)\r
          return 0;\r
 \r
 {\r
        ParameterItem_t* ParamInfo = V2Params_GetParamFromTable(ParamID);\r
        \r
        if (ParamInfo == NULL)\r
          return 0;\r
 \r

-       return ParamInfo->ParamPrivellages;\r
+       return ParamInfo->ParamPrivileges;\r

 }\r
 \r
 /** Retrieves the current value for a given parameter in the parameter table.\r
  *\r
 }\r
 \r
 /** Retrieves the current value for a given parameter in the parameter table.\r
  *\r

- *  \param ParamID  Parameter ID whose value is to be retrieved from the table\r
+ *  \param[in] ParamID  Parameter ID whose value is to be retrieved from the table\r

  *\r
  *  \return Current value of the parameter in the table, or 0 if not found\r
  */ \r
  *\r
  *  \return Current value of the parameter in the table, or 0 if not found\r
  */ \r

-uint8_t V2Params_GetParameterValue(uint8_t ParamID)\r
+uint8_t V2Params_GetParameterValue(const uint8_t ParamID)\r

 {\r
        ParameterItem_t* ParamInfo = V2Params_GetParamFromTable(ParamID);\r
        \r
 {\r
        ParameterItem_t* ParamInfo = V2Params_GetParamFromTable(ParamID);\r
        \r

-       if (ParamInfo == NULL)\r
+       if ((ParamInfo == NULL) || !(ParamInfo->ParamPrivileges & PARAM_PRIV_READ))\r

          return 0;\r
        \r
        return ParamInfo->ParamValue;\r
          return 0;\r
        \r
        return ParamInfo->ParamValue;\r


@@ -140,16 +139,16 @@ uint8_t V2Params_GetParameterValue(uint8_t ParamID)
 \r
 /** Sets the value for a given parameter in the parameter table.\r
  *\r
 \r
 /** Sets the value for a given parameter in the parameter table.\r
  *\r

- *  \param ParamID  Parameter ID whose value is to be set in the table\r
- *  \param Value  New value to set the parameter to\r
+ *  \param[in] ParamID  Parameter ID whose value is to be set in the table\r
+ *  \param[in] Value    New value to set the parameter to\r

  *\r
  *  \return Pointer to the associated parameter information from the parameter table if found, NULL otherwise\r
  */\r
  *\r
  *  \return Pointer to the associated parameter information from the parameter table if found, NULL otherwise\r
  */\r

-void V2Params_SetParameterValue(uint8_t ParamID, uint8_t Value)\r
+void V2Params_SetParameterValue(const uint8_t ParamID, const uint8_t Value)\r

 {\r
        ParameterItem_t* ParamInfo = V2Params_GetParamFromTable(ParamID);\r
 \r
 {\r
        ParameterItem_t* ParamInfo = V2Params_GetParamFromTable(ParamID);\r
 \r

-       if (ParamInfo == NULL)\r
+       if ((ParamInfo == NULL) || !(ParamInfo->ParamPrivileges & PARAM_PRIV_WRITE))\r

          return;\r
 \r
        ParamInfo->ParamValue = Value;\r
          return;\r
 \r
        ParamInfo->ParamValue = Value;\r


@@ -159,14 +158,14 @@ void V2Params_SetParameterValue(uint8_t ParamID, uint8_t Value)
          eeprom_write_byte(&EEPROM_Rest_Polarity, Value);  \r
 }\r
 \r
          eeprom_write_byte(&EEPROM_Rest_Polarity, Value);  \r
 }\r
 \r

-/** Retrieves a parameter entry (including ID, value and privellages) from the parameter table that matches the given\r
+/** Retrieves a parameter entry (including ID, value and privileges) from the parameter table that matches the given\r

  *  parameter ID.\r
  *\r
  *  parameter ID.\r
  *\r

- *  \param ParamID  Parameter ID to find in the table\r
+ *  \param[in] ParamID  Parameter ID to find in the table\r

  *\r
  *  \return Pointer to the associated parameter information from the parameter table if found, NULL otherwise\r
  */\r
  *\r
  *  \return Pointer to the associated parameter information from the parameter table if found, NULL otherwise\r
  */\r

-static ParameterItem_t* V2Params_GetParamFromTable(uint8_t ParamID)\r
+static ParameterItem_t* V2Params_GetParamFromTable(const uint8_t ParamID)\r

 {\r
        /* Find the parameter in the parameter table if present */\r
        for (uint8_t TableIndex = 0; TableIndex < (sizeof(ParameterTable) / sizeof(ParameterTable[0])); TableIndex++)\r
 {\r
        /* Find the parameter in the parameter table if present */\r
        for (uint8_t TableIndex = 0; TableIndex < (sizeof(ParameterTable) / sizeof(ParameterTable[0])); TableIndex++)\r


@@ -174,6 +173,6 @@ static ParameterItem_t* V2Params_GetParamFromTable(uint8_t ParamID)
                if (ParamID == ParameterTable[TableIndex].ParamID)\r
                  return &ParameterTable[TableIndex];\r
        }\r
                if (ParamID == ParameterTable[TableIndex].ParamID)\r
                  return &ParameterTable[TableIndex];\r
        }\r

-       \r
+\r

        return NULL;\r
 }\r
        return NULL;\r
 }\r