aboutsummaryrefslogtreecommitdiffstats
path: root/Software/Visual_Studio/Firmware/Tango.FirmwareUpdateLib/DFUDevice.h
blob: c5d954cb25b07cfa4c5f5983df19e27fb58b52a3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
#include "DFUMode.h"
#include <stdio.h>
#include "stdafx.h"
#include <stdlib.h>
#include <conio.h>
#include <windows.h>
#include "lmdfu.h"
#include "lmdfuwrap.h"
#include "ProgressMode.h"
#include "TwineDFUExtras.h"

#pragma once

using namespace System;

namespace Tango
{
	namespace FirmwareUpdateLib {

		/// <summary>
		/// Represents the upload operation progress callback delegate.
		/// </summary>
		/// <param name="progressMode">The progress mode.</param>
		/// <param name="current">The current.</param>
		/// <param name="total">The total.</param>
		public delegate void ProgressCallbackDelegate(ProgressMode progressMode, int current, int total);

		public ref class DFUDevice
		{
		private:
			unsigned char *lastDownloadBytes;
			tLMDFUDeviceInfo *devInfo;
			tLMDFUHandle devHandle;
			bool _isDisposed;

		public:

			/// <summary>
			/// Vendor ID published in the device descriptor.
			/// </summary>
			property String^ VID;
			/// <summary>
			/// Product ID published in the device descriptor.
			/// </summary>
			property String^ PID;
			/// <summary>
			/// BCD device release number published in the device descriptor.
			/// </summary>
			property String^ DeviceName;
			/// <summary>
			/// The manufacturer name string published in the device.
			/// </summary>
			property String^ Manufacturer;
			/// <summary>
			/// The interface string published in the DFU interface descriptor.
			/// </summary>
			property String^ DFUInterface;
			/// <summary>
			/// The serial number string published in the device descriptor.
			/// </summary>
			property String^ SerialNumber;
			/// <summary>
			/// Maximum number of bytes that the device can accept per control-write transaction as published in the DFU functional descriptor.
			/// </summary>
			property int MaxTransfer;
			/// <summary>
			/// Determines the current DFU driver mode. (An update can only be applied while in DFU mode).
			/// </summary>
			property DFUMode Mode;
			/// <summary>
			/// Indicates that the device will detach and reattach automatically on receipt of the DFU_DETACH request whereas 'false' indicates that the host must issue a USB reset after the DFU_DETACH request.
			/// </summary>
			property bool WillDetach;
			/// <summary>
			/// Indicates that the device supports firmware download operations and: 'false' indicates that download is not supported.
			/// </summary>
			property bool ManifestTolerant;

			property bool UploadCable;

			property bool DownloadCable;
			/// <summary>
			///Determines whether the DFU device supports the Tiva DFU binary protocol or false otherwise. (If not than AppStartAddress should be provided!).
			/// </summary>
			property bool SupportsTivaExtensions;
			/// <summary>
			/// The size of a flash block in bytes.
			/// </summary>
			property short FlashBlockSize;
			/// <summary>
			/// The number of blocks of flash in the device.  Total flash size is NumFlashBlocks * FlashBlockSize.
			/// </summary>
			property short NumFlashBlocks;
			/// <summary>
			/// Address 1 byte above the highest location the boot loader can access.
			/// </summary>
			property long FlashTopAddress;
			/// <summary>
			/// Total flash size in bytes.
			/// </summary>
			property int FlashSize;
			/// <summary>
			/// Lowest address the boot loader can write or erase.
			/// </summary>
			property long AppStartAddress;

			/// <summary>
			/// Image Size.
			/// </summary>
			property long ImageLength;
			
			/// <summary>
			/// Optional Twine information which will be flashed to the top of the memory.
			/// </summary>
			property TwineDFUExtras^ TwineExtras;

			/// <summary>
			/// Initializes a new instance of the <see cref="DFUDevice"/> class.
			/// </summary>
			DFUDevice();

			/// <summary>
			/// Finalizes an instance of the <see cref="DFUDevice"/> class.
			/// </summary>
			~DFUDevice();

			/// <summary>
			/// Switch the device to DFU upgrade mode.
			/// </summary>
			void SwitchToDFUMode();

			/// <summary>
			/// Clears the flash.
			/// </summary>
			void ClearFlash();

			/// <summary>
			/// Resets the device.
			/// </summary>
			void Reset();

			/// <summary>
			/// Uploads the specified image bytes to the firmware via the DFU class.
			/// </summary>
			/// <param name="bytes">The bytes.</param>
			/// <param name="callback">The progress callback.</param>
			void Upload(array<byte>^ bytes, ProgressCallbackDelegate^ callback);
			
			/// <summary>
			/// Uploads the specified twine extras to the top of the flash memory.
			/// </summary>
			/// <param name="extras">The extras.</param>
			/// <param name="callback">The progress callback.</param>
			void UploadTwineExtras(TwineDFUExtras^ extras, ProgressCallbackDelegate^ callback);
			
			/// <summary>
			/// Downloads the existing image bytes from the firmware via the DFU class.
			/// </summary>
			/// <param name="callback">The progress callback.</param>
			/// <returns></returns>
			void Download(ProgressCallbackDelegate^ callback);
			
			/// <summary>
			/// Gets the last download operation bytes.
			/// </summary>
			/// <returns></returns>
			array<byte>^ GetDownloadBytes();

		internal:

			const int EXTENSION_LENGTH = 1024;
			const int EXTENSION_CODE = 1357;
			const int EXTENSION_COMMENTS_LENGTH = 992;
			
			/// <summary>
			/// Fetches the twine extras.
			/// </summary>
			void FetchTwineExtras();

			/// <summary>
			/// Initializes a new instance of the <see cref="DFUDevice"/> class.
			/// </summary>
			/// <param name="deviceInfo">The device information.</param>
			/// <param name="deviceHandle">The device handle.</param>
			DFUDevice(tLMDFUDeviceInfo *deviceInfo, tLMDFUHandle deviceHandle);
		};

	}
}