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         uint8_t ReturnStatus = XPRG_ERR_OK;
 103
 104         Endpoint_ClearOUT();
 105         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 106
 107         /* Enable PDI programming mode with the attached target */
 108         PDITarget_EnableTargetPDI();
 109
 110         /* Store the RESET ket into the RESET PDI register to complete the handshake */
 111         PDITarget_SendByte(PDI_CMD_STCS | PD_RESET_REG);
 112         PDITarget_SendByte(PDI_RESET_KEY);
 113
 114         /* Enable access to the XPROG NVM bus by sending the documented NVM access key to the device */
 115         PDITarget_SendByte(PDI_CMD_KEY);
 116         for (uint8_t i = 0; i < sizeof(PDI_NVMENABLE_KEY); i++)
 117           PDITarget_SendByte(PDI_NVMENABLE_KEY[i]);
 118
 119         /* Read out the STATUS register to check that NVM access was successfully enabled */
 120         PDITarget_SendByte(PDI_CMD_LDCS | PD_STATUS_REG);
 121         if (!(PDITarget_ReceiveByte() & PDI_STATUS_NVM))
 122           ReturnStatus = XPRG_ERR_FAILED;
 123
 124         Endpoint_Write_Byte(CMD_XPROG);
 125         Endpoint_Write_Byte(XPRG_CMD_ENTER_PROGMODE);
 126         Endpoint_Write_Byte(ReturnStatus);
 127         Endpoint_ClearIN();
 128 }
 129
 130 /** Handler for the XPROG LEAVE_PROGMODE command to terminate the PDI programming connection with
 131  *  the attached device.
 132  */
 133 static void PDIProtocol_LeaveXPROGMode(void)
 134 {
 135         Endpoint_ClearOUT();
 136         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 137
 138         PDITarget_DisableTargetPDI();
 139
 140         Endpoint_Write_Byte(CMD_XPROG);
 141         Endpoint_Write_Byte(XPRG_CMD_LEAVE_PROGMODE);
 142         Endpoint_Write_Byte(XPRG_ERR_OK);
 143         Endpoint_ClearIN();
 144 }
 145
 146 /** Handler for the XPRG ERASE command to erase a specific memory address space in the attached device. */
 147 static void PDIProtocol_Erase(void)
 148 {
 149         uint8_t ReturnStatus = XPRG_ERR_OK;
 150
 151         struct
 152         {
 153                 uint8_t  MemoryType;
 154                 uint32_t Address;
 155         } Erase_XPROG_Params;
 156
 157         Endpoint_Read_Stream_LE(&Erase_XPROG_Params, sizeof(Erase_XPROG_Params));
 158
 159         Endpoint_ClearOUT();
 160         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 161
 162         // TODO: Send erase command here via PDI protocol
 163
 164         Endpoint_Write_Byte(CMD_XPROG);
 165         Endpoint_Write_Byte(XPRG_CMD_ERASE);
 166         Endpoint_Write_Byte(ReturnStatus);
 167         Endpoint_ClearIN();
 168 }
 169
 170 /** Handler for the XPROG WRITE_MEMORY command to write to a specific memory space within the attached device. */
 171 static void PDIProtocol_WriteMemory(void)
 172 {
 173         uint8_t ReturnStatus = XPRG_ERR_OK;
 174
 175         struct
 176         {
 177                 uint8_t  MemoryType;
 178                 uint32_t Address;
 179                 uint16_t Length;
 180                 uint8_t  ProgData[256];
 181         } WriteMemory_XPROG_Params;
 182
 183         Endpoint_Read_Stream_LE(&WriteMemory_XPROG_Params, (sizeof(WriteMemory_XPROG_Params) -
 184                                                             sizeof(WriteMemory_XPROG_Params).ProgData));
 185         WriteMemory_XPROG_Params.Address = SwapEndian_32(WriteMemory_XPROG_Params.Address);
 186         WriteMemory_XPROG_Params.Length  = SwapEndian_16(WriteMemory_XPROG_Params.Length);
 187         Endpoint_Read_Stream_LE(&WriteMemory_XPROG_Params.ProgData, WriteMemory_XPROG_Params.Length);
 188
 189         Endpoint_ClearOUT();
 190         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 191
 192         // TODO: Send program command here via PDI protocol
 193
 194         Endpoint_Write_Byte(CMD_XPROG);
 195         Endpoint_Write_Byte(XPRG_CMD_READ_MEM);
 196         Endpoint_Write_Byte(ReturnStatus);
 197         Endpoint_ClearIN();
 198 }
 199
 200 /** Handler for the XPROG READ_MEMORY command to read data from a specific address space within the
 201  *  attached device.
 202  */
 203 static void PDIProtocol_ReadMemory(void)
 204 {
 205         uint8_t ReturnStatus = XPRG_ERR_OK;
 206
 207         struct
 208         {
 209                 uint8_t  MemoryType;
 210                 uint32_t Address;
 211                 uint16_t Length;
 212         } ReadMemory_XPROG_Params;
 213
 214         Endpoint_Read_Stream_LE(&ReadMemory_XPROG_Params, sizeof(ReadMemory_XPROG_Params));
 215         ReadMemory_XPROG_Params.Address = SwapEndian_32(ReadMemory_XPROG_Params.Address);
 216         ReadMemory_XPROG_Params.Length  = SwapEndian_16(ReadMemory_XPROG_Params.Length);
 217
 218         Endpoint_ClearOUT();
 219         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 220
 221         // TODO: Send read command here via PDI protocol
 222
 223         Endpoint_Write_Byte(CMD_XPROG);
 224         Endpoint_Write_Byte(XPRG_CMD_READ_MEM);
 225         Endpoint_Write_Byte(ReturnStatus);
 226
 227         Endpoint_ClearIN();
 228 }
 229
 230 /** Handler for the XPROG CRC command to read a specific memory space's CRC value for comparison between the
 231  *  attached device's memory and a data set on the host.
 232  */
 233 static void PDIProtocol_ReadCRC(void)
 234 {
 235         uint8_t ReturnStatus = XPRG_ERR_OK;
 236
 237         uint8_t CRCType = Endpoint_Read_Byte();
 238
 239         Endpoint_ClearOUT();
 240         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 241
 242         uint32_t MemoryCRC = 0;
 243
 244         // TODO: Read device CRC for desired memory via PDI protocol
 245
 246         Endpoint_Write_Byte(CMD_XPROG);
 247         Endpoint_Write_Byte(XPRG_CMD_CRC);
 248         Endpoint_Write_Byte(ReturnStatus);
 249
 250         if (ReturnStatus == XPRG_ERR_OK)
 251         {
 252                 Endpoint_Write_Byte(MemoryCRC >> 16);
 253                 Endpoint_Write_Word_LE(MemoryCRC & 0xFFFF);
 254         }
 255
 256         Endpoint_ClearIN();
 257 }
 258
 259 /** Handler for the XPROG SET_PARAM command to set a PDI parameter for use when communicating with the
 260  *  attached device.
 261  */
 262 static void PDIProtocol_SetParam(void)
 263 {
 264         uint8_t ReturnStatus = XPRG_ERR_OK;
 265
 266         uint8_t XPROGParam = Endpoint_Read_Byte();
 267
 268         if (XPROGParam == XPRG_PARAM_NVMBASE)
 269           XPROG_Param_NVMBase = Endpoint_Read_DWord_LE();
 270         else if (XPROGParam == XPRG_PARAM_EEPPAGESIZE)
 271           XPROG_Param_EEPageSize = Endpoint_Read_Word_LE();
 272         else
 273           ReturnStatus = XPRG_ERR_FAILED;
 274
 275         Endpoint_ClearOUT();
 276         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 277
 278         Endpoint_Write_Byte(CMD_XPROG);
 279         Endpoint_Write_Byte(XPRG_CMD_SET_PARAM);
 280         Endpoint_Write_Byte(ReturnStatus);
 281         Endpoint_ClearIN();
 282 }
 283
 284 #endif