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 #if defined(ENABLE_PDI_PROTOCOL) || defined(__DOXYGEN__)
  32
  33 #warning PDI Programming Protocol support is incomplete and not currently suitable for use.
  34
  35 /** \file
  36  *
  37  *  PDI Protocol handler, to process V2 Protocol wrapped PDI commands used in Atmel programmer devices.
  38  */
  39
  40 #define  INCLUDE_FROM_PDIPROTOCOL_C
  41 #include "PDIProtocol.h"
  42
  43 uint32_t XPROG_Param_NVMBase;
  44 uint32_t XPROG_Param_EEPageSize;
  45
  46 /** Handler for the CMD_XPROG_SETMODE command, which sets the programmer-to-target protocol used for PDI
  47  *  XMEGA programming (either PDI or JTAG). Only PDI programming is supported.
  48  */
  49 void PDIProtocol_XPROG_SetMode(void)
  50 {
  51         struct
  52         {
  53                 uint8_t Protocol;
  54         } SetMode_XPROG_Params;
  55
  56         Endpoint_Read_Stream_LE(&SetMode_XPROG_Params, sizeof(SetMode_XPROG_Params));
  57
  58         Endpoint_ClearOUT();
  59         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
  60
  61         Endpoint_Write_Byte(CMD_XPROG_SETMODE);
  62         Endpoint_Write_Byte(SetMode_XPROG_Params.Protocol ? STATUS_CMD_FAILED : STATUS_CMD_OK);
  63         Endpoint_ClearIN();
  64 }
  65
  66 /** Handler for the CMD_XPROG command, which wraps up XPROG commands in a V2 wrapper which need to be
  67  *  removed and processed so that the underlying XPROG command can be handled.
  68  */
  69 void PDIProtocol_XPROG_Command(void)
  70 {
  71         uint8_t XPROGCommand = Endpoint_Read_Byte();
  72
  73         switch (XPROGCommand)
  74         {
  75                 case XPRG_CMD_ENTER_PROGMODE:
  76                         PDIProtocol_EnterXPROGMode();
  77                         break;
  78                 case XPRG_CMD_LEAVE_PROGMODE:
  79                         PDIProtocol_LeaveXPROGMode();
  80                         break;
  81                 case XPRG_CMD_ERASE:
  82                         PDIProtocol_Erase();
  83                         break;
  84                 case XPRG_CMD_WRITE_MEM:
  85                         PDIProtocol_WriteMemory();
  86                         break;
  87                 case XPRG_CMD_READ_MEM:
  88                         PDIProtocol_ReadMemory();
  89                         break;
  90                 case XPRG_CMD_CRC:
  91                         PDIProtocol_ReadCRC();
  92                         break;
  93                 case XPRG_CMD_SET_PARAM:
  94                         PDIProtocol_SetParam();
  95                         break;
  96         }
  97 }
  98
  99 /** Handler for the XPROG ENTER_PROGMODE command to establish a PDI connection with the attached device. */
 100 static void PDIProtocol_EnterXPROGMode(void)
 101 {
 102         Endpoint_ClearOUT();
 103         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 104
 105         /* Enable PDI programming mode with the attached target */
 106         PDITarget_EnableTargetPDI();
 107
 108         /* Store the RESET key into the RESET PDI register to keep the XMEGA in reset */
 109         PDITarget_SendByte(PDI_CMD_STCS | PD_RESET_REG);
 110         PDITarget_SendByte(PDI_RESET_KEY);
 111
 112         /* Enable access to the XPROG NVM bus by sending the documented NVM access key to the device */
 113         PDITarget_SendByte(PDI_CMD_KEY);
 114         for (uint8_t i = sizeof(PDI_NVMENABLE_KEY); i > 0; i--)
 115           PDITarget_SendByte(PDI_NVMENABLE_KEY[i - 1]);
 116
 117         /* Poll the STATUS register to check to see if NVM access has been enabled */
 118         uint8_t NVMAttemptsRemaining = 255;
 119         while (NVMAttemptsRemaining)
 120         {
 121                 PDITarget_SendByte(PDI_CMD_LDCS | PD_STATUS_REG);
 122                 if (PDITarget_ReceiveByte() & PDI_STATUS_NVM)
 123                   break;
 124
 125                 NVMAttemptsRemaining--;
 126         }
 127
 128         Endpoint_Write_Byte(CMD_XPROG);
 129         Endpoint_Write_Byte(XPRG_CMD_ENTER_PROGMODE);
 130         Endpoint_Write_Byte(NVMAttemptsRemaining ? XPRG_ERR_OK : XPRG_ERR_FAILED);
 131         Endpoint_ClearIN();
 132 }
 133
 134 /** Handler for the XPROG LEAVE_PROGMODE command to terminate the PDI programming connection with
 135  *  the attached device.
 136  */
 137 static void PDIProtocol_LeaveXPROGMode(void)
 138 {
 139         Endpoint_ClearOUT();
 140         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 141
 142         /* Clear the RESET key into the RESET PDI register to allow the XMEGA to run */
 143         PDITarget_SendByte(PDI_CMD_STCS | PD_RESET_REG);
 144         PDITarget_SendByte(0x00);
 145
 146         PDITarget_DisableTargetPDI();
 147
 148         Endpoint_Write_Byte(CMD_XPROG);
 149         Endpoint_Write_Byte(XPRG_CMD_LEAVE_PROGMODE);
 150         Endpoint_Write_Byte(XPRG_ERR_OK);
 151         Endpoint_ClearIN();
 152 }
 153
 154 /** Handler for the XPRG ERASE command to erase a specific memory address space in the attached device. */
 155 static void PDIProtocol_Erase(void)
 156 {
 157         uint8_t ReturnStatus = XPRG_ERR_OK;
 158
 159         struct
 160         {
 161                 uint8_t  MemoryType;
 162                 uint32_t Address;
 163         } Erase_XPROG_Params;
 164
 165         Endpoint_Read_Stream_LE(&Erase_XPROG_Params, sizeof(Erase_XPROG_Params));
 166
 167         Endpoint_ClearOUT();
 168         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 169
 170         // TODO: Send erase command here via PDI protocol
 171
 172         Endpoint_Write_Byte(CMD_XPROG);
 173         Endpoint_Write_Byte(XPRG_CMD_ERASE);
 174         Endpoint_Write_Byte(ReturnStatus);
 175         Endpoint_ClearIN();
 176 }
 177
 178 /** Handler for the XPROG WRITE_MEMORY command to write to a specific memory space within the attached device. */
 179 static void PDIProtocol_WriteMemory(void)
 180 {
 181         uint8_t ReturnStatus = XPRG_ERR_OK;
 182
 183         struct
 184         {
 185                 uint8_t  MemoryType;
 186                 uint32_t Address;
 187                 uint16_t Length;
 188                 uint8_t  ProgData[256];
 189         } WriteMemory_XPROG_Params;
 190
 191         Endpoint_Read_Stream_LE(&WriteMemory_XPROG_Params, (sizeof(WriteMemory_XPROG_Params) -
 192                                                             sizeof(WriteMemory_XPROG_Params).ProgData));
 193         WriteMemory_XPROG_Params.Address = SwapEndian_32(WriteMemory_XPROG_Params.Address);
 194         WriteMemory_XPROG_Params.Length  = SwapEndian_16(WriteMemory_XPROG_Params.Length);
 195         Endpoint_Read_Stream_LE(&WriteMemory_XPROG_Params.ProgData, WriteMemory_XPROG_Params.Length);
 196
 197         Endpoint_ClearOUT();
 198         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 199
 200         // TODO: Send program command here via PDI protocol
 201
 202         Endpoint_Write_Byte(CMD_XPROG);
 203         Endpoint_Write_Byte(XPRG_CMD_READ_MEM);
 204         Endpoint_Write_Byte(ReturnStatus);
 205         Endpoint_ClearIN();
 206 }
 207
 208 /** Handler for the XPROG READ_MEMORY command to read data from a specific address space within the
 209  *  attached device.
 210  */
 211 static void PDIProtocol_ReadMemory(void)
 212 {
 213         uint8_t ReturnStatus = XPRG_ERR_OK;
 214
 215         struct
 216         {
 217                 uint8_t  MemoryType;
 218                 uint32_t Address;
 219                 uint16_t Length;
 220         } ReadMemory_XPROG_Params;
 221
 222         Endpoint_Read_Stream_LE(&ReadMemory_XPROG_Params, sizeof(ReadMemory_XPROG_Params));
 223         ReadMemory_XPROG_Params.Address = SwapEndian_32(ReadMemory_XPROG_Params.Address);
 224         ReadMemory_XPROG_Params.Length  = SwapEndian_16(ReadMemory_XPROG_Params.Length);
 225
 226         Endpoint_ClearOUT();
 227         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 228
 229         // TODO: Send read command here via PDI protocol
 230
 231         Endpoint_Write_Byte(CMD_XPROG);
 232         Endpoint_Write_Byte(XPRG_CMD_READ_MEM);
 233         Endpoint_Write_Byte(ReturnStatus);
 234
 235         Endpoint_ClearIN();
 236 }
 237
 238 /** Handler for the XPROG CRC command to read a specific memory space's CRC value for comparison between the
 239  *  attached device's memory and a data set on the host.
 240  */
 241 static void PDIProtocol_ReadCRC(void)
 242 {
 243         uint8_t ReturnStatus = XPRG_ERR_OK;
 244
 245         uint8_t CRCType = Endpoint_Read_Byte();
 246
 247         Endpoint_ClearOUT();
 248         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 249
 250         uint32_t MemoryCRC = 0;
 251
 252         // TODO: Read device CRC for desired memory via PDI protocol
 253
 254         Endpoint_Write_Byte(CMD_XPROG);
 255         Endpoint_Write_Byte(XPRG_CMD_CRC);
 256         Endpoint_Write_Byte(ReturnStatus);
 257
 258         if (ReturnStatus == XPRG_ERR_OK)
 259         {
 260                 Endpoint_Write_Byte(MemoryCRC >> 16);
 261                 Endpoint_Write_Word_LE(MemoryCRC & 0xFFFF);
 262         }
 263
 264         Endpoint_ClearIN();
 265 }
 266
 267 /** Handler for the XPROG SET_PARAM command to set a PDI parameter for use when communicating with the
 268  *  attached device.
 269  */
 270 static void PDIProtocol_SetParam(void)
 271 {
 272         uint8_t ReturnStatus = XPRG_ERR_OK;
 273
 274         uint8_t XPROGParam = Endpoint_Read_Byte();
 275
 276         if (XPROGParam == XPRG_PARAM_NVMBASE)
 277           XPROG_Param_NVMBase = Endpoint_Read_DWord_LE();
 278         else if (XPROGParam == XPRG_PARAM_EEPPAGESIZE)
 279           XPROG_Param_EEPageSize = Endpoint_Read_Word_LE();
 280         else
 281           ReturnStatus = XPRG_ERR_FAILED;
 282
 283         Endpoint_ClearOUT();
 284         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 285
 286         Endpoint_Write_Byte(CMD_XPROG);
 287         Endpoint_Write_Byte(XPRG_CMD_SET_PARAM);
 288         Endpoint_Write_Byte(ReturnStatus);
 289         Endpoint_ClearIN();
 290 }
 291
 292 #endif