Skip to content

Commit 846fd71

Browse files
committed
Placing SDK/HDK 1.2.0 onto master
Change-Id: I5940a6675e33bbaeda1395909217eaa9c4f628d0
1 parent 35d0d90 commit 846fd71

File tree

2 files changed

+11
-93
lines changed

2 files changed

+11
-93
lines changed

hdk/cl/examples/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -163,11 +163,11 @@ Once your policy passes the checks, your ready to start AFI creation.
163163
The output of this command includes two identifiers that refer to your AFI:
164164
- **FPGA Image Identifier** or **AFI ID**: this is the main ID used to manage your AFI through the AWS EC2 CLI commands and AWS SDK APIs.
165165
This ID is regional, i.e., if an AFI is copied across multiple regions, it will have a different unique AFI ID in each region.
166-
An example AFI ID is **`afi-01234567890abcdef`**.
166+
An example AFI ID is **`agfi-0f0e045f919413242`**.
167167
- **Glogal FPGA Image Identifier** or **AGFI ID**: this is a global ID that is used to refer to an AFI from within an F1 instance.
168168
For example, to load or clear an AFI from an FPGA slot, you use the AGFI ID.
169169
Since the AGFI IDs is global (by design), it allows you to copy a combination of AFI/AMI to multiple regions, and they will work without requiring any extra setup.
170-
An example AGFI ID is **`agfi-01234567890abcdef`**.
170+
An example AGFI ID is **`agfi-0f0e045f919413242`**.
171171

172172
After the AFI generation is complete, AWS will put the logs into the bucket location (```s3://<bucket-name>/<logs-folder-name>```) provided by the developer. The presence of these logs is an indication that the creation process is complete. Please look for either a “State” file indicating the state of the AFI (e.g., available or failed), or the Vivado logs detailing errors encountered during the creation process. For help with AFI creation issues, see [create-fpga-image error codes](../../docs/create_fpga_image_error_codes.md)
173173

@@ -218,7 +218,7 @@ If the describe returns a status 'Busy', the FPGA is still performing the previo
218218
Now, let us try loading your AFI to FPGA `slot 0`:
219219

220220
```
221-
$ sudo fpga-load-local-image -S 0 -I agfi-0123456789abcdefg
221+
$ sudo fpga-load-local-image -S 0 -I agfi-0f0e045f919413242
222222
```
223223

224224

@@ -229,7 +229,7 @@ Now, you can verify that the AFI was loaded properly. The output shows the FPGA
229229
$ sudo fpga-describe-local-image -S 0 -R -H
230230
231231
Type FpgaImageSlot FpgaImageId StatusName StatusCode ErrorName ErrorCode ShVersion
232-
AFI 0 agfi-0123456789abcdefg loaded 0 ok 0 <shell version>
232+
AFI 0 agfi-0f0e045f919413242 loaded 0 ok 0 <shell version>
233233
Type FpgaImageSlot VendorId DeviceId DBDF
234234
AFIDEVICE 0 0x6789 0x1d50 0000:00:0f.0
235235
```

hdk/common/shell_v04151701/new_cl_template/build/README.md

Lines changed: 7 additions & 89 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22

33
# Table of Contents
44

5-
1. [Overview of AFI Build process] (#buildoverview)
6-
2. [Build procedure step by step] (#stepbystep)
7-
3. [Build strategies and parallel builds] (#strategies)
8-
4. [About Encrption during build process] (#buildencryption)
9-
5. [Advanced Notes] (#buildadvanced notes)
10-
6. [Build Frequently Asked Questions] (#buildfaq)
5+
1. [Overview of AFI Build process](#buildoverview)
6+
2. [Build procedure step by step](#stepbystep)
7+
3. [Build strategies and parallel builds](#strategies)
8+
4. [About Encrption during build process](#buildencryption)
9+
5. [Advanced Notes](#buildadvanced notes)
10+
6. [Build Frequently Asked Questions](#buildfaq)
1111

1212

1313
<a name="buildoverview"></a>
@@ -139,89 +139,7 @@ You need to prepare the following information:
139139
**NOTE**: *The PCI IDs for the example CLs should be found in the README files in the respective CL example directory.
140140
If you are building a custom CL, then you need to incorporate these values in your design as shown in the [AWS Shell Interface Specifications](./../../../../docs/AWS_Shell_Interface_Specification.md#pcie-ids).*
141141

142-
To upload your tarball file to S3, you can use any of [the tools supported by S3](http://docs.aws.amazon.com/AmazonS3/latest/dev/UploadingObjects.html)).
143-
For example, you can use the AWS CLI as follows:
144-
145-
$ aws s3 mb s3://<bucket-name> # Create an S3 bucket (choose a unique bucket name)
146-
$ aws s3 cp *.Developer_CL.tar \ # Upload the file to S3
147-
s3://<bucket-name>/
148-
149-
Now you need to provide AWS (Account ID: 365015490807) the appropriate [read/write permissions](http://docs.aws.amazon.com/AmazonS3/latest/dev/example-walkthroughs-managing-access-example2.html) to your S3 buckets.
150-
Below is a sample policy.
151-
152-
**NOTE**: *The AWS Account ID has changed, please ensure you are using the correct Account ID listed here.*
153-
154-
{
155-
"Version": "2012-10-17",
156-
"Statement": [
157-
{
158-
"Sid": "Bucket level permissions",
159-
"Effect": "Allow",
160-
"Principal": {
161-
"AWS": "arn:aws:iam::365015490807:root"
162-
},
163-
"Action": [
164-
"s3:ListBucket"
165-
],
166-
"Resource": "arn:aws:s3:::<bucket_name>"
167-
},
168-
{
169-
"Sid": "Object read permissions",
170-
"Effect": "Allow",
171-
"Principal": {
172-
"AWS": "arn:aws:iam::365015490807:root"
173-
},
174-
"Action": [
175-
"s3:GetObject"
176-
],
177-
"Resource": "arn:aws:s3:::<dcp_bucket_name>/<dcp_filename>"
178-
},
179-
{
180-
"Sid": "Folder write permissions",
181-
"Effect": "Allow",
182-
"Principal": {
183-
"AWS": "arn:aws:iam::365015490807:root"
184-
},
185-
"Action": [
186-
"s3:PutObject"
187-
],
188-
"Resource": "arn:aws:s3:::<log_bucket_name>/*"
189-
}
190-
]
191-
}
192-
193-
You can verify that the bucket policy grants the required permissions by running the following script:
194-
195-
$ check_s3_bucket_policy.py \
196-
--dcp-bucket <dcp-bucket-name> \
197-
--dcp-key <tarball-name> \
198-
--logs-bucket <logs-bucket-name> \
199-
--logs-key <logs-folder>
200-
201-
To create an AFI execute the following command:
202-
203-
$ aws ec2 create-fpga-image \
204-
--name <afi-name> \
205-
--description <afi-description> \
206-
--input-storage-location Bucket=<dcp-bucket-name>,Key=<tarball-name> \
207-
--logs-storage-location Bucket=<logs-bucket-name>,Key=<logs-folder> \
208-
[ --client-token <value> ] \
209-
[ --dry-run | --no-dry-run ]
210-
211-
The output of this command includes two identifiers that refer to your AFI:
212-
- **FPGA Image Identifier** or **AFI ID**: this is the main ID used to manage your AFI through the AWS EC2 CLI commands and AWS SDK APIs.
213-
This ID is regional, i.e., if an AFI is copied across multiple regions, it will have a different unique AFI ID in each region.
214-
An example AFI ID is **`afi-01234567890abcdef`**.
215-
- **Glogal FPGA Image Identifier** or **AGFI ID**: this is a global ID that is used to refer to an AFI from within an F1 instance.
216-
For example, to load or clear an AFI from an FPGA slot, you use the AGFI ID.
217-
Since the AGFI IDs is global (by design), it allows you to copy a combination of AFI/AMI to multiple regions, and they will work without requiring any extra setup.
218-
An example AGFI ID is **`agfi-01234567890abcdef`**.
219-
220-
After the AFI generation is complete, AWS will put the logs into the bucket location provided by the developer and notify them
221-
by email.
222-
223-
**NOTE**: *Attempting to associate the AFI to an AMI before the AFI is ready will result in an `InvalidFpgaImageID.Unavailable` error.
224-
Please wait until you receive a confirmation email from AWS indicating the creation process is complete.*
142+
[Refer to step 3 for instructions on how to submit the Design Checkpoint to AWS](./../../../../cl/examples/README.md)
225143

226144
<a name="buildstratgies"></a>
227145
## Build Strategies and Parallel Builds

0 commit comments

Comments
 (0)