This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
springremote [2020/06/02 09:17] nelson [Option #4: Run Xilinx Software on Lab Machines But Program Board with Mac] |
springremote [2020/09/02 17:06] (current) nelson [Option #5: Vivado on a Linux Virtual Machine] |
||
---|---|---|---|
Line 47: | Line 47: | ||
That should do it. | That should do it. | ||
-------------------- | -------------------- | ||
- | =====Option #2: Vivado on a Linux Virtual Machine===== | ||
- | Using the VMWare software, you will boot and run a copy of the Linux operating system | + | ===== Option #2: Run Xilinx Software on Lab Machines But Program Locally Using Adept2 (Windows)===== |
- | on your own computer. You can run this on either a Windows machine or a Mac, but this is the | + | |
- | only option for you if you have a Mac. | + | |
- | + | ||
- | PROS: | + | |
- | * You will be using a "standard" setup, created by the department. If there are problems with your use of it, the TA's and professors should be able to help debug. | + | |
- | * You need not download and install the Xilinx software - it is already installed inside the virtual machine for you. | + | |
- | * You will learn some Linux which is an important skill to learn in your studies. | + | |
- | + | ||
- | CONS: | + | |
- | * It can be a bit resource-intensive (you are running Linux and your own computer's operating systems at the same time). | + | |
- | * There is an extra layer of complexity with this operating- system-inside-an-operating-system. Having the virtual machine involved may require extra attention to some details to keep it working. | + | |
- | * Will take up 30-60 GB of disk space on your machine as you install it, less once the install is done and you delete all the intermediate files. | + | |
- | + | ||
- | ==== Instructions==== | + | |
- | There are 2 sets of instructions below which you need to choose between. Which one to use will depend on how confident you are that your internet connection can download a 25GB file without dropping the connection... | + | |
- | + | ||
- | ===Safer Instructions But More Steps (use if your internet connection sometimes drops connections)=== | + | |
- | Before you proceed, read the entire set of instructions //including the Additional Notes below//. This will help you get it right the first time. | + | |
- | + | ||
- | - Ensure you can log into box.byu.edu. | + | |
- | - Follow [[https://byu.box.com/s/xluj4yxd3r9ggmlfis9mweyk5bhni8i1|this link]] which is a Box directory and which {{ ::vminstall1.pdf |and which looks like this}}. Download all the files there into a directory on your machine. There will be 13 files. It was broken into that many files so that if your transfer gets interrupted by an Internet problem, you won't have lost 3 hours of downloading, just a few minutes. Files .z01 through .z12 should be 2GB in size and the .zip file should be 352MB in size. | + | |
- | - You may download them one at a time or you may select a few to do at once. Just be aware if you do the latter, the system will ZIP them together and you will need to unzip those to get back to the 13 files you need. | + | |
- | - Once you have those files all together in a directory on your machine, you will need to combine them and then unzip them. How you do this will depend on what machine you are on. | + | |
- | * On a Mac, I have had good results with [[https://www.keka.io/en/|Keka]]. After downloading it, then right-click the .z01 file and select Services->Extract Using Keka {{ ::keka1.pdf |as shown here}}. | + | |
- | * On Windows, download and install 7 Zip. If you then right-click the top zip file, there is an option for 7 zip and then you choose extract all. | + | |
- | - What you will be left with on your machine should be a directory called Student_Ubuntu16.04.6_Xilinx-2017.2 with 3 files in it: Student_Ubuntu18.04.2_Xilinx-2019.1-disk1.vmdk, Student_Ubuntu18.04.2_Xilinx-2019.1.mf, and Student_Ubuntu18.04.2_Xilinx-2019.1.ovf. Those are what you want. | + | |
- | - Now, install a copy of VMWare | + | |
- | * Go to https://caedm.et.byu.edu/wiki/index.php/VMWARE_Academic_Program | + | |
- | * Click on "VMWare Academic Program Website". | + | |
- | * Login using CAEDM credentials. | + | |
- | * Download and install Fusion 11 (Mac) or Workstation 15 (Windows or Linux). The VMWare website should email you the license key. | + | |
- | - Using the Vmware you just installed, import the file you downloaded in Steps 1-3. You do this by going to the File menu, then click Open. This will create a virtual machine. Tell VMWare to save it in a good place (like in your home directory). | + | |
- | - You log into the resulting virtual machine using the username //student//, with the password //fpga//. At this point you are running a full-blown Linux system, the Ubuntu18.04.2 distribution to be precise. | + | |
- | - If you are worried about disk space you can now safely delete all the zip files and pieces you downloaded. Or, you could keep them for a while if you think you might have to re-do this in the future. | + | |
- | + | ||
- | Congrats! You made it. | + | |
- | + | ||
- | === Additonal Notes on the Steps Above: === | + | |
- | * If you download the pieces one at a time then you won't lose as much work if the transfer dies due to an internet problem. If you have good internet you may want to download the entire directory before you go to bed. | + | |
- | * Or, you may want to experiment - I found that if I select more than one file at a time to download, then Box will make a zip file to combine them into. If it does this you will have to uncombine them before you can continue above. | + | |
- | * At any rate, what is needed is all the original pieces in one directory by themselves. | + | |
- | * It was mentioned above that after you have all the pieces in a directory by themselves, that your method may combine the zip parts together and unzip them into the 3 files you need for VMWare in one step. That is ideal. Once you have the imported machine you can delete all the files you downloaded. | + | |
- | * However, your method //may// combine the zip file parts you downloaded into one big zip file, which you then have to unzip in a second step to get the 3 files needed. If that is the case, you may run out of disk space. | + | |
- | * If this is the case with your machine, you may delete all the parts files once you have a single big zip file to save space. | + | |
- | * Just be CAREFUL - if the resulting big zip file has a problem but you have deleted the parts, you may have to download the parts again. So, if you don't have sufficient disk space, you may choose to use an external disk to hold the parts, for example, so you don't run out of space. | + | |
- | + | ||
- | === Alternative Instructions With Fewer Steps (use if you are not worried about dropped connections) === | + | |
- | If you have good internet connectivity and are not worried about one huge download never completing without error, the steps below are easier than above: | + | |
- | + | ||
- | - Ensure you can log into box.byu.edu. | + | |
- | - Follow [[https://byu.box.com/s/khnz570wx9ue9988id041rsmfdjcod4x|this link]] which is a Box directory. Download the 3 files there into a directory on your machine. Two of them are small, one is >20GB in size. They should be: Student_Ubuntu18.04.2_Xilinx-2019.1-disk1.vmdk, Student_Ubuntu18.04.2_Xilinx-2019.1.mf, and Student_Ubuntu18.04.2_Xilinx-2019.1.ovf. Those are what you want. | + | |
- | - Now, install a copy of VMWare | + | |
- | * Go to https://caedm.et.byu.edu/wiki/index.php/VMWARE_Academic_Program | + | |
- | * Click on "VMWare Academic Program Website". | + | |
- | * Login using CAEDM credentials. | + | |
- | * Download and install Fusion 11 (Mac) or Workstation 15 (Windows or Linux) | + | |
- | - Using the VMWare you just installed, import the files you downloaded in Steps 1-3 (the .ovf file is what VMWare is looking for). You do this by going to the File menu, then click Open. This will create a virtual machine. Tell VMWare to save it in a safe place (like in your home directory ). | + | |
- | - You log into the resulting virtual machine using the username //student//, with the password //fpga//. At this point you are running Linux, the Ubuntu18.04.2 distribution to be precise. | + | |
- | - If you are worried about disk space you can now safely delete all the zip files and pieces you downloaded. Or, you could keep them for a while if you think you might have to re-do this in the future. | + | |
- | + | ||
- | . | + | |
- | -------------------- | + | |
- | ===== Option #3: Run Xilinx Software on Lab Machines ===== | + | |
You will use the "LabConnect" software from the college to run Vivado on the lab | You will use the "LabConnect" software from the college to run Vivado on the lab | ||
Line 154: | Line 90: | ||
-------------------- | -------------------- | ||
- | ===== Option #4: Run Xilinx Software on Lab Machines But Program Board with Mac===== | + | ===== Option #3: Run Xilinx Software on Lab Machines But Program Locally Using openocd (Mac or Linux)===== |
- | If you have problems with Option #2 you can use this one. It is a hybrid of #2 and #3 and requires a much smaller download. | + | |
- | This assumes you will use LabConnect as in Option #3. CAEDM does have a LabConnect option - follow the instructions above but do the Mac version of the install. Most everything else is similar. Once you have LabConnect installed you will be able to do Vivado designs on a lab machine in the department. | + | If you have problems with Options #2 or #5 you can use this one. It is a hybrid of #2 and #3 and requires a much smaller download (has the same pros and cons as Option #2). |
+ | |||
+ | This assumes you will use LabConnect as in Option #2. CAEDM does have a LabConnect option to allow you to work on the BYU lab machines - follow the instructions above but do the Mac version of the install. Most everything else is similar. Once you have LabConnect installed you will be able to do Vivado designs on a lab machine in the department. | ||
+ | |||
+ | The problem is that once you finish your design, you need a way to get the .bit file onto your local machine to program the board you have. The following instructions show how to set up that step. | ||
+ | |||
+ | Now, follow the instructions at: [[https://github.com/byu-cpe/BYU-Computing-Tutorials/wiki/Program-7-Series-FPGA-from-a-Mac-or-Linux-Without-Xilinx]]. It will show you how you can program the board directly from your Mac (or any other machine that will run 'openocd'. | ||
+ | -------------------- | ||
+ | |||
+ | =====Option #4: Run Xilinx Software on Lab Machines But Program Locally Using A Linux VM and Vivado_Labs (Mac)===== | ||
+ | |||
+ | This uses LabConnect like Options #2 and #3 but then uses a Linux Virtual Machine containing a stub of Vivado called 'Vivado_Labs' to actually program the board. You would only use this if Option #3 fails for you. It requires a much larger download and is much more complex than above. | ||
+ | |||
+ | This assumes you will use LabConnect as in Options #2 and #3. Follow the instructions in Option #2 above but do the Mac version of the install. Most everything else is similar. Once you have LabConnect installed you will be able to do Vivado designs on a lab machine in the department. | ||
The problem is that once you finish your design, you need a way to get the .bit file onto your local machine to program the board you have. The following instructions show how to set up that step. | The problem is that once you finish your design, you need a way to get the .bit file onto your local machine to program the board you have. The following instructions show how to set up that step. | ||
Line 166: | Line 114: | ||
- Later, you may need to be able to transfer things from your Mac to your Linux VM (like bitstreams if you upload them to your Mac). To do so, here [[https://byu.box.com/s/hocmgtxk2669t541hw7awaif5hd5i97d|is a video on that]]. | - Later, you may need to be able to transfer things from your Mac to your Linux VM (like bitstreams if you upload them to your Mac). To do so, here [[https://byu.box.com/s/hocmgtxk2669t541hw7awaif5hd5i97d|is a video on that]]. | ||
- | So, the big picture is this: (a) use LabConnect to do FPGA design on the department lab machines, (b) copy the resulting .bit file from the department machine to your local machine (in the Linux machine), (c) program the .bit file into the FPGA using vivado_lab. | + | -------------------- |
- | -------------------- | + | =====Option #5: Vivado on a Linux Virtual Machine===== |
- | ===== Option #5: Run Xilinx Software on Lab Machines But Program Board on either a Mac or Linux Machine Using openocd===== | + | Using the VMWare software, you will boot and run a copy of the Linux operating system |
- | If you have problems with Options #2 or #5 you can use this one. It is a hybrid of #2 and #3 and requires a much smaller download. | + | on your own computer. You can run this on either a Windows machine or a Mac, but the main use for this is if you have a Mac. |
- | This assumes you will use LabConnect as in Option #3. CAEDM does have a LabConnect option to allow you to work on the BYU lab machines - follow the instructions above but do the Mac version of the install. Most everything else is similar. Once you have LabConnect installed you will be able to do Vivado designs on a lab machine in the department. | + | PROS: |
+ | * You will be using a "standard" setup, created by the department. If there are problems with your use of it, the TA's and professors should be able to help debug. | ||
+ | * You need not download and install the Xilinx software - it is already installed inside the virtual machine for you. | ||
+ | * You will learn some Linux which is an important skill to learn in your studies. | ||
- | The problem is that once you finish your design, you need a way to get the .bit file onto your local machine to program the board you have. The following instructions show how to set up that step. | + | CONS: |
+ | * It can be a bit resource-intensive (you are running Linux and your own computer's operating systems at the same time). | ||
+ | * There is an extra layer of complexity with this operating- system-inside-an-operating-system. Having the virtual machine involved may require extra attention to some details to keep it working. | ||
+ | * Will take up > 70 GB of disk space on your machine during the install. Once it is installed then it takes up about half that (after you delete the intermediate files). | ||
- | Now, follow the instructions at: [[https://github.com/byu-cpe/BYU-Computing-Tutorials/wiki/Program-7-Series-FPGA-from-a-Mac-or-Linux-Without-Xilinx]]. It will show you how you can program the board directly from your Mac (or any other machine that will run 'openocd'. | + | Before you start be aware that you need to have sufficient RAM as well. I have 16 GB on my machine and 12 CPU cores. I give 8GB RAM and 6 cores and it runs well. What you only gave it 4GB? Don't know for sure but I believe students have been OK with that. |
- | So, the big picture is this: (a) use LabConnect to do FPGA design on the department lab machines, (b) copy the resulting .bit file from the department machine to your local machine (in the Linux machine), (c) program the .bit file into the FPGA using openocd. | + | ==== Instructions==== |
+ | There are 2 sets of instructions below which you need to choose between. Which one to use will depend on how confident you are that your internet connection can download a 25GB file without dropping the connection... | ||
+ | ===Safer Instructions But More Steps (use if your internet connection sometimes drops connections)=== | ||
+ | Before you proceed, read the entire set of instructions //including the Additional Notes below//. This will help you get it right the first time. | ||
+ | - Ensure you can log into box.byu.edu. | ||
+ | - Follow [[https://byu.box.com/s/xluj4yxd3r9ggmlfis9mweyk5bhni8i1|this link]] which is a Box directory and which {{ ::vminstall1.pdf |and which looks like this}}. Download all the files there into a directory on your machine. There will be 13 files. It was broken into that many files so that if your transfer gets interrupted by an Internet problem, you won't have lost 3 hours of downloading, just a few minutes. Files .z01 through .z12 should be 2GB in size and the .zip file should be 352MB in size. | ||
+ | - You may download them one at a time or you may select a few to do at once. Just be aware if you do the latter, the system will ZIP them together and you will need to unzip those to get back to the 13 files you need. | ||
+ | - Once you have those files all together in a directory on your machine, you will need to combine them and then unzip them. How you do this will depend on what machine you are on. | ||
+ | * On a Mac, I have had good results with [[https://www.keka.io/en/|Keka]]. After downloading it, then right-click the .z01 file and select Services->Extract Using Keka {{ ::keka1.pdf |as shown here}}. | ||
+ | * On Windows, download and install 7 Zip. If you then right-click the top zip file, there is an option for 7 zip and then you choose extract all. | ||
+ | - What you will be left with on your machine should be a directory called Student_Ubuntu16.04.6_Xilinx-2017.2 with 3 files in it: Student_Ubuntu18.04.2_Xilinx-2019.1-disk1.vmdk, Student_Ubuntu18.04.2_Xilinx-2019.1.mf, and Student_Ubuntu18.04.2_Xilinx-2019.1.ovf. Those are what you want. | ||
+ | - Now, install a copy of VMWare | ||
+ | * Go to https://caedm.et.byu.edu/wiki/index.php/VMWARE_Academic_Program | ||
+ | * Click on "VMWare Academic Program Website". | ||
+ | * Login using CAEDM credentials. | ||
+ | * Download and install Fusion 11 (Mac) or Workstation 15 (Windows or Linux). The VMWare website should email you the license key. | ||
+ | - Using the Vmware you just installed, import the file you downloaded in Steps 1-3. You do this by going to the File menu, then click Open. This will create a virtual machine. Tell VMWare to save it in a good place (like in your home directory). | ||
+ | - You log into the resulting virtual machine using the username //student//, with the password //fpga//. At this point you are running a full-blown Linux system, the Ubuntu18.04.2 distribution to be precise. | ||
+ | - If you are worried about disk space you can now safely delete all the zip files and pieces you downloaded. Or, you could keep them for a while if you think you might have to re-do this in the future. | ||
+ | |||
+ | Congrats! You made it. | ||
+ | |||
+ | === Additonal Notes on the Steps Above: === | ||
+ | * If you download the pieces one at a time then you won't lose as much work if the transfer dies due to an internet problem. If you have good internet you may want to download the entire directory before you go to bed. | ||
+ | * Or, you may want to experiment - I found that if I select more than one file at a time to download, then Box will make a zip file to combine them into. If it does this you will have to uncombine them before you can continue above. | ||
+ | * At any rate, what is needed is all the original pieces in one directory by themselves. | ||
+ | * It was mentioned above that after you have all the pieces in a directory by themselves, that your method may combine the zip parts together and unzip them into the 3 files you need for VMWare in one step. That is ideal. Once you have the imported machine you can delete all the files you downloaded. | ||
+ | * However, your method //may// combine the zip file parts you downloaded into one big zip file, which you then have to unzip in a second step to get the 3 files needed. If that is the case, you may run out of disk space. | ||
+ | * If this is the case with your machine, you may delete all the parts files once you have a single big zip file to save space. | ||
+ | * Just be CAREFUL - if the resulting big zip file has a problem but you have deleted the parts, you may have to download the parts again. So, if you don't have sufficient disk space, you may choose to use an external disk to hold the parts, for example, so you don't run out of space. | ||
+ | |||
+ | === Alternative Instructions With Fewer Steps (use if you are not worried about dropped connections) === | ||
+ | If you have good internet connectivity and are not worried about one huge download never completing without error, the steps below are easier than above: | ||
+ | |||
+ | - Ensure you can log into box.byu.edu. | ||
+ | - Follow [[https://byu.box.com/s/khnz570wx9ue9988id041rsmfdjcod4x|this link]] which is a Box directory. Download the 3 files there into a directory on your machine. Two of them are small, one is >20GB in size. They should be: Student_Ubuntu18.04.2_Xilinx-2019.1-disk1.vmdk, Student_Ubuntu18.04.2_Xilinx-2019.1.mf, and Student_Ubuntu18.04.2_Xilinx-2019.1.ovf. Those are what you want. | ||
+ | - Now, install a copy of VMWare | ||
+ | * Go to https://caedm.et.byu.edu/wiki/index.php/VMWARE_Academic_Program | ||
+ | * Click on "VMWare Academic Program Website". | ||
+ | * Login using CAEDM credentials. | ||
+ | * Download and install Fusion 11 (Mac) or Workstation 15 (Windows or Linux) | ||
+ | - Using the VMWare you just installed, import the files you downloaded in Steps 1-3 (the .ovf file is what VMWare is looking for). You do this by going to the File menu, then click Open. This will create a virtual machine. Tell VMWare to save it in a safe place (like in your home directory ). | ||
+ | - You log into the resulting virtual machine using the username //student//, with the password //fpga//. At this point you are running Linux, the Ubuntu18.04.2 distribution to be precise. | ||
+ | - If you are worried about disk space you can now safely delete all the zip files and pieces you downloaded. Or, you could keep them for a while if you think you might have to re-do this in the future. | ||
+ | |||
+ | . | ||
-------------------- | -------------------- | ||
=====How To Choose:===== | =====How To Choose:===== |