Projects/AVRISP/Lib/PDIProtocol.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2009.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, and distribute this software
  13   and its documentation for any purpose and without fee is hereby
  14   granted, provided that the above copyright notice appear in all
  15   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 disclaim 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  *  PDI Protocol handler, to process V2 Protocol wrapped PDI commands used in Atmel programmer devices.
  34  */
  35
  36 #define  INCLUDE_FROM_PDIPROTOCOL_C
  37 #include "PDIProtocol.h"
  38
  39 #if defined(ENABLE_PDI_PROTOCOL) || defined(__DOXYGEN__)
  40 #warning PDI Programming Protocol support is incomplete and not currently suitable for use.
  41
  42 uint32_t XPROG_Param_NVMBase;
  43 uint32_t XPROG_Param_EEPageSize;
  44
  45 /** Handler for the CMD_XPROG_SETMODE command, which sets the programmer-to-target protocol used for PDI
  46  *  XMEGA programming (either PDI or JTAG). Only PDI programming is supported.
  47  */
  48 void PDIProtocol_XPROG_SetMode(void)
  49 {
  50         struct
  51         {
  52                 uint8_t Protocol;
  53         } SetMode_XPROG_Params;
  54
  55         Endpoint_Read_Stream_LE(&SetMode_XPROG_Params, sizeof(SetMode_XPROG_Params));
  56
  57         Endpoint_ClearOUT();
  58         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
  59
  60         Endpoint_Write_Byte(CMD_XPROG_SETMODE);
  61         Endpoint_Write_Byte((SetMode_XPROG_Params.Protocol == XPRG_PROTOCOL_PDI) ? STATUS_CMD_OK : STATUS_CMD_FAILED);
  62         Endpoint_ClearIN();
  63 }
  64
  65 /** Handler for the CMD_XPROG command, which wraps up XPROG commands in a V2 wrapper which need to be
  66  *  removed and processed so that the underlying XPROG command can be handled.
  67  */
  68 void PDIProtocol_XPROG_Command(void)
  69 {
  70         uint8_t XPROGCommand = Endpoint_Read_Byte();
  71
  72         switch (XPROGCommand)
  73         {
  74                 case XPRG_CMD_ENTER_PROGMODE:
  75                         PDIProtocol_EnterXPROGMode();
  76                         break;
  77                 case XPRG_CMD_LEAVE_PROGMODE:
  78                         PDIProtocol_LeaveXPROGMode();
  79                         break;
  80                 case XPRG_CMD_ERASE:
  81                         PDIProtocol_Erase();
  82                         break;
  83                 case XPRG_CMD_WRITE_MEM:
  84                         PDIProtocol_WriteMemory();
  85                         break;
  86                 case XPRG_CMD_READ_MEM:
  87                         PDIProtocol_ReadMemory();
  88                         break;
  89                 case XPRG_CMD_CRC:
  90                         PDIProtocol_ReadCRC();
  91                         break;
  92                 case XPRG_CMD_SET_PARAM:
  93                         PDIProtocol_SetParam();
  94                         break;
  95         }
  96 }
  97
  98 /** Handler for the XPROG ENTER_PROGMODE command to establish a PDI connection with the attached device. */
  99 static void PDIProtocol_EnterXPROGMode(void)
 100 {
 101         Endpoint_ClearOUT();
 102         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 103
 104         /* Enable PDI programming mode with the attached target */
 105         PDITarget_EnableTargetPDI();
 106
 107         /* Store the RESET key into the RESET PDI register to keep the XMEGA in reset */
 108         PDITarget_SendByte(PDI_CMD_STCS | PDI_RESET_REG);
 109         PDITarget_SendByte(PDI_RESET_KEY);
 110
 111         /* Enable access to the XPROG NVM bus by sending the documented NVM access key to the device */
 112         PDITarget_SendByte(PDI_CMD_KEY);
 113         for (uint8_t i = sizeof(PDI_NVMENABLE_KEY); i > 0; i--)
 114           PDITarget_SendByte(PDI_NVMENABLE_KEY[i - 1]);
 115
 116         /* Wait until the NVM bus becomes active */
 117         bool NVMBusEnabled = PDITarget_WaitWhileNVMBusBusy();
 118
 119         Endpoint_Write_Byte(CMD_XPROG);
 120         Endpoint_Write_Byte(XPRG_CMD_ENTER_PROGMODE);
 121         Endpoint_Write_Byte(NVMBusEnabled ? XPRG_ERR_OK : XPRG_ERR_FAILED);
 122         Endpoint_ClearIN();
 123 }
 124
 125 /** Handler for the XPROG LEAVE_PROGMODE command to terminate the PDI programming connection with
 126  *  the attached device.
 127  */
 128 static void PDIProtocol_LeaveXPROGMode(void)
 129 {
 130         Endpoint_ClearOUT();
 131         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 132
 133         /* Clear the RESET key in the RESET PDI register to allow the XMEGA to run */
 134         PDITarget_SendByte(PDI_CMD_STCS | PDI_RESET_REG);
 135         PDITarget_SendByte(0x00);
 136
 137         PDITarget_DisableTargetPDI();
 138
 139         Endpoint_Write_Byte(CMD_XPROG);
 140         Endpoint_Write_Byte(XPRG_CMD_LEAVE_PROGMODE);
 141         Endpoint_Write_Byte(XPRG_ERR_OK);
 142         Endpoint_ClearIN();
 143 }
 144
 145 /** Handler for the XPRG ERASE command to erase a specific memory address space in the attached device. */
 146 static void PDIProtocol_Erase(void)
 147 {
 148         uint8_t ReturnStatus = XPRG_ERR_OK;
 149
 150         struct
 151         {
 152                 uint8_t  MemoryType;
 153                 uint32_t Address;
 154         } Erase_XPROG_Params;
 155
 156         Endpoint_Read_Stream_LE(&Erase_XPROG_Params, sizeof(Erase_XPROG_Params));
 157         Erase_XPROG_Params.Address = SwapEndian_32(Erase_XPROG_Params.Address);
 158
 159         Endpoint_ClearOUT();
 160         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 161
 162         uint8_t EraseCommand;
 163
 164         if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_CHIP)
 165           EraseCommand = NVM_CMD_CHIPERASE;
 166         else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_APP)
 167           EraseCommand = NVM_CMD_ERASEAPPSEC;
 168         else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_BOOT)
 169           EraseCommand = NVM_CMD_ERASEBOOTSEC;
 170         else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_EEPROM)
 171           EraseCommand = NVM_CMD_ERASEEEPROM;
 172         else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_APP_PAGE)
 173           EraseCommand = NVM_CMD_ERASEAPPSECPAGE;
 174         else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_BOOT_PAGE)
 175           EraseCommand = NVM_CMD_ERASEBOOTSECPAGE;
 176         else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_EEPROM_PAGE)
 177           EraseCommand = NVM_CMD_ERASEEEPROMPAGE;
 178         else if (Erase_XPROG_Params.MemoryType == XPRG_ERASE_USERSIG)
 179           EraseCommand = NVM_CMD_ERASEUSERSIG;
 180
 181         NVMTarget_EraseMemory(EraseCommand, Erase_XPROG_Params.Address);
 182
 183         Endpoint_Write_Byte(CMD_XPROG);
 184         Endpoint_Write_Byte(XPRG_CMD_ERASE);
 185         Endpoint_Write_Byte(ReturnStatus);
 186         Endpoint_ClearIN();
 187 }
 188
 189 /** Handler for the XPROG WRITE_MEMORY command to write to a specific memory space within the attached device. */
 190 static void PDIProtocol_WriteMemory(void)
 191 {
 192         uint8_t ReturnStatus = XPRG_ERR_OK;
 193
 194         struct
 195         {
 196                 uint8_t  MemoryType;
 197                 uint32_t Address;
 198                 uint16_t Length;
 199                 uint8_t  ProgData[256];
 200         } WriteMemory_XPROG_Params;
 201
 202         Endpoint_Read_Stream_LE(&WriteMemory_XPROG_Params, (sizeof(WriteMemory_XPROG_Params) -
 203                                                             sizeof(WriteMemory_XPROG_Params).ProgData));
 204         WriteMemory_XPROG_Params.Address = SwapEndian_32(WriteMemory_XPROG_Params.Address);
 205         WriteMemory_XPROG_Params.Length  = SwapEndian_16(WriteMemory_XPROG_Params.Length);
 206         Endpoint_Read_Stream_LE(&WriteMemory_XPROG_Params.ProgData, WriteMemory_XPROG_Params.Length);
 207
 208         Endpoint_ClearOUT();
 209         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 210
 211         // TODO: Send program command here via PDI protocol
 212
 213         Endpoint_Write_Byte(CMD_XPROG);
 214         Endpoint_Write_Byte(XPRG_CMD_READ_MEM);
 215         Endpoint_Write_Byte(ReturnStatus);
 216         Endpoint_ClearIN();
 217 }
 218
 219 /** Handler for the XPROG READ_MEMORY command to read data from a specific address space within the
 220  *  attached device.
 221  */
 222 static void PDIProtocol_ReadMemory(void)
 223 {
 224         uint8_t ReturnStatus = XPRG_ERR_OK;
 225
 226         struct
 227         {
 228                 uint8_t  MemoryType;
 229                 uint32_t Address;
 230                 uint16_t Length;
 231         } ReadMemory_XPROG_Params;
 232
 233         Endpoint_Read_Stream_LE(&ReadMemory_XPROG_Params, sizeof(ReadMemory_XPROG_Params));
 234         ReadMemory_XPROG_Params.Address = SwapEndian_32(ReadMemory_XPROG_Params.Address);
 235         ReadMemory_XPROG_Params.Length  = SwapEndian_16(ReadMemory_XPROG_Params.Length);
 236
 237         Endpoint_ClearOUT();
 238         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 239
 240         uint8_t ReadBuffer[ReadMemory_XPROG_Params.Length];
 241         NVMTarget_ReadMemory(ReadMemory_XPROG_Params.Address, ReadBuffer, ReadMemory_XPROG_Params.Length);
 242
 243         Endpoint_Write_Byte(CMD_XPROG);
 244         Endpoint_Write_Byte(XPRG_CMD_READ_MEM);
 245         Endpoint_Write_Byte(ReturnStatus);
 246
 247         if (ReturnStatus == XPRG_ERR_OK)
 248           Endpoint_Write_Stream_LE(ReadBuffer, ReadMemory_XPROG_Params.Length);
 249
 250         Endpoint_ClearIN();
 251 }
 252
 253 /** Handler for the XPROG CRC command to read a specific memory space's CRC value for comparison between the
 254  *  attached device's memory and a data set on the host.
 255  */
 256 static void PDIProtocol_ReadCRC(void)
 257 {
 258         uint8_t ReturnStatus = XPRG_ERR_OK;
 259
 260         struct
 261         {
 262                 uint8_t CRCType;
 263         } ReadCRC_XPROG_Params;
 264
 265         Endpoint_Read_Stream_LE(&ReadCRC_XPROG_Params, sizeof(ReadCRC_XPROG_Params));
 266         Endpoint_ClearOUT();
 267         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 268
 269         uint32_t MemoryCRC;
 270         uint8_t  CRCCommand;
 271
 272         if (ReadCRC_XPROG_Params.CRCType == XPRG_CRC_APP)
 273           CRCCommand = NVM_CMD_APPCRC;
 274         else if (ReadCRC_XPROG_Params.CRCType == XPRG_CRC_BOOT)
 275           CRCCommand = NVM_CMD_BOOTCRC;
 276         else
 277           CRCCommand = NVM_CMD_FLASHCRC;
 278
 279         MemoryCRC = NVMTarget_GetMemoryCRC(CRCCommand);
 280
 281         Endpoint_Write_Byte(CMD_XPROG);
 282         Endpoint_Write_Byte(XPRG_CMD_CRC);
 283         Endpoint_Write_Byte(ReturnStatus);
 284
 285         if (ReturnStatus == XPRG_ERR_OK)
 286         {
 287                 Endpoint_Write_Byte(MemoryCRC >> 16);
 288                 Endpoint_Write_Word_LE(MemoryCRC & 0xFFFF);
 289         }
 290
 291         Endpoint_ClearIN();
 292 }
 293
 294 /** Handler for the XPROG SET_PARAM command to set a PDI parameter for use when communicating with the
 295  *  attached device.
 296  */
 297 static void PDIProtocol_SetParam(void)
 298 {
 299         uint8_t ReturnStatus = XPRG_ERR_OK;
 300
 301         uint8_t XPROGParam = Endpoint_Read_Byte();
 302
 303         if (XPROGParam == XPRG_PARAM_NVMBASE)
 304           XPROG_Param_NVMBase = Endpoint_Read_DWord_BE();
 305         else if (XPROGParam == XPRG_PARAM_EEPPAGESIZE)
 306           XPROG_Param_EEPageSize = Endpoint_Read_Word_BE();
 307         else
 308           ReturnStatus = XPRG_ERR_FAILED;
 309
 310         Endpoint_ClearOUT();
 311         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 312
 313         Endpoint_Write_Byte(CMD_XPROG);
 314         Endpoint_Write_Byte(XPRG_CMD_SET_PARAM);
 315         Endpoint_Write_Byte(ReturnStatus);
 316         Endpoint_ClearIN();
 317 }
 318
 319 #endif