diff --git a/autobuilder b/autobuilder index 23893d7..01a5a86 100755 --- a/autobuilder +++ b/autobuilder @@ -29,7 +29,7 @@ echo " Verifying main directory..." proceed #error check echo " DONE!" echo " Entering the library directory..." -cd cylib && proceed=1 #cd to the lib dir +cd configutility/linux/cylib && proceed=1 #cd to the lib dir proceed #error check echo " DONE!" echo " Compiling and installing the library..." @@ -38,7 +38,7 @@ proceed echo " DONE!" echo " Library installation complete." echo " Going back..." -cd .. && proceed=1 #to main dir +cd ../../.. && proceed=1 #to main dir proceed echo " DONE!" echo " Entering the TinI/O build directory" diff --git a/configutility/README.txt b/configutility/README.txt deleted file mode 100644 index 96450c3..0000000 --- a/configutility/README.txt +++ /dev/null @@ -1,36 +0,0 @@ -======================================================================================== - Cypress Semiconductor Corporation - CyUSB Serial library. -========================================================================================= -Pre-requisite: -1. libusb-1.0.9 is required for compilation and functioning of the APIs in the library. -2. GNU Make and the GCC tool-chain are used for the build process. - -Installation steps: - -1.cd to the main directory where the library source files are extracted and goto ./linux/library - -2.Type 'sudo make'. - -2.This will generate shared library libcyusbserial.so.1 and its soft link libcyusbserial.so. - Both of them will be copied/installed to /usr/local/lib. - -3.Go to ./linux/testUtility (I2C/SPI test utility program) and type 'sudo make'. -This will generate CyUSBSerialTestUtility binary (Refer to README in testUtility folder). - -4.User can launch the application and test the communication with Cypress USB-Serial DVk in vendor mode. - -Changing USB device node permission: - -By default the USB device node created in linux do not have read/write permission -for normal user. In order to make the USB device node accessable, copy 90-cyusb.rules -which is inside the library folder of release package to /etc/udev/rules.d folder (Default VID mentioned is Cypress VID -which is 0x4B4, if VID is changed then update it in ATTR{idVendor} section of rules file). - -*** IMPORTANT: -Some distribution of linux have libusb (older version) as part of their package. Uninstall -the older version and update it with libusb-1.0.9. - -**Note: -Refer to ./common/doc/CyUSBSerial API documentation.pdf for description of all -the vendor mode APIs. The header file of the library is in ./common/header/CyUSBSerial.h. diff --git a/configutility/license/license.txt b/configutility/license/license.txt deleted file mode 100644 index 5faba9d..0000000 --- a/configutility/license/license.txt +++ /dev/null @@ -1,504 +0,0 @@ - GNU LESSER GENERAL PUBLIC LICENSE - Version 2.1, February 1999 - - Copyright (C) 1991, 1999 Free Software Foundation, Inc. - 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - -[This is the first released version of the Lesser GPL. It also counts - as the successor of the GNU Library Public License, version 2, hence - the version number 2.1.] - - Preamble - - The licenses for most software are designed to take away your -freedom to share and change it. By contrast, the GNU General Public -Licenses are intended to guarantee your freedom to share and change -free software--to make sure the software is free for all its users. - - This license, the Lesser General Public License, applies to some -specially designated software packages--typically libraries--of the -Free Software Foundation and other authors who decide to use it. You -can use it too, but we suggest you first think carefully about whether -this license or the ordinary General Public License is the better -strategy to use in any particular case, based on the explanations below. - - When we speak of free software, we are referring to freedom of use, -not price. Our General Public Licenses are designed to make sure that -you have the freedom to distribute copies of free software (and charge -for this service if you wish); that you receive source code or can get -it if you want it; that you can change the software and use pieces of -it in new free programs; and that you are informed that you can do -these things. - - To protect your rights, we need to make restrictions that forbid -distributors to deny you these rights or to ask you to surrender these -rights. These restrictions translate to certain responsibilities for -you if you distribute copies of the library or if you modify it. - - For example, if you distribute copies of the library, whether gratis -or for a fee, you must give the recipients all the rights that we gave -you. You must make sure that they, too, receive or can get the source -code. If you link other code with the library, you must provide -complete object files to the recipients, so that they can relink them -with the library after making changes to the library and recompiling -it. And you must show them these terms so they know their rights. - - We protect your rights with a two-step method: (1) we copyright the -library, and (2) we offer you this license, which gives you legal -permission to copy, distribute and/or modify the library. - - To protect each distributor, we want to make it very clear that -there is no warranty for the free library. Also, if the library is -modified by someone else and passed on, the recipients should know -that what they have is not the original version, so that the original -author's reputation will not be affected by problems that might be -introduced by others. - - Finally, software patents pose a constant threat to the existence of -any free program. We wish to make sure that a company cannot -effectively restrict the users of a free program by obtaining a -restrictive license from a patent holder. Therefore, we insist that -any patent license obtained for a version of the library must be -consistent with the full freedom of use specified in this license. - - Most GNU software, including some libraries, is covered by the -ordinary GNU General Public License. This license, the GNU Lesser -General Public License, applies to certain designated libraries, and -is quite different from the ordinary General Public License. We use -this license for certain libraries in order to permit linking those -libraries into non-free programs. - - When a program is linked with a library, whether statically or using -a shared library, the combination of the two is legally speaking a -combined work, a derivative of the original library. The ordinary -General Public License therefore permits such linking only if the -entire combination fits its criteria of freedom. The Lesser General -Public License permits more lax criteria for linking other code with -the library. - - We call this license the "Lesser" General Public License because it -does Less to protect the user's freedom than the ordinary General -Public License. It also provides other free software developers Less -of an advantage over competing non-free programs. These disadvantages -are the reason we use the ordinary General Public License for many -libraries. However, the Lesser license provides advantages in certain -special circumstances. - - For example, on rare occasions, there may be a special need to -encourage the widest possible use of a certain library, so that it becomes -a de-facto standard. To achieve this, non-free programs must be -allowed to use the library. A more frequent case is that a free -library does the same job as widely used non-free libraries. In this -case, there is little to gain by limiting the free library to free -software only, so we use the Lesser General Public License. - - In other cases, permission to use a particular library in non-free -programs enables a greater number of people to use a large body of -free software. For example, permission to use the GNU C Library in -non-free programs enables many more people to use the whole GNU -operating system, as well as its variant, the GNU/Linux operating -system. - - Although the Lesser General Public License is Less protective of the -users' freedom, it does ensure that the user of a program that is -linked with the Library has the freedom and the wherewithal to run -that program using a modified version of the Library. - - The precise terms and conditions for copying, distribution and -modification follow. Pay close attention to the difference between a -"work based on the library" and a "work that uses the library". The -former contains code derived from the library, whereas the latter must -be combined with the library in order to run. - - GNU LESSER GENERAL PUBLIC LICENSE - TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION - - 0. This License Agreement applies to any software library or other -program which contains a notice placed by the copyright holder or -other authorized party saying it may be distributed under the terms of -this Lesser General Public License (also called "this License"). -Each licensee is addressed as "you". - - A "library" means a collection of software functions and/or data -prepared so as to be conveniently linked with application programs -(which use some of those functions and data) to form executables. - - The "Library", below, refers to any such software library or work -which has been distributed under these terms. A "work based on the -Library" means either the Library or any derivative work under -copyright law: that is to say, a work containing the Library or a -portion of it, either verbatim or with modifications and/or translated -straightforwardly into another language. (Hereinafter, translation is -included without limitation in the term "modification".) - - "Source code" for a work means the preferred form of the work for -making modifications to it. For a library, complete source code means -all the source code for all modules it contains, plus any associated -interface definition files, plus the scripts used to control compilation -and installation of the library. - - Activities other than copying, distribution and modification are not -covered by this License; they are outside its scope. The act of -running a program using the Library is not restricted, and output from -such a program is covered only if its contents constitute a work based -on the Library (independent of the use of the Library in a tool for -writing it). Whether that is true depends on what the Library does -and what the program that uses the Library does. - - 1. You may copy and distribute verbatim copies of the Library's -complete source code as you receive it, in any medium, provided that -you conspicuously and appropriately publish on each copy an -appropriate copyright notice and disclaimer of warranty; keep intact -all the notices that refer to this License and to the absence of any -warranty; and distribute a copy of this License along with the -Library. - - You may charge a fee for the physical act of transferring a copy, -and you may at your option offer warranty protection in exchange for a -fee. - - 2. You may modify your copy or copies of the Library or any portion -of it, thus forming a work based on the Library, and copy and -distribute such modifications or work under the terms of Section 1 -above, provided that you also meet all of these conditions: - - a) The modified work must itself be a software library. - - b) You must cause the files modified to carry prominent notices - stating that you changed the files and the date of any change. - - c) You must cause the whole of the work to be licensed at no - charge to all third parties under the terms of this License. - - d) If a facility in the modified Library refers to a function or a - table of data to be supplied by an application program that uses - the facility, other than as an argument passed when the facility - is invoked, then you must make a good faith effort to ensure that, - in the event an application does not supply such function or - table, the facility still operates, and performs whatever part of - its purpose remains meaningful. - - (For example, a function in a library to compute square roots has - a purpose that is entirely well-defined independent of the - application. Therefore, Subsection 2d requires that any - application-supplied function or table used by this function must - be optional: if the application does not supply it, the square - root function must still compute square roots.) - -These requirements apply to the modified work as a whole. If -identifiable sections of that work are not derived from the Library, -and can be reasonably considered independent and separate works in -themselves, then this License, and its terms, do not apply to those -sections when you distribute them as separate works. But when you -distribute the same sections as part of a whole which is a work based -on the Library, the distribution of the whole must be on the terms of -this License, whose permissions for other licensees extend to the -entire whole, and thus to each and every part regardless of who wrote -it. - -Thus, it is not the intent of this section to claim rights or contest -your rights to work written entirely by you; rather, the intent is to -exercise the right to control the distribution of derivative or -collective works based on the Library. - -In addition, mere aggregation of another work not based on the Library -with the Library (or with a work based on the Library) on a volume of -a storage or distribution medium does not bring the other work under -the scope of this License. - - 3. You may opt to apply the terms of the ordinary GNU General Public -License instead of this License to a given copy of the Library. To do -this, you must alter all the notices that refer to this License, so -that they refer to the ordinary GNU General Public License, version 2, -instead of to this License. (If a newer version than version 2 of the -ordinary GNU General Public License has appeared, then you can specify -that version instead if you wish.) Do not make any other change in -these notices. - - Once this change is made in a given copy, it is irreversible for -that copy, so the ordinary GNU General Public License applies to all -subsequent copies and derivative works made from that copy. - - This option is useful when you wish to copy part of the code of -the Library into a program that is not a library. - - 4. You may copy and distribute the Library (or a portion or -derivative of it, under Section 2) in object code or executable form -under the terms of Sections 1 and 2 above provided that you accompany -it with the complete corresponding machine-readable source code, which -must be distributed under the terms of Sections 1 and 2 above on a -medium customarily used for software interchange. - - If distribution of object code is made by offering access to copy -from a designated place, then offering equivalent access to copy the -source code from the same place satisfies the requirement to -distribute the source code, even though third parties are not -compelled to copy the source along with the object code. - - 5. A program that contains no derivative of any portion of the -Library, but is designed to work with the Library by being compiled or -linked with it, is called a "work that uses the Library". Such a -work, in isolation, is not a derivative work of the Library, and -therefore falls outside the scope of this License. - - However, linking a "work that uses the Library" with the Library -creates an executable that is a derivative of the Library (because it -contains portions of the Library), rather than a "work that uses the -library". The executable is therefore covered by this License. -Section 6 states terms for distribution of such executables. - - When a "work that uses the Library" uses material from a header file -that is part of the Library, the object code for the work may be a -derivative work of the Library even though the source code is not. -Whether this is true is especially significant if the work can be -linked without the Library, or if the work is itself a library. The -threshold for this to be true is not precisely defined by law. - - If such an object file uses only numerical parameters, data -structure layouts and accessors, and small macros and small inline -functions (ten lines or less in length), then the use of the object -file is unrestricted, regardless of whether it is legally a derivative -work. (Executables containing this object code plus portions of the -Library will still fall under Section 6.) - - Otherwise, if the work is a derivative of the Library, you may -distribute the object code for the work under the terms of Section 6. -Any executables containing that work also fall under Section 6, -whether or not they are linked directly with the Library itself. - - 6. As an exception to the Sections above, you may also combine or -link a "work that uses the Library" with the Library to produce a -work containing portions of the Library, and distribute that work -under terms of your choice, provided that the terms permit -modification of the work for the customer's own use and reverse -engineering for debugging such modifications. - - You must give prominent notice with each copy of the work that the -Library is used in it and that the Library and its use are covered by -this License. You must supply a copy of this License. If the work -during execution displays copyright notices, you must include the -copyright notice for the Library among them, as well as a reference -directing the user to the copy of this License. Also, you must do one -of these things: - - a) Accompany the work with the complete corresponding - machine-readable source code for the Library including whatever - changes were used in the work (which must be distributed under - Sections 1 and 2 above); and, if the work is an executable linked - with the Library, with the complete machine-readable "work that - uses the Library", as object code and/or source code, so that the - user can modify the Library and then relink to produce a modified - executable containing the modified Library. (It is understood - that the user who changes the contents of definitions files in the - Library will not necessarily be able to recompile the application - to use the modified definitions.) - - b) Use a suitable shared library mechanism for linking with the - Library. A suitable mechanism is one that (1) uses at run time a - copy of the library already present on the user's computer system, - rather than copying library functions into the executable, and (2) - will operate properly with a modified version of the library, if - the user installs one, as long as the modified version is - interface-compatible with the version that the work was made with. - - c) Accompany the work with a written offer, valid for at - least three years, to give the same user the materials - specified in Subsection 6a, above, for a charge no more - than the cost of performing this distribution. - - d) If distribution of the work is made by offering access to copy - from a designated place, offer equivalent access to copy the above - specified materials from the same place. - - e) Verify that the user has already received a copy of these - materials or that you have already sent this user a copy. - - For an executable, the required form of the "work that uses the -Library" must include any data and utility programs needed for -reproducing the executable from it. However, as a special exception, -the materials to be distributed need not include anything that is -normally distributed (in either source or binary form) with the major -components (compiler, kernel, and so on) of the operating system on -which the executable runs, unless that component itself accompanies -the executable. - - It may happen that this requirement contradicts the license -restrictions of other proprietary libraries that do not normally -accompany the operating system. Such a contradiction means you cannot -use both them and the Library together in an executable that you -distribute. - - 7. You may place library facilities that are a work based on the -Library side-by-side in a single library together with other library -facilities not covered by this License, and distribute such a combined -library, provided that the separate distribution of the work based on -the Library and of the other library facilities is otherwise -permitted, and provided that you do these two things: - - a) Accompany the combined library with a copy of the same work - based on the Library, uncombined with any other library - facilities. This must be distributed under the terms of the - Sections above. - - b) Give prominent notice with the combined library of the fact - that part of it is a work based on the Library, and explaining - where to find the accompanying uncombined form of the same work. - - 8. You may not copy, modify, sublicense, link with, or distribute -the Library except as expressly provided under this License. Any -attempt otherwise to copy, modify, sublicense, link with, or -distribute the Library is void, and will automatically terminate your -rights under this License. However, parties who have received copies, -or rights, from you under this License will not have their licenses -terminated so long as such parties remain in full compliance. - - 9. You are not required to accept this License, since you have not -signed it. However, nothing else grants you permission to modify or -distribute the Library or its derivative works. These actions are -prohibited by law if you do not accept this License. Therefore, by -modifying or distributing the Library (or any work based on the -Library), you indicate your acceptance of this License to do so, and -all its terms and conditions for copying, distributing or modifying -the Library or works based on it. - - 10. Each time you redistribute the Library (or any work based on the -Library), the recipient automatically receives a license from the -original licensor to copy, distribute, link with or modify the Library -subject to these terms and conditions. You may not impose any further -restrictions on the recipients' exercise of the rights granted herein. -You are not responsible for enforcing compliance by third parties with -this License. - - 11. If, as a consequence of a court judgment or allegation of patent -infringement or for any other reason (not limited to patent issues), -conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot -distribute so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you -may not distribute the Library at all. For example, if a patent -license would not permit royalty-free redistribution of the Library by -all those who receive copies directly or indirectly through you, then -the only way you could satisfy both it and this License would be to -refrain entirely from distribution of the Library. - -If any portion of this section is held invalid or unenforceable under any -particular circumstance, the balance of the section is intended to apply, -and the section as a whole is intended to apply in other circumstances. - -It is not the purpose of this section to induce you to infringe any -patents or other property right claims or to contest validity of any -such claims; this section has the sole purpose of protecting the -integrity of the free software distribution system which is -implemented by public license practices. Many people have made -generous contributions to the wide range of software distributed -through that system in reliance on consistent application of that -system; it is up to the author/donor to decide if he or she is willing -to distribute software through any other system and a licensee cannot -impose that choice. - -This section is intended to make thoroughly clear what is believed to -be a consequence of the rest of this License. - - 12. If the distribution and/or use of the Library is restricted in -certain countries either by patents or by copyrighted interfaces, the -original copyright holder who places the Library under this License may add -an explicit geographical distribution limitation excluding those countries, -so that distribution is permitted only in or among countries not thus -excluded. In such case, this License incorporates the limitation as if -written in the body of this License. - - 13. The Free Software Foundation may publish revised and/or new -versions of the Lesser General Public License from time to time. -Such new versions will be similar in spirit to the present version, -but may differ in detail to address new problems or concerns. - -Each version is given a distinguishing version number. If the Library -specifies a version number of this License which applies to it and -"any later version", you have the option of following the terms and -conditions either of that version or of any later version published by -the Free Software Foundation. If the Library does not specify a -license version number, you may choose any version ever published by -the Free Software Foundation. - - 14. If you wish to incorporate parts of the Library into other free -programs whose distribution conditions are incompatible with these, -write to the author to ask for permission. For software which is -copyrighted by the Free Software Foundation, write to the Free -Software Foundation; we sometimes make exceptions for this. Our -decision will be guided by the two goals of preserving the free status -of all derivatives of our free software and of promoting the sharing -and reuse of software generally. - - NO WARRANTY - - 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO -WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. -EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR -OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY -KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE -IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE -LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME -THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN -WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY -AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU -FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR -CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE -LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING -RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A -FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF -SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH -DAMAGES. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Libraries - - If you develop a new library, and you want it to be of the greatest -possible use to the public, we recommend making it free software that -everyone can redistribute and change. You can do so by permitting -redistribution under these terms (or, alternatively, under the terms of the -ordinary General Public License). - - To apply these terms, attach the following notices to the library. It is -safest to attach them to the start of each source file to most effectively -convey the exclusion of warranty; and each file should have at least the -"copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This library is free software; you can redistribute it and/or - modify it under the terms of the GNU Lesser General Public - License as published by the Free Software Foundation; either - version 2.1 of the License, or (at your option) any later version. - - This library is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - Lesser General Public License for more details. - - You should have received a copy of the GNU Lesser General Public - License along with this library; if not, write to the Free Software - Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA - -Also add information on how to contact you by electronic and paper mail. - -You should also get your employer (if you work as a programmer) or your -school, if any, to sign a "copyright disclaimer" for the library, if -necessary. Here is a sample; alter the names: - - Yoyodyne, Inc., hereby disclaims all copyright interest in the - library `Frob' (a library for tweaking knobs) written by James Random Hacker. - - , 1 April 1990 - Ty Coon, President of Vice - -That's all there is to it! - - diff --git a/cylib/libcyusbserial.so.1 b/cylib/libcyusbserial.so.1 deleted file mode 100755 index 2490c93..0000000 Binary files a/cylib/libcyusbserial.so.1 and /dev/null differ diff --git a/docs/newmanual.md b/docs/newmanual.md index 17772d3..888d71b 100644 --- a/docs/newmanual.md +++ b/docs/newmanual.md @@ -13,7 +13,7 @@ Using TinI/O is free (as beer _and_ speech), because it's licensed under GNU Gen To start using TinI/O, make sure you have: - A computer running some sort of Linux that has: + A free USB port to use the board with - + installed libusb + + libusb 1.0 and its headers installed + 16 MB of free space (or 8 for the bare minimum) + A C and C++ compiler (preferably gcc and g++) @@ -23,255 +23,10 @@ To start using TinI/O, make sure you have: They can be obtained from Cypress, the manufacturer of the chip. The board I personally use and recommend is the [CY8CKIT-049-4xxx PSoC4 prototyping kit](http://www.cypress.com/documentation/development-kitsboards/psoc-4-cy8ckit-049-4xxx-prototyping-kits), but there are more of them out there, for example, the [CYUSBS234 USB-Serial (Single Channel) Development Kit](http://www.cypress.com/documentation/development-kitsboards/cyusbs234-usb-serial-single-channel-development-kit). # Building and installing TinI/O - -## The easy way -After you make sure that your computer complies with the system requirements (it probably does), you need to build and install TinI/O. The simplest way to do that is to run the `autobuilder` script in the project root (aka the folder you downloaded TinI/O source to) __as root__. The script will then start the build process and redirect any text from its underlying programs to the standard output. The output should look like this: - -``` -# ./autobuilder - -------------------------- - Autobuilder for TinI/O 0.1 - -------------------------- - Verifying main directory... - DONE! - Entering the library directory... - DONE! - Compiling and installing the library... -gcc -fPIC -g -Wall -o libcyusb.o -c cyusb.c -I ../../common/header -cyusb.c: In function ‘CyOpen’: -cyusb.c:556:1: warning: ‘rStatus’ may be used uninitialized in this function [-Wmaybe-uninitialized] - printf("rstatus6 %d", rStatus); - ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -gcc -fPIC -g -Wall -o libcyuart.o -c cyuart.c -I ../../common/header -gcc -fPIC -g -Wall -o libcyi2c.o -c cyi2c.c -I ../../common/header -gcc -fPIC -g -Wall -o libcyspi.o -c cyspi.c -I ../../common/header -gcc -fPIC -g -Wall -o libcyphdc.o -c cyphdc.c -I ../../common/header -gcc -fPIC -g -Wall -o libcyjtag.o -c cyjtag.c -I ../../common/header -gcc -fPIC -g -Wall -o libcymisc.o -c cymisc.c -I ../../common/header -gcc -fPIC -g -Wall -o libcyboot.o -c cyboot.c -I ../../common/header -cyboot.c:72:0: warning: "CY_USB_SERIAL_TIMEOUT" redefined - #define CY_USB_SERIAL_TIMEOUT 0 - -In file included from cyboot.c:1:0: -CyUSBCommon.h:74:0: note: this is the location of the previous definition - #define CY_USB_SERIAL_TIMEOUT 5000 - -cyboot.c: In function ‘CyFlashConfigEnable’: -cyboot.c:634:21: warning: unused variable ‘ioTimeout’ [-Wunused-variable] - UINT32 rStatus, ioTimeout = CY_USB_SERIAL_TIMEOUT; - ^~~~~~~~~ -gcc -shared -g -Wl,-soname,libcyusbserial.so -o libcyusbserial.so.1 libcyusb.o libcyuart.o libcyi2c.o libcyspi.o libcyphdc.o libcyjtag.o libcymisc.o libcyboot.o -l usb-1.0 -cp libcyusbserial.so.1 /usr/local/lib -ln -sf /usr/local/lib/libcyusbserial.so.1 /usr/local/lib/libcyusbserial.so -ldconfig -rm -f libcyusb.o libcyuart.o libcyspi.o libcyi2c.o libcyphdc.o libcyjtag.o libcymisc.o libcyboot.o - DONE! - Library installation complete. - Going back... - DONE! - Entering the TinI/O build directory - DONE! - Compiling TinI/O -echo "Building tinio..." -Building tinio... -g++ -lcyusbserial tinio.cpp -o tinio -echo "done." -done. -echo "Installing tinio..." -Installing tinio... -cp tinio /usr/bin -echo "done." -done. - DONE! - Compiling the flasher tool -# gcc -g -o CyUSBSerialTestUtility Test_Utility.c -lcyusbserial -w -gcc -g -o CyUSBSerialCommandUtility Command_Utility.c -lcyusbserial -Command_Utility.c: In function ‘deviceHotPlug’: -Command_Utility.c:102:35: warning: passing argument 1 of ‘CyGetListofDevices’ from incompatible pointer type [-Wincompatible-pointer-types] - rStatus = CyGetListofDevices (&numDevices); - ^ -In file included from Command_Utility.c:33:0: -../../common/header/CyUSBSerial.h:705:30: note: expected ‘UINT8 * {aka unsigned char *}’ but argument is of type ‘int *’ - CYWINEXPORT CY_RETURN_STATUS CyGetListofDevices ( - ^~~~~~~~~~~~~~~~~~ -Command_Utility.c:105:16: warning: ‘return’ with a value, in function returning void - return rStatus; - ^~~~~~~ -Command_Utility.c:95:6: note: declared here - void deviceHotPlug () { - ^~~~~~~~~~~~~ -Command_Utility.c:107:5: warning: implicit declaration of function ‘printListOfDevices’ [-Wimplicit-function-declaration] - printListOfDevices (false); - ^~~~~~~~~~~~~~~~~~ -Command_Utility.c: In function ‘main’: -Command_Utility.c:139:35: warning: passing argument 1 of ‘CyGetListofDevices’ from incompatible pointer type [-Wincompatible-pointer-types] - rStatus = CyGetListofDevices (&numDevices); - ^ -In file included from Command_Utility.c:33:0: -../../common/header/CyUSBSerial.h:705:30: note: expected ‘UINT8 * {aka unsigned char *}’ but argument is of type ‘int *’ - CYWINEXPORT CY_RETURN_STATUS CyGetListofDevices ( - ^~~~~~~~~~~~~~~~~~ -Command_Utility.c:268:51: warning: passing argument 2 of ‘CyReadDeviceConfig’ from incompatible pointer type [-Wincompatible-pointer-types] - rStatus=CyReadDeviceConfig(handle,&read_buffer); - ^ -In file included from Command_Utility.c:34:0: -../../common/header/CyUSBBootloader.h:203:45: note: expected ‘UCHAR * {aka unsigned char *}’ but argument is of type ‘unsigned char (*)[512]’ - CYWINEXPORT CY_RETURN_STATUS WINCALLCONVEN CyReadDeviceConfig ( - ^~~~~~~~~~~~~~~~~~ -Command_Utility.c: At top level: -Command_Utility.c:382:6: warning: conflicting types for ‘printListOfDevices’ - void printListOfDevices (bool isPrint) - ^~~~~~~~~~~~~~~~~~ -Command_Utility.c:107:5: note: previous implicit declaration of ‘printListOfDevices’ was here - printListOfDevices (false); - ^~~~~~~~~~~~~~~~~~ -Command_Utility.c: In function ‘printListOfDevices’: -Command_Utility.c:396:25: warning: passing argument 1 of ‘CyGetListofDevices’ from incompatible pointer type [-Wincompatible-pointer-types] - CyGetListofDevices (&numDevices); - ^ -In file included from Command_Utility.c:33:0: -../../common/header/CyUSBSerial.h:705:30: note: expected ‘UINT8 * {aka unsigned char *}’ but argument is of type ‘int *’ - CYWINEXPORT CY_RETURN_STATUS CyGetListofDevices ( - ^~~~~~~~~~~~~~~~~~ -Command_Utility.c:445:75: warning: backslash and newline separated by space - printf ("%d |%x |%x | %d | %s\n", \ - -cp 90-cyusb.rules /etc/udev/rules.d -cp CyUSBSerialCommandUtility /usr/bin/cy-config -cp CyUSBSerial.sh /usr/bin -chmod 777 /usr/bin/CyUSBSerial.sh - DONE! - - - -The TinI/O installation is completed. - -``` - -If a part of the installation process fails, the script will abort the installation and print out: `Error! The last action autobuild tried to perform failed.` In such case, try also the manual installation described below. If your installation completes succesfully, proceed to the next chapter. - -## The hard way - -In case the automated installation fails, or if you specifically want to build TinI/O manually, you can build TinI/O, the library for it, the flasher tool and the flash files with Makefiles. The order of installation is important: the library must be built first, because TinI/O and the flasher depend on it. - -To build the library, go to the `cylib` directory and run `make`. The output will contain some warnings, which should be ignored. The output should look like this: - ``` - make - gcc -fPIC -g -Wall -o libcyusb.o -c cyusb.c -I ../../common/header - cyusb.c: In function ‘CyOpen’: - cyusb.c:556:1: warning: ‘rStatus’ may be used uninitialized in this function [-Wmaybe-uninitialized] - printf("rstatus6 %d", rStatus); - ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - gcc -fPIC -g -Wall -o libcyuart.o -c cyuart.c -I ../../common/header - gcc -fPIC -g -Wall -o libcyi2c.o -c cyi2c.c -I ../../common/header - gcc -fPIC -g -Wall -o libcyspi.o -c cyspi.c -I ../../common/header - gcc -fPIC -g -Wall -o libcyphdc.o -c cyphdc.c -I ../../common/header - gcc -fPIC -g -Wall -o libcyjtag.o -c cyjtag.c -I ../../common/header - gcc -fPIC -g -Wall -o libcymisc.o -c cymisc.c -I ../../common/header - gcc -fPIC -g -Wall -o libcyboot.o -c cyboot.c -I ../../common/header - cyboot.c:72:0: warning: "CY_USB_SERIAL_TIMEOUT" redefined - #define CY_USB_SERIAL_TIMEOUT 0 - - In file included from cyboot.c:1:0: - CyUSBCommon.h:74:0: note: this is the location of the previous definition - #define CY_USB_SERIAL_TIMEOUT 5000 - - cyboot.c: In function ‘CyFlashConfigEnable’: - cyboot.c:634:21: warning: unused variable ‘ioTimeout’ [-Wunused-variable] - UINT32 rStatus, ioTimeout = CY_USB_SERIAL_TIMEOUT; - ^~~~~~~~~ - gcc -shared -g -Wl,-soname,libcyusbserial.so -o libcyusbserial.so.1 libcyusb.o libcyuart.o libcyi2c.o libcyspi.o libcyphdc.o libcyjtag.o libcymisc.o libcyboot.o -l usb-1.0 - cp libcyusbserial.so.1 /usr/local/lib - ln -sf /usr/local/lib/libcyusbserial.so.1 /usr/local/lib/libcyusbserial.so - ldconfig - rm -f libcyusb.o libcyuart.o libcyspi.o libcyi2c.o libcyphdc.o libcyjtag.o libcymisc.o libcyboot.o - ``` - -If the library builds succesfully, build the flasher tool next by going into the `tool` directory in the project root and running `make`. Again, the output will contain some warnings and notes that are tobe ignored. -The output should look like this: - -``` -make -# gcc -g -o CyUSBSerialTestUtility Test_Utility.c -lcyusbserial -w -gcc -g -o CyUSBSerialCommandUtility Command_Utility.c -lcyusbserial -Command_Utility.c: In function ‘deviceHotPlug’: -Command_Utility.c:102:35: warning: passing argument 1 of ‘CyGetListofDevices’ from incompatible pointer type [-Wincompatible-pointer-types] - rStatus = CyGetListofDevices (&numDevices); - ^ -In file included from Command_Utility.c:33:0: -../../common/header/CyUSBSerial.h:705:30: note: expected ‘UINT8 * {aka unsigned char *}’ but argument is of type ‘int *’ - CYWINEXPORT CY_RETURN_STATUS CyGetListofDevices ( - ^~~~~~~~~~~~~~~~~~ -Command_Utility.c:105:16: warning: ‘return’ with a value, in function returning void - return rStatus; - ^~~~~~~ -Command_Utility.c:95:6: note: declared here - void deviceHotPlug () { - ^~~~~~~~~~~~~ -Command_Utility.c:107:5: warning: implicit declaration of function ‘printListOfDevices’ [-Wimplicit-function-declaration] - printListOfDevices (false); - ^~~~~~~~~~~~~~~~~~ -Command_Utility.c: In function ‘main’: -Command_Utility.c:139:35: warning: passing argument 1 of ‘CyGetListofDevices’ from incompatible pointer type [-Wincompatible-pointer-types] - rStatus = CyGetListofDevices (&numDevices); - ^ -In file included from Command_Utility.c:33:0: -../../common/header/CyUSBSerial.h:705:30: note: expected ‘UINT8 * {aka unsigned char *}’ but argument is of type ‘int *’ - CYWINEXPORT CY_RETURN_STATUS CyGetListofDevices ( - ^~~~~~~~~~~~~~~~~~ -Command_Utility.c:268:51: warning: passing argument 2 of ‘CyReadDeviceConfig’ from incompatible pointer type [-Wincompatible-pointer-types] - rStatus=CyReadDeviceConfig(handle,&read_buffer); - ^ -In file included from Command_Utility.c:34:0: -../../common/header/CyUSBBootloader.h:203:45: note: expected ‘UCHAR * {aka unsigned char *}’ but argument is of type ‘unsigned char (*)[512]’ - CYWINEXPORT CY_RETURN_STATUS WINCALLCONVEN CyReadDeviceConfig ( - ^~~~~~~~~~~~~~~~~~ -Command_Utility.c: At top level: -Command_Utility.c:382:6: warning: conflicting types for ‘printListOfDevices’ - void printListOfDevices (bool isPrint) - ^~~~~~~~~~~~~~~~~~ -Command_Utility.c:107:5: note: previous implicit declaration of ‘printListOfDevices’ was here - printListOfDevices (false); - ^~~~~~~~~~~~~~~~~~ -Command_Utility.c: In function ‘printListOfDevices’: -Command_Utility.c:396:25: warning: passing argument 1 of ‘CyGetListofDevices’ from incompatible pointer type [-Wincompatible-pointer-types] - CyGetListofDevices (&numDevices); - ^ -In file included from Command_Utility.c:33:0: -../../common/header/CyUSBSerial.h:705:30: note: expected ‘UINT8 * {aka unsigned char *}’ but argument is of type ‘int *’ - CYWINEXPORT CY_RETURN_STATUS CyGetListofDevices ( - ^~~~~~~~~~~~~~~~~~ -Command_Utility.c:445:75: warning: backslash and newline separated by space - printf ("%d |%x |%x | %d | %s\n", \ - -cp 90-cyusb.rules /etc/udev/rules.d -cp CyUSBSerialCommandUtility /usr/bin/cy-config -cp CyUSBSerial.sh /usr/bin -chmod 777 /usr/bin/CyUSBSerial.sh -``` - -After the succesful installation of the flasher tool, install TinI/O by going into the `tinio` directory in the project root and running `make && make install`. The output should look like this: - -``` -make && make install -echo "Building tinio..." -Building tinio... -g++ -lcyusbserial tinio.cpp -o tinio -echo "done." -done. -echo "Installing tinio..." -Installing tinio... -mkdir -p /usr/share/tinio -cp -r flash /usr/share/tinio -cp tinio /usr/bin -echo "done." -done. -``` - -If TinI/O installs succesfully, the installation is completed. Proceed to the next chapter. +Installing TinI/O is very easy - just `cd` inside the `tinio` directory and run `make`. When the installation completes, run `make install`. With everything installed, proceed to the next chapter. # Flashing the board -Before you use your board with TinI/O, you must program its chip with a custom flash that will make the board compatible with TinI/O. The flash files are located in the `/usr/share/tinio/flash` directory and can be flashed to the board with the installed `cy-config` utility. There are 2 flash files with slightly different pin configurations: `5-5.cyusbd` and `3-3cs.cyusbd`. The 5-5 file sets half (5) of the GPIO pins as outputs and the other half as inputs. The 3-3cs sets 3 of the pins as outputs and 4 as inputs and 1 pin as a CapSense capacitive touch button and 1 as its output. See the table for the exact pin configuration: +Before you use your board with TinI/O, you must program its chip with a custom flash file that will make the board compatible with TinI/O. The flash files are located in the `/usr/share/tinio/flash` directory and can be flashed to the board with the installed `cy-config` utility. There are 2 flash files with slightly different pin configurations: `5-5.cyusbd` and `3-3cs.cyusbd`. The 5-5 file sets half (5) of the GPIO pins as outputs and the other half as inputs. The 3-3cs sets 3 of the pins as outputs and 4 as inputs and 1 pin as a CapSense capacitive touch button and 1 as its output. See the table for the exact pin configuration: | GPIO Pin | 5-5 config | 3-3cs config | | --- | --- | --- | @@ -288,4 +43,110 @@ Before you use your board with TinI/O, you must program its chip with a custom f | 10 | Output | Output | | 11 | Output | Input | -To flash a configuration file +After you've decided which configuration you'll use, run the configuration utility with the path of the flash file as an argument , e.g.:`cy-config /usr/share/tinio/flash/5-5.cyusbd`. +A menu will appear: +``` + +--------------------------------------------------------------------------------- +Device Number | VID | PID | INTERFACE NUMBER | FUNCTIONALITY +--------------------------------------------------------------------------------- +0 |1d6b |2 | 0 | NA +1 |413c |3016 | 0 | NA +2 |461 |10 | 0 | NA +2 |461 |10 | 1 | NA +3 |1d6b |1 | 0 | NA +4 |8bb |2902 | 0 | NA +4 |8bb |2902 | 1 | NA +4 |8bb |2902 | 2 | NA +4 |8bb |2902 | 3 | NA +5 |4b4 |4 | 0 | NA +5 |4b4 |4 | 1 | NA +6 |1d6b |1 | 0 | NA +7 |1d6b |1 | 0 | NA +8 |1d6b |2 | 0 | NA +9 |1d6b |1 | 0 | NA +10 |1d6b |1 | 0 | NA +--------------------------------------------------------------------------------- + +Cydevices 11------------------------------------------------------------------- +1: Print list of devices +2: Select device...No device selected !! +``` +At this point, you want to look for the device `4b4` in the VID column. Find its device number. In the example above, the device we're looking for has the device number 5. Select the `Select Device` option in the menu by entering `2`. +``` +2 +Enter Device number to be selected.. +``` +Enter the device number you remembered in the previous step. +``` +5 +Enter interface number.. +``` +Enter __the device's highest interface number in the table__. In the example it's 1, but it can also be 2. + +``` +1 + + File opened successfully + + Bytes successfully read + Programming Flash is done + File stream closed +------------------------------------------------------------------- +1: Print list of devices +2: Change device selection--selected device: [Device number 5] : [Interface No 1] : NA +^C +``` +This is how a successful flashing output should look like. If it doesn't: ++ If it gives you a fopen() error, the file you tried to flash doesn't exist or (rarely happens, but still) has a too long path. Find the file or move it to a less obscure folder. ++ Make sure you used a right device and file ++ Try running the utility as root + +## Creating your own configs +If you want to program your device your own way, you can do it with Cypress' [USB-Serial Configuration Utility](http://www.cypress.com/documentation/software-and-drivers/usb-serial-software-development-kit). However, you must follow some guidelines to make your configuration TinI/O compatible. + +The device must be configured to: ++ PHDC Interface ++ UID and VID left default ++ SCB: UART 2-pin + +# Using TinI/O +TinI/O is pretty simple to use. To see a quick usage reminder, run `tinio` in the terminal, but here's a more extensive +## Usage + +| __Option__ | __Action__ | +|------------|------------| +| -d | Sets the device number. 0 if left out. Up to 15 devices. | +| -i | Sets the interface number. 0 if left out. 0-255. | +| -s | Sets the specified pin's value to the value specified with the -v option. 0-11. | +| -r | Reads the pin's value and outputs it to the stdout. 0-11. | +| -v | Specifies the output value. Either 0 or 1, other numbers default to 1. | +| -e | Enables expert mode. The expert mode enables you to write to reserved pins (5&6) and shouldn't be enabled unless you know what you're doing. | + +## Practical examples +The two basic functions of TinI/O are reading and writing to I/O on a single device: +- To read, run `tinio -r` with replaced with the desired pin. The result will be printed to the stdout, followed by a newline. +- To set, run `tinio -s -v` with replaced with the desired pin and replaced with the value you want to write. + +TinI/O is capable of handling up to 16 devices at once with the `-d` option, but there isn't a reliable way of identifying them. The best way to ensure the correct device order is to look at the device tree with `lsusb` and check which device comes first - it will have the first device number (0). + +- To read from a specific device number, run `tinio -r -d` and replace with the pin number and with the device number. +- To write to a specific device run `tinio -s -v -d` and replace with the pin number, with the value and with the device number. + +## Using TinI/O in your projects ++ As the TinI/O target chip (CY7C65211) isn't a microcontroller, it can't operate without a computer connected to it. ++ It can't do PWM. ++ Its I/O has 3.3V LVTTL logic level, and it's __not__ 5V compatible. ++ Its maximum output current is comparable to Arduino's at 25 mA. ++ When using CapSense, decouple the reserved 0 pin to the ground with a 2.2 nF capacitor and don't use it. + +# Copyright, Links, ... +[Cypress' website](http://cypress.com) +[CY7C65211 Datasheet](http://http://www.cypress.com/file/139886/download) +[TinI/O Github](http://github.com/kristjan-komlosi/tinio) +[My Youtube channel - You may expect some videos of TinI/O there](https://www.youtube.com/channel/UCmcIwYA2I2YkmQs7xgMU-DA) + +## __Copyright disclaimer__ +No copyright infringement was intended to be made with this document or the TinI/O project. All of trademarks stated in this document are property of their owners. + +This document is licensed under the GNU FDL License. diff --git a/tinio/Makefile b/tinio/Makefile index 45b4fcc..ced688d 100644 --- a/tinio/Makefile +++ b/tinio/Makefile @@ -1,12 +1,14 @@ -CC=g++ -tinio: - echo "Building tinio..." - $(CC) -lcyusbserial tinio.cpp -o tinio - echo "done." +all: library utility tinio + +library: + cd library && make + +utility: library + cd testUtility && make +tinio: library + g++ -lcyusbserial tinio.cpp -o tinio install: - echo "Installing tinio..." mkdir -p /usr/share/tinio cp -r flash /usr/share/tinio cp tinio /usr/bin - echo "done." diff --git a/tinio/flash/3-3cs_decrypted.cyusbd b/tinio/flash/3-3cs.cyusbd similarity index 100% rename from tinio/flash/3-3cs_decrypted.cyusbd rename to tinio/flash/3-3cs.cyusbd diff --git a/tinio/flash/5-5_decrypted.cyusbd b/tinio/flash/5-5.cyusbd similarity index 100% rename from tinio/flash/5-5_decrypted.cyusbd rename to tinio/flash/5-5.cyusbd diff --git a/configutility/common/header/CyUSBBootloader.h b/tinio/header/CyUSBBootloader.h similarity index 100% rename from configutility/common/header/CyUSBBootloader.h rename to tinio/header/CyUSBBootloader.h diff --git a/cylib/CyUSBCommon.h b/tinio/header/CyUSBCommon.h similarity index 97% rename from cylib/CyUSBCommon.h rename to tinio/header/CyUSBCommon.h index 211b632..3da6aa9 100644 --- a/cylib/CyUSBCommon.h +++ b/tinio/header/CyUSBCommon.h @@ -26,7 +26,7 @@ #include #include #include -#include "../../common/header/CyUSBSerial.h" +#include "../header/CyUSBSerial.h" #pragma pack(1) typedef struct CY_DEVICE { diff --git a/configutility/common/header/CyUSBSerial.h b/tinio/header/CyUSBSerial.h similarity index 100% rename from configutility/common/header/CyUSBSerial.h rename to tinio/header/CyUSBSerial.h diff --git a/cylib/90-cyusb.rules b/tinio/library/90-cyusb.rules similarity index 100% rename from cylib/90-cyusb.rules rename to tinio/library/90-cyusb.rules diff --git a/tinio/library/CyUSBCommon.h b/tinio/library/CyUSBCommon.h new file mode 100644 index 0000000..3da6aa9 --- /dev/null +++ b/tinio/library/CyUSBCommon.h @@ -0,0 +1,219 @@ +/* + * Common header file of Cypress USB Serial + * Copyright (C) 2013 Cypress Semiconductor + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include "../header/CyUSBSerial.h" +#pragma pack(1) +typedef struct CY_DEVICE { + + unsigned char inEndpoint; + unsigned char outEndpoint; + unsigned char interruptEndpoint; + unsigned char interfaceNum; + bool i2cCancelEvent; + bool spiCancelEvent; + bool uartCancelEvent; + bool rtsValue; + bool dtrValue; + unsigned short numEndpoints; + CY_FLOW_CONTROL_MODES uartFlowControlMode; + struct libusb_transfer *spiTransfer; + struct libusb_transfer *uartTransfer; + libusb_device_handle *devHandle; + pthread_t spiThreadId; + pthread_t uartThreadId; + pthread_mutex_t readLock; + pthread_mutex_t writeLock; + pthread_mutex_t notificationLock; + CY_DEVICE_TYPE deviceType; + +}CY_DEVICE,*PCY_DEVICE; +#pragma pack() + +CY_RETURN_STATUS CyResetPipe (CY_HANDLE handl, UINT8); +#define CY_DEBUG_PRINT_INFO(...) //User need to enable this +#define CY_DEBUG_PRINT_ERROR(...) //printf +#define DUMP_DATA 1 +#ifdef DUMP_DATA +#define CY_DUMP_DATA(INPUT,LEN)\ +{\ + int i = 0, len = LEN;\ + while ((len)) {\ + printf ("%x ", (INPUT)[i++]);\ + len--;\ + }\ + printf ("\n");\ +} +#else +#define CY_DUMP_DATA (INPUT, LEN) do { }while (0); +#endif +#define CY_USB_SERIAL_TIMEOUT 5000 +#define CY_EVENT_NOTIFICATION_TIMEOUT 0 //This will make the transfer infinite + +#define CY_VENDOR_REQUEST_DEVICE_TO_HOST 0xC0 +#define CY_VENDOR_REQUEST_HOST_TO_DEVICE 0x40 + +#define CY_CLASS_INTERFACE_REQUEST_DEVICE_TO_HOST 0XA1 +#define CY_CLASS_INTERFACE_REQUEST_HOST_TO_DEVICE 0x21 +//I2C related macros +#define CY_SCB_INDEX_POS 15 +#define CY_I2C_CONFIG_LENGTH 16 +#define CY_I2C_WRITE_COMMAND_POS 3 +#define CY_I2C_WRITE_COMMAND_LEN_POS 4 +#define CY_I2C_GET_STATUS_LEN 3 +#define CY_I2C_MODE_WRITE 1 +#define CY_I2C_MODE_READ 0 +#define CY_I2C_ERROR_BIT (1) +#define CY_I2C_ARBITRATION_ERROR_BIT (1 << 1) +#define CY_I2C_NAK_ERROR_BIT (1 << 2) +#define CY_I2C_BUS_ERROR_BIT (1 << 3) +#define CY_I2C_STOP_BIT_ERROR (1 << 4) +#define CY_I2C_BUS_BUSY_ERROR (1 << 5) +#define CY_I2C_ENABLE_PRECISE_TIMING 1 +#define CY_I2C_EVENT_NOTIFICATION_LEN 3 +//SPI related Macros +#define CY_SPI_CONFIG_LEN 16 +#define CY_SPI_EVENT_NOTIFICATION_LEN 2 +#define CY_SPI_READ_BIT (1) +#define CY_SPI_WRITE_BIT (1 << 1) +#define CY_SPI_SCB_INDEX_BIT (1 << 15) +#define CY_SPI_GET_STATUS_LEN 4 +#define CY_SPI_UNDERFLOW_ERROR (1) +#define CY_SPI_BUS_ERROR (1 << 1) +//Vendor UART related macros +#define CY_UART_SET_FLOW_CONTROL_CMD 0x60 +#define CY_UART_SEND_BREAK_CMD 0x17 +#define CY_UART_CONFIG_LEN 16 +#define CY_SET_LINE_CONTROL_STATE_CMD 0x22 +#define CY_UART_EVENT_NOTIFICATION_LEN 10 + +#define CY_UART_SERIAL_STATE_CARRIER_DETECT 1 +#define CY_UART_SERIAL_STATE_TRANSMISSION_CARRIER (1 << 1) +#define CY_UART_SERIAL_STATE_BREAK_DETECTION (1<< 2) +#define CY_UART_SERIAL_STATE_RING_SIGNAL_DETECTION (1 << 3) +#define CY_UART_SERIAL_STATE_FRAMING_ERROR (1 << 4) +#define CY_UART_SERIAL_STATE_PARITY_ERROR (1 << 5) +#define CY_UART_SERIAL_STATUE_OVERRUN (1 << 6) +//Bootloader related macros +#define CY_BOOT_CONFIG_SIZE 64 +#define CY_DEVICE_CONFIG_SIZE 512 +#define CY_FIRMWARE_BREAKUP_SIZE 4096 +#define CY_GET_SILICON_ID_LEN 4 +#define CY_GET_FIRMWARE_VERSION_LEN 8 +#define CY_GET_SIGNATURE_LEN 4 +//PHDC related macros +#define CY_PHDC_SET_FEATURE 0X03 +#define CY_PHDC_CLR_FEATURE 0X01 +#define CY_PHDC_GET_DATA_STATUS 0x00 + +typedef enum CY_VENDOR_CMDS +{ + CY_GET_VERSION_CMD = 0xB0, /* Get the version of the boot-loader. + value = 0, index = 0, length = 4; + data_in = 32 bit version. */ + + CY_GET_SIGNATURE_CMD = 0xBD, /*Get the signature of the firmware + It is suppose to be 'CYUS' for normal firmware + and 'CYBL' for Bootloader.*/ + CY_UART_GET_CONFIG_CMD = 0xC0, /* Retreive the 16 byte UART configuration information. + MS bit of value indicates the SCB index. + length = 16, data_in = 16 byte configuration. */ + CY_UART_SET_CONFIG_CMD, /* Update the 16 byte UART configuration information. + MS bit of value indicates the SCB index. + length = 16, data_out = 16 byte configuration information. */ + CY_SPI_GET_CONFIG_CMD, /* Retreive the 16 byte SPI configuration information. + MS bit of value indicates the SCB index. + length = 16, data_in = 16 byte configuration. */ + CY_SPI_SET_CONFIG_CMD, /* Update the 16 byte SPI configuration information. + MS bit of value indicates the SCB index. + length = 16, data_out = 16 byte configuration information. */ + CY_I2C_GET_CONFIG_CMD, /* Retreive the 16 byte I2C configuration information. + MS bit of value indicates the SCB index. + length = 16, data_in = 16 byte configuration. */ + CY_I2C_SET_CONFIG_CMD = 0xC5, /* Update the 16 byte I2C configuration information. + MS bit of value indicates the SCB index. + length = 16, data_out = 16 byte configuration information. */ + CY_I2C_WRITE_CMD, /* Perform I2C write operation. + value = bit0 - start, bit1 - stop, bit3 - start on idle, + bits[14:8] - slave address, bit15 - scbIndex. length = 0. The + data is provided over the bulk endpoints. */ + CY_I2C_READ_CMD, /* Perform I2C read operation. + value = bit0 - start, bit1 - stop, bit2 - Nak last byte, + bit3 - start on idle, bits[14:8] - slave address, bit15 - scbIndex, + length = 0. The data is provided over the bulk endpoints. */ + CY_I2C_GET_STATUS_CMD, /* Retreive the I2C bus status. + value = bit0 - 0: TX 1: RX, bit15 - scbIndex, length = 3, + data_in = byte0: bit0 - flag, bit1 - bus_state, bit2 - SDA state, + bit3 - TX underflow, bit4 - arbitration error, bit5 - NAK + bit6 - bus error, + byte[2:1] Data count remaining. */ + CY_I2C_RESET_CMD, /* The command cleans up the I2C state machine and frees the bus. + value = bit0 - 0: TX path, 1: RX path; bit15 - scbIndex, + length = 0. */ + CY_SPI_READ_WRITE_CMD = 0xCA, /* The command starts a read / write operation at SPI. + value = bit 0 - RX enable, bit 1 - TX enable, bit 15 - scbIndex; + index = length of transfer. */ + CY_SPI_RESET_CMD, /* The command resets the SPI pipes and allows it to receive new + request. + value = bit 15 - scbIndex */ + CY_SPI_GET_STATUS_CMD, /* The command returns the current transfer status. The count will match + the TX pipe status at SPI end. For completion of read, read all data + at the USB end signifies the end of transfer. + value = bit 15 - scbIndex */ + CY_JTAG_ENABLE_CMD = 0xD0, /* Enable JTAG module */ + CY_JTAG_DISABLE_CMD, /* Disable JTAG module */ + CY_JTAG_READ_CMD, /* JTAG read vendor command */ + CY_JTAG_WRITE_CMD, /* JTAG write vendor command */ + CY_GPIO_GET_CONFIG_CMD = 0xD8, /* Get the GPIO configuration: */ + CY_GPIO_SET_CONFIG_CMD, /* Set the GPIO configuration */ + CY_GPIO_GET_VALUE_CMD, /* Get GPIO value: */ + CY_GPIO_SET_VALUE_CMD, /* Set the GPIO value:*/ + CY_PROG_USER_FLASH_CMD = 0xE0, /*Program user flash area. The total space available is 512 bytes. + This can be accessed by the user from USB. The flash area + address offset is from 0x0000 to 0x00200 and can be written to + page wise (128 byte).*/ + CY_READ_USER_FLASH_CMD, /*Read user flash area. The total space available is 512 bytes. + This can be accessed by the user from USB. The flash area + address offset is from 0x0000 to 0x00200 and can be written to + page wise (128 byte).*/ + CY_DEVICE_RESET_CMD = 0xE3, /*Performs a device reset from firmware*/ + +} CY_VENDOR_CMDS; + +//JTAG related Macros +#define CY_JTAG_OUT_EP 0x04 +#define CY_JTAG_IN_EP 0x85 + +//GPIO related Macros +#define CY_GPIO_GET_LEN 2 +#define CY_GPIO_SET_LEN 1 + +//PHDC related macros +#define CY_PHDC_GET_STATUS_LEN 2 +#define CY_PHDC_CLR_FEATURE_WVALUE 0x1 +#define CY_PHDC_SET_FEATURE_WVALUE 0x0101 + diff --git a/cylib/Makefile b/tinio/library/Makefile similarity index 51% rename from cylib/Makefile rename to tinio/library/Makefile index 4e67473..152f32d 100644 --- a/cylib/Makefile +++ b/tinio/library/Makefile @@ -1,12 +1,12 @@ all: - gcc -fPIC -g -Wall -o libcyusb.o -c cyusb.c -I ../../common/header - gcc -fPIC -g -Wall -o libcyuart.o -c cyuart.c -I ../../common/header - gcc -fPIC -g -Wall -o libcyi2c.o -c cyi2c.c -I ../../common/header - gcc -fPIC -g -Wall -o libcyspi.o -c cyspi.c -I ../../common/header - gcc -fPIC -g -Wall -o libcyphdc.o -c cyphdc.c -I ../../common/header - gcc -fPIC -g -Wall -o libcyjtag.o -c cyjtag.c -I ../../common/header - gcc -fPIC -g -Wall -o libcymisc.o -c cymisc.c -I ../../common/header - gcc -fPIC -g -Wall -o libcyboot.o -c cyboot.c -I ../../common/header + gcc -fPIC -g -Wall -o libcyusb.o -c cyusb.c -I ../header + gcc -fPIC -g -Wall -o libcyuart.o -c cyuart.c -I ../header + gcc -fPIC -g -Wall -o libcyi2c.o -c cyi2c.c -I ../header + gcc -fPIC -g -Wall -o libcyspi.o -c cyspi.c -I ../header + gcc -fPIC -g -Wall -o libcyphdc.o -c cyphdc.c -I ../header + gcc -fPIC -g -Wall -o libcyjtag.o -c cyjtag.c -I ../header + gcc -fPIC -g -Wall -o libcymisc.o -c cymisc.c -I ../header + gcc -fPIC -g -Wall -o libcyboot.o -c cyboot.c -I ../header gcc -shared -g -Wl,-soname,libcyusbserial.so -o libcyusbserial.so.1 libcyusb.o libcyuart.o libcyi2c.o libcyspi.o libcyphdc.o libcyjtag.o libcymisc.o libcyboot.o -l usb-1.0 cp libcyusbserial.so.1 /usr/local/lib diff --git a/cylib/cyboot.c b/tinio/library/cyboot.c similarity index 100% rename from cylib/cyboot.c rename to tinio/library/cyboot.c diff --git a/cylib/cyi2c.c b/tinio/library/cyi2c.c similarity index 100% rename from cylib/cyi2c.c rename to tinio/library/cyi2c.c diff --git a/cylib/cyjtag.c b/tinio/library/cyjtag.c similarity index 100% rename from cylib/cyjtag.c rename to tinio/library/cyjtag.c diff --git a/cylib/cymisc.c b/tinio/library/cymisc.c similarity index 100% rename from cylib/cymisc.c rename to tinio/library/cymisc.c diff --git a/cylib/cyphdc.c b/tinio/library/cyphdc.c similarity index 100% rename from cylib/cyphdc.c rename to tinio/library/cyphdc.c diff --git a/cylib/cyspi.c b/tinio/library/cyspi.c similarity index 100% rename from cylib/cyspi.c rename to tinio/library/cyspi.c diff --git a/cylib/cyuart.c b/tinio/library/cyuart.c similarity index 100% rename from cylib/cyuart.c rename to tinio/library/cyuart.c diff --git a/cylib/cyusb.c b/tinio/library/cyusb.c similarity index 100% rename from cylib/cyusb.c rename to tinio/library/cyusb.c diff --git a/tinio/library/libcyusbserial.so b/tinio/library/libcyusbserial.so new file mode 100644 index 0000000..09240c7 --- /dev/null +++ b/tinio/library/libcyusbserial.so @@ -0,0 +1 @@ +libcyusbserial.so.1 \ No newline at end of file diff --git a/tinio/library/libcyusbserial.so.1 b/tinio/library/libcyusbserial.so.1 new file mode 100644 index 0000000..87599ba Binary files /dev/null and b/tinio/library/libcyusbserial.so.1 differ diff --git a/tool/90-cyusb.rules b/tinio/testUtility/90-cyusb.rules similarity index 100% rename from tool/90-cyusb.rules rename to tinio/testUtility/90-cyusb.rules diff --git a/tool/Command_Utility.c b/tinio/testUtility/Command_Utility.c similarity index 96% rename from tool/Command_Utility.c rename to tinio/testUtility/Command_Utility.c index 01ef543..3749e02 100644 --- a/tool/Command_Utility.c +++ b/tinio/testUtility/Command_Utility.c @@ -30,8 +30,8 @@ #include #include -#include "../../common/header/CyUSBSerial.h" -#include "../../common/header/CyUSBBootloader.h" +#include "../header/CyUSBSerial.h" +#include "../header/CyUSBBootloader.h" #define CY_MAX_DEVICES 30 #define CY_MAX_INTERFACES 4 diff --git a/tool/CyUSBBootloader.h b/tinio/testUtility/CyUSBBootloader.h similarity index 100% rename from tool/CyUSBBootloader.h rename to tinio/testUtility/CyUSBBootloader.h diff --git a/tool/CyUSBSerial.sh b/tinio/testUtility/CyUSBSerial.sh similarity index 100% rename from tool/CyUSBSerial.sh rename to tinio/testUtility/CyUSBSerial.sh diff --git a/tinio/testUtility/CyUSBSerialCommandUtility b/tinio/testUtility/CyUSBSerialCommandUtility new file mode 100755 index 0000000..053f41c Binary files /dev/null and b/tinio/testUtility/CyUSBSerialCommandUtility differ diff --git a/tool/Makefile b/tinio/testUtility/Makefile similarity index 50% rename from tool/Makefile rename to tinio/testUtility/Makefile index cd6af94..bd8da1f 100644 --- a/tool/Makefile +++ b/tinio/testUtility/Makefile @@ -1,12 +1,8 @@ all: # gcc -g -o CyUSBSerialTestUtility Test_Utility.c -lcyusbserial -w gcc -g -o CyUSBSerialCommandUtility Command_Utility.c -lcyusbserial - cp 90-cyusb.rules /etc/udev/rules.d + cp 90-cyusb.rules /etc/udev/rules.d cp CyUSBSerialCommandUtility /usr/bin/cy-config cp CyUSBSerial.sh /usr/bin chmod 777 /usr/bin/CyUSBSerial.sh -clean: - rm -f CyUSBSerialCommandUtility -help: - @echo 'make would compile and create the library and create a link' - @echo 'make clean would remove the library and the soft link to the library (soname)' + diff --git a/tinio/tinio b/tinio/tinio index 398a3f9..6d1b8ff 100755 Binary files a/tinio/tinio and b/tinio/tinio differ diff --git a/tinio/tinio.cpp b/tinio/tinio.cpp index 8bd6867..7eeb7cf 100644 --- a/tinio/tinio.cpp +++ b/tinio/tinio.cpp @@ -1,7 +1,6 @@ // Tinio - the Tiny I/O tool -#include +#include "header/CyUSBSerial.h" #include -#include #include #include #include diff --git a/tool/CyUSBSerialCommandUtility b/tool/CyUSBSerialCommandUtility deleted file mode 100755 index eebd671..0000000 Binary files a/tool/CyUSBSerialCommandUtility and /dev/null differ diff --git a/tool/README.txt b/tool/README.txt deleted file mode 100644 index c255cd4..0000000 --- a/tool/README.txt +++ /dev/null @@ -1,137 +0,0 @@ -================================================================================ - Cypress Semiconductor Corporation - CyUSB Serial DVK test utility for I2C/SPI -================================================================================ - -This utility is used for testing I2C/SPI master mode functionality on the -Cypress CyUSBSerial DVK. - -The utility writes to I2C/SPI flash devices on the DVK, reads the data back -and verifies the data read for integrity. - -Release components: -================================================================================ -1. Test_Utility.c ==> Source file of the command line test utility -2. 90-cyusb.rules ==> udev rules for changing the mode of usb device node. -3. CyUSBSerial.sh ==> Script file for implementing hotplug feature in linux. -4. Makefile ==> make file for compiling and installing the application. -================================================================================ - - -Pre-requisites: -================================================================================ -1. libusb-1.0.9 is required for compilation and functioning of the APIs in the - USB Serial library. -2. The CyUSBSerial library (libcyusbserial.so) should be compiled and installed - on the test machine. -3. GNU Make and the GCC tool-chain are used for the build process. -================================================================================ - -Installation steps: -================================================================================ -1. Change to the folder where the utility source files are extracted. -2. Invoke 'make' to build compile the utility, and to install the configuration - files at the appropriate locations. This should be done from a super-user - (sudo) shell, because the configuration files need to be copied into system - folders (/usr/local/bin). -3. Use the CyUSBSerial command to start the test utility. - -Note: -The udev daemon needs to be restarted to reflect the udev rule changes that -are installed as part of the make command. -================================================================================ - -Using the test utility: -================================================================================ -1. On starting the utility, the Cypress USB Serial devices that are connected - are listed along with their device numbers, interface numbers and - functionalities (SPI or I2C). - - $ CyUSBSerial - ---------------------------------------------------------------------- - Device Number | VID | PID | INTERFACE NUMBER | FUNCTIONALITY - ---------------------------------------------------------------------- - 0 |4b4 |a | 0 | VENDOR_I2C - 0 |4b4 |a | 1 | VENDOR_SPI - 0 |4b4 |a | 2 | NA - ---------------------------------------------------------------------- - -2. A menu providing the various operations is also printed: - ---------------------------------------------------------------------- - 1: Print list of devices - 2: Select device...No device selected !! - 3: Enter I2C/SPI Flash page address and length to write/read. - 4: Verify data - 5: Exit - ---------------------------------------------------------------------- - -3. On selecting option 2, the utility prompts for the device and interface - number to be selected for testing. - - ----------------------------------- - Enter Device number to select: - 0 - Enter interface number: - 1 - ----------------------------------- - - Once the selections are made, the menu will be updated with the details. - ---------------------------------------------------------------------- - 1: Print list of devices - 2: Change device selection--selected device: [Device number 0] : [Interface No 1] : SPI - 3: Enter I2C/SPI Flash page address and length to write/read. - 4: Verify data - 5: Exit - ---------------------------------------------------------------------- - -4. Option 3 can be selected now to do data read/write to the I2C/SPI flash - device. The utility prompts for the page address to be written as well as - the length of data to be written. - - ------------------------------------------------ - Enter Page address ... (less than 65536) - 1234 - Enter length to read/write ... (less than 256) - 32 - ------------------------------------------------ - - Length needs to be less than or equal to 256 bytes in the case of SPI access, - and less than or equal to 64 bytes in the case of I2C access. Page address - needs to be less than 65536 in case of SPI and 256 in case of I2C. - - Once the values are selected, the menu is updated with the details as below: - ------------------------------------------------------------------- - 1: Print list of devices - 2: Change device selection--selected device: [Device number 0] : [Interface No 1] : SPI - 3: Change Flash page address and length ...Entered is page address 1234 and length 123 - 4: Verify data - 5: Exit - ------------------------------------------------------------------- - -5. Selecting option 4 causes the utility to write a randomly generated data - sequence to the flash device, read it back, and verify the data read back. - - The data pattern written and read back will be displayed as shown below: - -------------------------------------------------------------------- - 67 c6 69 73 51 ff 4a ec 29 cd ba ab f2 fb e3 46 7c c2 54 f8 1b e8 e7 8d 76 5a 2e 63 33 9f c9 9a - -------------------------------------------------------------------- - Data Read back is: - --------------------------------------------------------------------- - 67 c6 69 73 51 ff 4a ec 29 cd ba ab f2 fb e3 46 7c c2 54 f8 1b e8 e7 8d 76 5a 2e 63 33 9f c9 9a - --------------------------------------------------------------------- - Data verified successfully - ------------------------------------------------------------------- - -6. The utility runs through these menu options until the user selects the - exit option (5). - -7. If a new Cypress USB Serial device is attached or an existing device is - removed while the utility is running, a notification is printed on the - console. - - --------------------------------------- - Device of interest Removed/Added - --------------------------------------- -================================================================================ - -EOF diff --git a/tool/jbiexprt.h b/tool/jbiexprt.h deleted file mode 100644 index 9b38b4c..0000000 --- a/tool/jbiexprt.h +++ /dev/null @@ -1,224 +0,0 @@ -/********************************************************************************/ -/* */ -/* Module: jbiexprt.h */ -/* */ -/* Copyright (C) Altera Corporation 1998-2001 */ -/* */ -/* Description: Jam STAPL ByteCode Player Export Header File */ -/* */ -/* Revisions: */ -/* */ -/********************************************************************************/ - -#ifndef INC_JBIEXPRT_H -#define INC_JBIEXPRT_H - -/********************************************************************************/ -/* */ -/* Return codes from most JBI functions */ -/* */ -/********************************************************************************/ - -#define JBI_RETURN_TYPE int - -#define JBIC_SUCCESS 0 -#define JBIC_OUT_OF_MEMORY 1 -#define JBIC_IO_ERROR 2 -/* #define JAMC_SYNTAX_ERROR 3 */ -#define JBIC_UNEXPECTED_END 4 -#define JBIC_UNDEFINED_SYMBOL 5 -/* #define JAMC_REDEFINED_SYMBOL 6 */ -#define JBIC_INTEGER_OVERFLOW 7 -#define JBIC_DIVIDE_BY_ZERO 8 -#define JBIC_CRC_ERROR 9 -#define JBIC_INTERNAL_ERROR 10 -#define JBIC_BOUNDS_ERROR 11 -/* #define JAMC_TYPE_MISMATCH 12 */ -/* #define JAMC_ASSIGN_TO_CONST 13 */ -/* #define JAMC_NEXT_UNEXPECTED 14 */ -/* #define JAMC_POP_UNEXPECTED 15 */ -/* #define JAMC_RETURN_UNEXPECTED 16 */ -/* #define JAMC_ILLEGAL_SYMBOL 17 */ -#define JBIC_VECTOR_MAP_FAILED 18 -#define JBIC_USER_ABORT 19 -#define JBIC_STACK_OVERFLOW 20 -#define JBIC_ILLEGAL_OPCODE 21 -/* #define JAMC_PHASE_ERROR 22 */ -/* #define JAMC_SCOPE_ERROR 23 */ -#define JBIC_ACTION_NOT_FOUND 24 - -/********************************************************************************/ -/* */ -/* Macro Definitions */ -/* */ -/********************************************************************************/ - -/* -* For DOS port, program data is stored in a set of 16K pages, accessed -* through a pointer table. For 32-bit version, the buffer is continuous. -* The macro GET_BYTE gets a single byte for either case. -*/ -#if PORT==DOS -#define PROGRAM_PTR unsigned char ** -#else -#define PROGRAM_PTR unsigned char * -#endif - -#if PORT==DOS -#define GET_BYTE(x) (jbi_program[(x) >> 14L][(x) & 0x3fffL]) -#else -#define GET_BYTE(x) (program[x]) -#endif - -#define GET_WORD(x) \ - (((((unsigned short) GET_BYTE(x)) << 8) & 0xFF00) | \ - (((unsigned short) GET_BYTE((x)+1)) & 0x00FF)) - -#define GET_DWORD(x) \ - (((((unsigned long) GET_BYTE(x)) << 24L) & 0xFF000000L) | \ - ((((unsigned long) GET_BYTE((x)+1)) << 16L) & 0x00FF0000L) | \ - ((((unsigned long) GET_BYTE((x)+2)) << 8L) & 0x0000FF00L) | \ - (((unsigned long) GET_BYTE((x)+3)) & 0x000000FFL)) - -/********************************************************************************/ -/* */ -/* Structured Types */ -/* */ -/********************************************************************************/ - -typedef struct JBI_PROCINFO_STRUCT -{ - char *name; - unsigned char attributes; - struct JBI_PROCINFO_STRUCT *next; -} -JBI_PROCINFO; - -/********************************************************************************/ -/* */ -/* Global Data Prototypes */ -/* */ -/********************************************************************************/ - -#if PORT==DOS -extern unsigned char jbi_aca_out_buffer[8192 + 1024]; -#endif - -extern PROGRAM_PTR jbi_program; - -extern char *jbi_workspace; - -extern long jbi_workspace_size; - -/********************************************************************************/ -/* */ -/* Function Prototypes */ -/* */ -/********************************************************************************/ - -JBI_RETURN_TYPE jbi_execute -( - PROGRAM_PTR program, - long program_size, - char *workspace, - long workspace_size, - char *action, - char **init_list, - int reset_jtag, - long *error_address, - int *exit_code, - int *format_version -); - -JBI_RETURN_TYPE jbi_get_note -( - PROGRAM_PTR program, - long program_size, - long *offset, - char *key, - char *value, - int length -); - -JBI_RETURN_TYPE jbi_check_crc -( - PROGRAM_PTR program, - long program_size, - unsigned short *expected_crc, - unsigned short *actual_crc -); - -JBI_RETURN_TYPE jbi_get_file_info -( - PROGRAM_PTR program, - long program_size, - int *format_version, - int *action_count, - int *procedure_count -); - -JBI_RETURN_TYPE jbi_get_action_info -( - PROGRAM_PTR program, - long program_size, - int index, - char **name, - char **description, - JBI_PROCINFO **procedure_list -); - -int jbi_jtag_io -( - int tms, - int tdi, - int read_tdo -); - -void jbi_message -( - char *message_text -); - -void jbi_export_integer -( - char *key, - long value -); - -void jbi_export_boolean_array -( - char *key, - unsigned char *data, - long count -); - -void jbi_delay -( - long microseconds -); - -int jbi_vector_map -( - int signal_count, - char **signals -); - -int jbi_vector_io -( - int signal_count, - long *dir_vect, - long *data_vect, - long *capture_vect -); - -void *jbi_malloc -( - unsigned int size -); - -void jbi_free -( - void *ptr -); - -#endif /* INC_JBIEXPRT_H */ diff --git a/tool/jbiport.h b/tool/jbiport.h deleted file mode 100644 index f57533e..0000000 --- a/tool/jbiport.h +++ /dev/null @@ -1,43 +0,0 @@ -/****************************************************************************/ -/* */ -/* Module: jbiport.h */ -/* */ -/* Copyright (C) Altera Corporation 2000-2001 */ -/* */ -/* Description: Defines porting macros */ -/* */ -/****************************************************************************/ - -#ifndef INC_JBIPORT_H -#define INC_JBIPORT_H - -/* -* PORT defines the target platform: DOS, WINDOWS, UNIX, or EMBEDDED -* -* PORT = DOS means a 16-bit DOS console-mode application -* -* PORT = WINDOWS means a 32-bit WIN32 console-mode application for -* Windows 95, 98, 2000, ME or NT. On NT this will use the -* DeviceIoControl() API to access the Parallel Port. -* -* PORT = UNIX means any UNIX system. BitBlaster access is support via -* the standard ANSI system calls open(), read(), write(). -* The ByteBlaster is not supported. -* -* PORT = EMBEDDED means all DOS, WINDOWS, and UNIX code is excluded. -* Remaining code supports 16 and 32-bit compilers. -* Additional porting steps may be necessary. See readme -* file for more details. -*/ - -#define DOS 2 -#define WINDOWS 3 -#define UNIX 4 -#define EMBEDDED 5 - -#ifndef PORT -/* change this line to build a different port */ -#define PORT EMBEDDED -#endif - -#endif /* INC_JBIPORT_H */