initial import

This commit is contained in:
Steven T. Snyder 2012-02-16 20:53:30 -08:00
commit 5f6a9c67b9
26 changed files with 7401 additions and 0 deletions

28
bin/.svn/entries Normal file
View File

@ -0,0 +1,28 @@
8
dir
2
file:///home/series8217/projects/svn/linuxaldl/tags/0.1.7/bin
file:///home/series8217/projects/svn/linuxaldl
2008-11-08T04:12:36.346386Z
2
series8217
svn:special svn:externals svn:needs-lock
55df6d5b-af3d-417a-bb1d-fdffa30c35fe

1
bin/.svn/format Normal file
View File

@ -0,0 +1 @@
8

52
docs/.svn/entries Normal file
View File

@ -0,0 +1,52 @@
8
dir
2
file:///home/series8217/projects/svn/linuxaldl/tags/0.1.7/docs
file:///home/series8217/projects/svn/linuxaldl
2008-11-08T04:12:36.346386Z
2
series8217
svn:special svn:externals svn:needs-lock
55df6d5b-af3d-417a-bb1d-fdffa30c35fe
readme.txt
file
2008-11-08T04:12:02.000000Z
07738662a44be911fd56e15e2bb46e06
2008-11-08T04:12:36.346386Z
2
series8217
gpl-3.0.txt
file
2008-11-08T04:12:02.000000Z
d32239bcb673463ab874e80d47fae504
2008-11-08T04:12:36.346386Z
2
series8217

1
docs/.svn/format Normal file
View File

@ -0,0 +1 @@
8

View File

@ -0,0 +1,674 @@
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, 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
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If 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 convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU 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
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "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 PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM 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 PROGRAM (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 PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program 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 General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
<program> Copyright (C) <year> <name of author>
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
<http://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
<http://www.gnu.org/philosophy/why-not-lgpl.html>.

View File

@ -0,0 +1,70 @@
Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM 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 PROGRAM (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 PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
LICENSING INFORMATION:
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program 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 General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
INTRODUCTION
------------
Thank you for downloading linuxaldl from:
http://www.steventsnyder.com/linuxaldl.html
The goal of this project is to develop software that provides
access to the GM ALDL interface over a serial connection from
Unix-based operating systems.
Currently linuxaldl is a GUI application with a basic command line
interface. The command line interface will be improved in a later
version. For now, all features are supported in the GUI.
HOW TO USE
----------
Compiling linuxaldl
-------------------
You will need the popt and gtk+-2.0 libraries, as well as gcc for compiling
and linking. A makefile is included.
Unzip the contents of of the linuxaldl tar file to any location. Go to
the /src subdirectory from a terminal window, and run make. If all goes well,
the executable will be created with the name "linuxaldl". You can put
this executable wherever you want. There are no additional files required and
linuxaldl does not use temporarily files.
GUI Operation
-------------
To open the linuxaldl GUI use the command:
linuxaldl -serial=/dev/ttyUSB0
where /dev/ttyUSB0 is the address to your ALDL interface.
If you want to use a launcher shortcut to open the GUI interface, choose
"application in terminal" as the type. Important diagnostic information is
printed to the terminal in the current version. A future version will make this
all part of the GUI.
Command Line Operation
----------------------
Not yet implemented
(c) copyright 2008, Steven Snyder, All Rights Reserved

674
docs/gpl-3.0.txt Normal file
View File

@ -0,0 +1,674 @@
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, 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
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If 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 convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU 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
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "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 PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM 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 PROGRAM (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 PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program 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 General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
<program> Copyright (C) <year> <name of author>
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
<http://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
<http://www.gnu.org/philosophy/why-not-lgpl.html>.

70
docs/readme.txt Normal file
View File

@ -0,0 +1,70 @@
Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM 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 PROGRAM (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 PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
LICENSING INFORMATION:
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program 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 General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
INTRODUCTION
------------
Thank you for downloading linuxaldl from:
http://www.steventsnyder.com/linuxaldl.html
The goal of this project is to develop software that provides
access to the GM ALDL interface over a serial connection from
Unix-based operating systems.
Currently linuxaldl is a GUI application with a basic command line
interface. The command line interface will be improved in a later
version. For now, all features are supported in the GUI.
HOW TO USE
----------
Compiling linuxaldl
-------------------
You will need the popt and gtk+-2.0 libraries, as well as gcc for compiling
and linking. A makefile is included.
Unzip the contents of of the linuxaldl tar file to any location. Go to
the /src subdirectory from a terminal window, and run make. If all goes well,
the executable will be created with the name "linuxaldl". You can put
this executable wherever you want. There are no additional files required and
linuxaldl does not use temporarily files.
GUI Operation
-------------
To open the linuxaldl GUI use the command:
linuxaldl -serial=/dev/ttyUSB0
where /dev/ttyUSB0 is the address to your ALDL interface.
If you want to use a launcher shortcut to open the GUI interface, choose
"application in terminal" as the type. Important diagnostic information is
printed to the terminal in the current version. A future version will make this
all part of the GUI.
Command Line Operation
----------------------
Not yet implemented
(c) copyright 2008, Steven Snyder, All Rights Reserved

124
src/.svn/entries Normal file
View File

@ -0,0 +1,124 @@
8
dir
2
file:///home/series8217/projects/svn/linuxaldl/tags/0.1.7/src
file:///home/series8217/projects/svn/linuxaldl
2008-11-08T04:12:36.346386Z
2
series8217
svn:special svn:externals svn:needs-lock
55df6d5b-af3d-417a-bb1d-fdffa30c35fe
linuxaldl_gui.c
file
2008-11-08T04:12:02.000000Z
d3bc5a3086012864b19e28b2675616f9
2008-11-08T04:12:36.346386Z
2
series8217
linuxaldl.h
file
2008-11-08T04:12:02.000000Z
ee7f9eb022df55e870497812e16f99c9
2008-11-08T04:12:36.346386Z
2
series8217
linuxaldl_gui.h
file
2008-11-08T04:12:02.000000Z
57704187791ec8231aa87811d4852f82
2008-11-08T04:12:36.346386Z
2
series8217
sts_serial.c
file
2008-11-08T04:12:02.000000Z
285e47a71ffcaa8b460e880bff28b9f4
2008-11-08T04:12:36.346386Z
2
series8217
Makefile
file
2008-11-08T04:12:02.000000Z
8b4812d4eb6232b8f0665fc4419e7182
2008-11-08T04:12:36.346386Z
2
series8217
linuxaldl.c
file
2008-11-08T04:12:02.000000Z
6fca6bbc0b1ddf3ec66aaf86ed0750b2
2008-11-08T04:12:36.346386Z
2
series8217
linuxaldl_definitions.h
file
2008-11-08T04:12:02.000000Z
d5f9aaa1dc71132d549832236c54d261
2008-11-08T04:12:36.346386Z
2
series8217
sts_serial.h
file
2008-11-08T04:12:02.000000Z
63b4efcf2c2855519d6a086a0bc43c82
2008-11-08T04:12:36.346386Z
2
series8217

1
src/.svn/format Normal file
View File

@ -0,0 +1 @@
8

View File

@ -0,0 +1,28 @@
# linuxaldl Makefile
CC = gcc
CFLAGS = -g -W -Wall -Wno-unused `pkg-config --cflags gtk+-2.0`
V = @
all: linuxaldl
sts_serial.o: sts_serial.c
@echo + cc sts_serial.c
$(V)$(CC) $(CFLAGS) -c sts_serial.c
linuxaldl.o: linuxaldl.c
@echo + cc linuxaldl.c
$(V)$(CC) $(CFLAGS) -c linuxaldl.c
linuxaldl_gui.o: linuxaldl_gui.c
@echo + cc linuxaldl_gui.c
$(V)$(CC) $(CFLAGS) -c linuxaldl_gui.c
linuxaldl: linuxaldl.o linuxaldl_gui.o sts_serial.o
@echo + link main
$(V)$(CC) $(CFLAGS) -lpopt `pkg-config --libs gtk+-2.0` -o ../bin/$@ linuxaldl.o linuxaldl_gui.o sts_serial.o
clean:
@echo + clean
$(V)rm -rf *.o ../bin/linuxaldl

View File

@ -0,0 +1,481 @@
/*(C) copyright 2008, Steven Snyder, All Rights Reserved
Steven T. Snyder, <stsnyder@ucla.edu> http://www.steventsnyder.com
LICENSING INFORMATION:
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program 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 General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include <unistd.h>
#include <stdio.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <sys/signal.h>
#include <fcntl.h>
#include <popt.h> // for command line parsing
#include <gtk/gtk.h>
#include <stdlib.h>
#include <string.h> // for memcpy
#include <errno.h>
#include "linuxaldl.h"
#include "linuxaldl_definitions.h"
#include "linuxaldl_gui.h"
#include "sts_serial.h"
// global variables
// =================================================
linuxaldl_settings aldl_settings = { NULL, 0, NULL, 1, 0, NULL, NULL, aldl_definition_table, NULL, NULL, NULL, 150, 100};
// ============================================================================
//
// linuxaldl
// main ()
//
// ============================================================================
int main(int argc, const char* argv[]){
int res; // temporary storage for function results
int guimode = 0;
// ========================================================================
// COMMAND LINE OPTION PARSING
// ========================================================================
poptContext popt_aldl;
// popt option table
// -----------------
struct poptOption aldl_opt_table[] =
{
{ "serial",'\0',
POPT_ARG_STRING | POPT_ARGFLAG_ONEDASH,&aldl_settings.aldlportname,0,
"Serial port the aldl interface is on",
"/dev/ttyUSB0" },
{ "mask",'\0',
POPT_ARG_STRING | POPT_ARGFLAG_ONEDASH,&aldl_settings.aldldefname,0,
"ALDL code definition to use",
"DF"},
POPT_AUTOHELP
{ NULL, 0, 0, NULL, 0, 0, NULL}
};
// popt context
popt_aldl = poptGetContext(NULL, argc, argv,aldl_opt_table,0);
poptSetOtherOptionHelp(popt_aldl,"[logfile.log]\nTo use GUI: linuxaldl [-serial=/dev/ttyUSB0]");
if (argc<2) { poptPrintUsage(popt_aldl,stderr,0); return 1; }
res = poptGetNextOpt(popt_aldl); // parse the command line arguments
// if no serial port selected, print usage instructions and exit
if (aldl_settings.aldlportname == NULL)
{ poptPrintUsage(popt_aldl,stderr,0); return 1; }
aldl_settings.logfilename = (char*)poptGetArg(popt_aldl);
// if no log file specified or no definition file specified
if ((aldl_settings.logfilename == NULL || !(poptPeekArg(popt_aldl)==NULL || aldl_settings.aldldefname==NULL)))
{
guimode = 1;
}
else // in command line mode, choose definition using the -mask=DEF argument
{
// XXX suggestion: how about adding support for pre-selecting the definition at the command line?
// get the aldl definition address
aldl_settings.definition = aldl_get_definition(aldl_settings.aldldefname);
// if no definition by that name exists, exit
if (aldl_settings.definition == NULL)
{
fprintf(stderr,"Error: No definition with name \"%s\" found.",
aldl_settings.aldldefname);
fprintf(stderr,"Consult the documentation.\n");
fprintf(stderr," Note: definition names are case sensitive.\n");
return -1;
}
}
poptFreeContext(popt_aldl); // free the popt context
// ========================================================================
// CONNECT / VERIFY ALDL INTERFACE
// ========================================================================
// Establish a connection to the aldl
// ===================================
printf("Trying to connect to ALDL interface on %s...\n",aldl_settings.aldlportname);
// connect to the device and set the serial port settings
aldl_settings.faldl = serial_connect(aldl_settings.aldlportname,O_RDWR | O_NOCTTY | O_NONBLOCK,BAUDRATE);
if (aldl_settings.faldl == -1)
{
fprintf(stderr," Couldn't open to %s\n",aldl_settings.aldlportname);
return -1;
}
// set the custom baud rate:
// the ALDL interface operates at 8192. it would be preferable to get as close to this
// baud rate as possible. if it cannot be set; it should still work at the standard
// baud rate of 9600; the framing errors aren't excessive enough to cause problems,
// and will be caught by bad checksums.
if (set_custom_baud_rate(aldl_settings.faldl,8192)!=0)
{
fprintf(stderr," Couldn't set baud rate to 8192. Using standard rate (9600).\n");
fprintf(stderr," There may be framing errors.\n");
}
// verify the aldl
if (verifyaldl()<0)
{
fprintf(stderr," ALDL verification failure. No response from ECM.\n");
tcflush(aldl_settings.faldl, TCIOFLUSH);
close(aldl_settings.faldl);
return -1;
}
// GUI mode if no .log file specified at the command line
// ========================================================================
// LOAD GUI MODE
// ========================================================================
if (guimode)
{
// GUI mode
linuxaldl_gui(argc, (char**)argv);
}
// ========================================================================
// COMMAND LINE MODE
// ========================================================================
else
{
// Open the .log file for writing, create if it doesnt exist
// ------------------------------------------------------------
aldl_settings.flogfile = open(aldl_settings.logfilename,O_RDWR | O_CREAT, 0666);
if (aldl_settings.flogfile == -1)
{
fprintf(stderr,"Unable to open/create %s for writing.\n",aldl_settings.logfilename);
return 0; }
printf("Opened %s for writing.\n",aldl_settings.logfilename);
// Read from the aldl
// ------------------
res = aldl_scan_and_log(aldl_settings.flogfile);
if (res==-1) fprintf(stderr,"Error: Fatal read error occured. log file may be corrupted.\n");
else printf("Received %d bytes from device and wrote to file: %s.\n", res,aldl_settings.logfilename);
close(aldl_settings.flogfile);
}
// ========================================================================
// CLEANUP (FLUSH SERIAL LINE, CLOSE PORT)
// ========================================================================
// discard any unwritten data
tcflush(aldl_settings.faldl, TCIOFLUSH);
// close the port
close(aldl_settings.faldl);
printf("Connection closed.\n");
return 0;
}
// ============================================================
//
// linuxaldl general function definitions
//
// ============================================================
// (mostly used for the command line interface but also main())
// wake up / verify the aldl
// This function should check that the aldl interface is working by listening
// for ECM chatter, or some other operation to determine whether there is
// a line connected to the serial port.
int verifyaldl()
{
//XXX NOT IMPLEMENTED
return 0;
}
int aldl_scan_and_log(int fd)
{
//XXX NOT IMPLEMENTED
return 0;
}
// sends an artibtrary aldl message contained in the buffer msg_buf.
// the checksum must be set in the buffer by the caller.
// the following macros can be used as arguments:
// _ALDL_MESSAGE_MODE8
// _ALDL_MESSAGE_MODE9
// which use the mode 8 and mode 9 message definitions from the
// current aldl definition.
// returns 0 on success.
int send_aldl_message(char* msg_buf, unsigned int size)
{
int res;
#ifdef _LINUXALDL_DEBUG
printf("Sending sequence: ");
fprinthex(stdout,msg_buf,size);
printf("\n");
#endif
res = write(aldl_settings.faldl,&msg_buf,size);
if (res <= 0)
return -1;
else if ((unsigned)res<size)
return -1;
tcdrain(aldl_settings.faldl);
return res;
}
// requests a mode1 message from the ECM using the currently loaded
// aldl definition.
// returns the number of bytes received, if the message was complete.
// 0 is no response/timeout/partial message
// -1 is returned if the checksum is bad.
// XXX this is likely to fail if mode 8 is not set, because the call to read
// will in all probability return part of a normal mode message. a correct
// implementation should wait for a mode 1 message header in the response,
// so that mode 8 isn't even required.
int get_mode1_message(char* inbuffer, unsigned int size)
{
int res;
char checkval;
char outbuffer[__MAX_REQUEST_SIZE]; // max request size defined in linuxaldl_definitions.h
aldl_definition* def = aldl_settings.definition;
unsigned int mode1_len = def->mode1_response_length;
if (size < mode1_len)
{
printf("Read buffer must be at least %d bytes.\n",mode1_len);
return -1;
}
// put the mode 1 request message and checksum in the output buffer
memcpy(outbuffer,def->mode1_request,def->mode1_request_length-1);
outbuffer[def->mode1_request_length-1] = get_checksum(outbuffer,def->mode1_request_length-1);
// form the response message start sequence
char seq[] = { def->mode1_request[0], 0x52+def->mode1_response_length, 0x01};
// flush the serial receive buffer
tcflush(aldl_settings.faldl,TCIFLUSH);
// write the request to the serial interface
write(aldl_settings.faldl,&outbuffer,def->mode1_request_length);
// wait for the bytes to be written
tcdrain(aldl_settings.faldl);
// wait for response from ECM
// read sequence, 50msec timeout
res=read_sequence(aldl_settings.faldl, inbuffer, mode1_len,
seq, 3, 0,
aldl_settings.scan_timeout*1000);
if (res<0)
{
fprintf(stderr,"Error receiving mode1 message: %s\n",strerror(errno));
return -1;
}
if ((unsigned)res<mode1_len)
{
#ifdef _LINUXALDL_DEBUG
fprintf(stderr,"MODE1 timeout occured. (Received %d/%d bytes)\n",res,mode1_len);
#endif
return 0;
}
char checksum = get_checksum(inbuffer,mode1_len-1);
if (inbuffer[mode1_len-1]!=checksum)
{
fprintf(stderr,"MODE 1 bad checksum.\n");
return -1;
}
return res;
}
// reads up to len bytes into inbuffer from the interface.
// listens for a maximum of timeout seconds.
// returns -1 on failure, 0 on timeout with no bytes received,
// and otherwise returns the number of bytes received
int aldl_listen_raw(char* inbuffer, unsigned int len, int timeout)
{
int res;
res = readwithtimeout(aldl_settings.faldl,inbuffer,len,timeout);
return res;
}
// calculates the single-byte checksum, summing from the start of buffer
// through len bytes. the checksum is calculated by adding each byte
// together and ignoring overflow, then taking the two's complement and adding 1
char get_checksum(char* buffer, unsigned int len)
{
char acc = 0x00;
unsigned int i;
for (i=0; i<len; i++)
{
//printf("%d,",buffer[i]);
//if (!(i%16)) printf("\n");
acc+=buffer[i];
}
acc=0xFF-acc;
acc+=0x01;
//printf("Checksum: %d\n",acc);
return acc;
}
// looks up def_name in the aldl_definition_table until it finds the first
// definition in the table with the name def_name
// if the definition is not in the table, returns NULL
aldl_definition* aldl_get_definition(const char* defname)
{
int index = 0;
aldl_definition* result = aldl_definition_table[0];
if (defname == NULL)
return NULL;
while(result!=NULL){
if (strcmp(defname,result->name)==0)
break;
index++;
result = aldl_definition_table[index];
}
return result;
}
// updates data_set_floats and/or data_set_strings using the current data_set_raw bytes.
// if the flags argument is ALDL_UPDATE_STRINGS then only sets will be updated.
// if flags is ALDL_UPDATE_FLOATS then only floats will be updated, and the data_set_strings
// array will not be modified in any way.
// if flags is ALDL_UPDATE_FLOATS|ALDL_UPDATE_STRINGS, then both will be updated.
// if the aldl_settings.data_set_floats or aldl_settings.data_set_strings arrays have
// not yet been initialized (e.g. are NULL pointers) then they will not be modified.
void aldl_update_sets(int flags)
{
unsigned int i=0;
byte_def_t* defs = aldl_settings.definition->mode1_def;
byte_def_t* cur_def;
float converted_val;
char* new_data_string=NULL;
while (defs[i].label != NULL) // while not at the last defined byte
{
cur_def = defs+i;
// if the item is a seperator, skip it
if (cur_def->operation == ALDL_OP_SEPERATOR)
{
i++;
continue;
}
// convert the raw data to a float based on the byte definition
if (cur_def->bits==8)
{
converted_val = aldl_raw8_to_float(aldl_settings.data_set_raw[cur_def->byte_offset-1],
cur_def->operation, cur_def->op_factor, cur_def->op_offset);
}
else if (cur_def->bits==16)
{
converted_val = aldl_raw16_to_float(aldl_settings.data_set_raw[cur_def->byte_offset-1],
aldl_settings.data_set_raw[cur_def->byte_offset],
cur_def->operation, cur_def->op_factor, cur_def->op_offset);
}
else
{ // other numbers of bits not supported
i++;
continue;
}
if ((flags & ALDL_UPDATE_FLOATS) && aldl_settings.data_set_floats != NULL)
aldl_settings.data_set_floats[i] = converted_val;
// convert the result to a string
if ((flags & ALDL_UPDATE_STRINGS) && aldl_settings.data_set_strings != NULL)
{
new_data_string=malloc(10); // allocate ten bytes for the string
snprintf(new_data_string,10,"%.1f",converted_val); // convert the floating point value to a string
// if there is currently a string registered, free it
if (aldl_settings.data_set_strings[i] != NULL)
free(aldl_settings.data_set_strings[i]);
// register the new string in the table
aldl_settings.data_set_strings[i] = new_data_string;
}
//fprintf(stderr,"Updating element %s\n",cur_def->label);
i++;
}
}
// converts the raw 8-bit data value val into a float by performing operation
// using op_factor and op_offset.
// see the documentation for the byte_def_t struct in linuxaldl.h for more information
float aldl_raw8_to_float(unsigned char val, int operation, float op_factor, float op_offset)
{
float result = val;
if (operation == ALDL_OP_MULTIPLY)
result = ((float)val*op_factor)+op_offset;
else if (operation == ALDL_OP_DIVIDE)
result = (op_factor/val)+op_offset;
else
{
result = -999;
fprintf(stderr," aldl_raw_to_float8() error: undefined operation: %d",operation);
}
return result;
}
// converts the raw 16-bit data value val into a float by performing operation
// using op_factor and op_offset.
// see the documentation for the byte_def_t struct in linuxaldl.h for more information
float aldl_raw16_to_float(unsigned char msb, unsigned char lsb, int operation, float op_factor, float op_offset)
{
float result = ((float)msb*256)+(float)lsb;
if (operation == ALDL_OP_MULTIPLY)
result = (result*op_factor)+op_offset;
else if (operation == ALDL_OP_DIVIDE)
result = (op_factor/result)+op_offset;
else
{
result = -999.0;
fprintf(stderr," aldl_raw_to_float16() error: undefined operation: %d",operation);
}
return result;
}

View File

@ -0,0 +1,199 @@
#ifndef LINUXALDL_INCLUDED
#define LINUXALDL_INCLUDED
/*(C) copyright 2008, Steven Snyder, All Rights Reserved
Steven T. Snyder, <stsnyder@ucla.edu> http://www.steventsnyder.com
LICENSING INFORMATION:
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program 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 General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
// debug mode
//#define _LINUXALDL_DEBUG
#define MAX_CONNECT_ATTEMPTS 3
#define BAUDRATE B9600
// macros
#define _ALDL_MESSAGE_MODE8 aldl_settings.definition->mode8_request,aldl_settings.definition->mode8_request_length
#define _ALDL_MESSAGE_MODE9 aldl_settings.definition->mode9_request,aldl_settings.definition->mode9_request_length
#define __MAX_REQUEST_SIZE 16 // maximum size (bytes) of a request message
// to send to the ECM
#define LINUXALDL_MODE1_END_DEF {NULL,0,0,0,0,0,NULL}
typedef enum _ALDL_OP { ALDL_OP_MULTIPLY=0, ALDL_OP_DIVIDE=1, ALDL_OP_SEPERATOR=9} ALDL_OP_t;
#define _DEF_SEP(label) {label,0,0,ALDL_OP_SEPERATOR,0,0,NULL}
// ============================================================================
// ALDL DEFINITION STRUCTS
// ============================================================================
// See linuxaldl_definitions.h for instructions on how to make a new definition
// byte_def_t struct
typedef struct _linuxaldl_byte_definition{
const char* label;
unsigned int byte_offset; // the offset from the 1st byte of the data part
// of the mode1 message
unsigned int bits; // 8 or 16 are currently supported
unsigned int operation; // ALDL_OP_MULTIPLY: (X*factor)+offest
// ALDL_OP_DIVIDE: (factor/X)+offset
// ALDL_OP_SEPERATOR: use this for a seperator for the display,
// not a data item. with this option no other
// values matter except label.
// you can also use the _DEF_SEP(label) macro like:
// _DEF_SEP("---Basic Data---")
float op_factor; // factor for the operation
float op_offset; // offset for the operation
const char* units;
} byte_def_t;
typedef struct _linuxaldl_definition{
const char* name;
char mode1_request[__MAX_REQUEST_SIZE]; // the mode 1 request message, including the checksum
unsigned int mode1_request_length; // the length of the mode 1 message including the checksum
unsigned int mode1_response_length; // the total length of the response from the ecm
unsigned int mode1_data_length; // the number of data bytes in the mode1 message response
unsigned int mode1_data_offset; // the byte offest from the start of the mode1 message response
// to the first byte of the data. e.g. if the data part of the
// message is the 4th byte onward, this should be 3. (1+3 = 4)
byte_def_t* mode1_def; // pointer to start of table of byte_def_t structs.
// the last element must be LINUXALDL_MODE1_END_DEF
char mode8_request[__MAX_REQUEST_SIZE]; // the mode 8 (silence) request message, incl checksum
unsigned int mode8_request_length; // the length of the mode 8 message incl checksum
char mode9_request[__MAX_REQUEST_SIZE]; // the mode 9 (un-silence) request message, incl checksum
unsigned int mode9_request_length; // the length of the mode 9 message including the checksum
} aldl_definition;
// looks up def_name in the aldl_definition_table until it finds the first
// definition in the table with the name def_name
// if the definition is not in the table, returns NULL
aldl_definition* aldl_get_definition(const char* defname);
typedef struct _linuxaldl_settings
{
const char* aldlportname; // path to aldl interface port
int faldl; // aldl serial interface file descriptor
const char* logfilename; // filename for the log file
int flogfile; // file descriptor for log file
int scanning; // 1 when the timer has been set for making scans
// 0 when not scanning
const char* aldldefname; // name for the ALDL definition to be used
aldl_definition* definition; // see linuxaldl_definitions.h
aldl_definition** aldl_definition_table; // array of pointers to data definitions.
// this table is allocated in linuxaldl_definitions.h
// and its value assigned upon the initialization of
// the global "aldl_settings" variable
char* data_set_raw; // the current/most recent set of data from a mode1 message.
// this is allocated when a definition is selected
char** data_set_strings; // pointer to array of data set in string format.
// allocated when a definition is selected in the GUI
float* data_set_floats; // data set in float format
// allocated when a definition is selected in the GUI
unsigned int scan_interval; // msec between scan requests
unsigned int scan_timeout; // msec to timeout on scan request.
// note that read-sequence takes timeout in usec.
// usec = msec*1000
} linuxaldl_settings;
// function prototypes
// =================================================
int verifyaldl();
// wake up / verify the ALDL interface
int aldl_scan_and_log(int fd);
// listens for aldl data and writes it to the file descriptor fd
// stops when terminate_scan = 1 in the global settings struct and
// returns number of bytes written to fd.
char get_checksum(char* buffer, unsigned int len);
// calculates the single-byte checksum, summing from the start of buffer
// through len bytes. the checksum is calculated by summing the bytes,
// dropping carried bits, then adding 1 and taking the two's complement
// (subtract from FF)
int send_aldl_message(char* msg_buf, unsigned int size);
// sends an artibtrary aldl message contained in the buffer msg_buf.
// the checksum must be set in the buffer by the caller.
// the following macros can be used as arguments:
// _ALDL_MESSAGE_MODE8
// _ALDL_MESSAGE_MODE9
// which use the mode 8 and mode 9 message definitions from the
// current aldl definition.
int get_mode1_message(char* inbuffer, unsigned int size);
// requests a mode1 message from the ECM using the currently loaded
// aldl definition.
// returns 0 if the message was received successfully, -1 no response
// or bad checksum.
int aldl_listen_raw(char* inbuffer, unsigned int len, int timeout);
// reads up to len bytes into inbuffer from the interface.
// listens for a maximum of timeout seconds.
// returns -1 on failure, 0 on timeout with no bytes received,
// and otherwise returns the number of bytes received
typedef enum _ALDL_UPDATE_FLAGS { ALDL_UPDATE_STRINGS=1, ALDL_UPDATE_FLOATS=2} ALDL_UPDATE_FLAGS_t;
void aldl_update_sets(int flags);
// updates data_set_floats and/or data_set_strings using the current data_set_raw bytes.
// if the flags argument is ALDL_UPDATE_STRINGS then both sets will be updated.
// if it is ALDL_UPDATE_FLOATS then only floats will be updated, and the data_set_strings
// array will not be modified in any way.
float aldl_raw8_to_float(unsigned char val, int operation, float op_factor, float op_offset);
// converts the raw 8-bit data value val into a float by performing operation
// using op_factor and op_offset.
// see the documentation for the byte_def_t struct for more information
float aldl_raw16_to_float(unsigned char msb, unsigned char lsb, int operation, float op_factor, float op_offset);
// converts the raw 16-bit data value defined by lsb and msb into a float by performing operation
// using op_factor and op_offset.
// see the documentation for the byte_def_t struct for more information
#endif

View File

@ -0,0 +1,119 @@
#ifndef LINUXALDL_DEFINITIONS_INCLUDED
#define LINUXALDL_DEFINITIONS_INCLUDED
/*(C) copyright 2008, Steven Snyder, All Rights Reserved
Steven T. Snyder, <stsnyder@ucla.edu> http://www.steventsnyder.com
LICENSING INFORMATION:
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program 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 General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include <string.h>
#include "linuxaldl.h"
// ===================================================================
// WRITING A DEFINITION FOR LINUXALDL
// ===================================================================
// XXX IMPORTANT NOTE: The definition format is likely to be extremely
// volatile up until version 1.0. I don't recommend spending a lot of
// time writing a definition. It probably wont work in the next version.
// Labels/names/units must not contain white space, commas, newlines,
// or double quotes.
// They may contain: a-z A-Z 0-9 ~!@#$%^&*()-=_+|\/}{:<>?.[];'
// Label/names/units may not be NULL, except for units for seperators,
// and in the last element of the mode1_def[] array. (see below)
// The last element of the mode1_def[] array must be LINUXALDL_MODE1_END_DEF
// (which is a byte_def_t with label and units NULL and all other values 0).
// ===================================================================
// see the DF definition below for a complete example of a definition
// ==========================================
//
// DF CODE MASK DEFINITION
// Engine: 1991-1993 3.4 DOHC V6 (LQ1) Vin "X"
//
// aldl_definition_table entry: aldl_DF
// mode1 definition table: aldl_DF_mode1
// ===========================================
byte_def_t aldl_DF_mode1[]=
{
_DEF_SEP("---Basic Data---"),
{"Engine RPM", 11, 8, 0, 25.0, 0.0, "RPM"},
{"Throttle Position", 10, 8, 0, 0.003906, 0.00, "%"},
{"Vehicle Speed", 17, 8, 0, 1.0, 0.0, "MPH"},
{"Engine Airflow", 37, 8, 0, 1.0, 0.0, "gm/sec"},
{"Coolant Temp", 7, 8, 0, 1.35, -40.0, "Deg F"},
{"Intake Air Temp", 30, 8, 0, 1.0, 0.0, "adc"},
{"MAP", 29, 8, 0, 0.369, 10.354, "kPa"},
_DEF_SEP("----Fuel----"),
{"Desired AFR", 41, 8, 0, 0.100, 0.0, "A/F"},
{"Narrowband O2", 19, 8, 0, 4.42, 0.0, "mV"},
{"Final Base Pulse Width", 42, 16, 0, 0.015259, 0.0, "mSec"},
{"Current BLM Cell", 23, 8, 0, 1.0, 0.0, ""},
{"BLM", 22, 8, 0, 1.0, 0.0, "counts"},
{"Integrator", 24, 8, 0, 1.0, 0.0, "counts"},
{"Base Pulse Fine Corr.",21,8, 0, 1.0, 0.0, "counts"},
{"BLM Cell 0 Timer", 36, 8, 0, 1.0, 0.0, "counts"},
_DEF_SEP("--Ignition--"),
{"Knock Events", 51, 8, 0, 1.0, 0.0, "counts"},
{"Spark Advance", 40, 8, 0, 0.351560, 0.0, "degrees"},
{"Knock Retard", 46, 8, 0, 0.175781, 0.0, "degrees"},
_DEF_SEP("--Accessory Data--"),
{"PROM ID", 1, 16, 0, 1.0, 0.0, "ID"},
{"TPS Voltage", 9, 8, 0, 0.019531, 0.0, "volts"},
{"IAC Steps", 25, 8, 0, 1.0, 0.0, "steps"},
{"IAC Min Position", 22, 8, 0, 1.0, 0.0, "steps"},
{"Barometric Pressure", 28, 8, 0, 0.369, 10.3542,"kPa"},
{"Engine Run Time", 48, 16, 0, 1.0, 0.0, "secs"},
{"Catalytic Conv Temp", 50, 8, 0, 3.0, 300.0, "Deg C"},
{"Fuel Pump Relay Volts",31,8, 0, 0.1, 0.0, "volts"},
{"O2 Cross-Count", 20, 8, 0, 1.0, 0.0, "counts"},
{"Desired Idle Speed", 27, 8, 0, 12.5, 0.0, "RPM"},
{"Battery Voltage", 34, 8, 0, 0.1, 0.0, "volts"},
{"CCP Duty Cycle", 45, 8, 0, 0.390650, 0.0, "% CCP"},
{"RPM/MPH", 47, 8, 0, 1.0, 0.0, "RPM/MPH"},
{"A/C Pressure Sensor", 33, 8, 0, 1.0, 0.0, "A/D Counts"},
{"Corrosivity Sensor", 44, 8, 0, 0.0196, 0.0, "volts"},
LINUXALDL_MODE1_END_DEF
};
aldl_definition aldl_DF = { "91-93 3.4 DOHC LQ1 ($DF)",
{0xF4, 0x57, 0x01, 0x00, 0xB4}, 5, 67, 63, 3, aldl_DF_mode1,
{0xF4, 0x56, 0x08, 0xAE}, 4,
{0xF4, 0x56, 0x09, 0xAD}, 4
};
// ===========================================
// End DF code mask definition
// ===========================================
// =================================================================================
// Definition table -- pointers to each definition must be in this table to use them
// =================================================================================
// aldl_get_definition() uses this table to find the definition corresponding
// to the string given at the command line for the mask= argument.
// the gui uses this table to make the list of definitions.
// the last entry must be NULL.
aldl_definition* aldl_definition_table[2] = { &aldl_DF, NULL };
#endif

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,206 @@
#ifndef LINUXALDL_GUI_INCLUDED
#define LINUXALDL_GUI_INCLUDED
/*(C) copyright 2008, Steven Snyder, All Rights Reserved
Steven T. Snyder, <stsnyder@ucla.edu> http://www.steventsnyder.com
LICENSING INFORMATION:
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program 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 General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include <gtk/gtk.h>
#include "linuxaldl.h"
#include <stdio.h>
typedef enum _aldl_log_format { ALDL_LOG_RAW, ALDL_LOG_CSV } aldl_log_format_t;
// linuxaldl GUI-specific settings/data struct
// ============================================
typedef struct _linuxaldl_gui_settings
{
GtkWidget** data_readout_labels; // array of pointers to the data labels for the definition.
// this is dynamically allocated by the program.
// data_readout_labels[i] points to the label that
// contains a string representation of the value of
// the data element described by definition->mode1_def[i].
// where mode1_def[j] defines a label/seperator,
// the value of data_readout_labels[j] is undefined.
struct timeval data_timestamp; // timestamp for data_set
aldl_log_format_t log_format; // log file format.
FILE* slogfile; // log file stream for CSV format. not used for raw log file format.
int scanning_tag; // the tag returned by gtk_timeout_add for the interval scan
} linuxaldl_gui_settings;
// linuxaldl GUI function prototypes
// ==================================================================
// ==================================
// main GUI function
// ==================================
int linuxaldl_gui(int argc, char* argv[]);
// runs the linuxaldl GTK+ graphical user interface
// ===================================
// EXIT / DELETE_EVENT
// ===================================
static gboolean linuxaldl_gui_quit( GtkWidget *widget, GdkEvent *event, gpointer data);
// called on delete_event, closes the connection (if there is one)
// and call gtk_main_quit(). if a transfer is currently in progress,
// should pop up a dialogue to confirm quitting.
static gboolean hide_on_delete( GtkWidget *widget, GdkEvent *event, gpointer data);
// hides the window then returns TRUE so that a window is not destroyed on a delete event
// ===================================
// SCAN OPERATION FOR GUI MODE
// ===================================
static void linuxaldl_gui_scan_interval_changed( GtkAdjustment *adj, gpointer data);
// callback for change in the adjustment for the aldl_settings.scan_interval field.
// if scanning is not taking place, does nothing except store the new values and enforce
// timeout/ scan interval constraints (interval must be at least 20msec more than timeout).
// otherwise it reassigns the scan interval to the new value immediately.
// adj must point to the GtkAdjustment for the scan interval.
gint linuxaldl_gui_scan_on_interval(gpointer data);
// callback for gtk_timeout interval timer. if aldl_settings.scanning == 1
// then this function will call linuxaldl_gui_scan
static void linuxaldl_gui_scan_toggle( GtkWidget *widget, gpointer data);
// starts/stops scanning. output is written to the log file if one was specified
// otherwise it is written to stdout.
static void linuxaldl_gui_scan(GtkWidget *widget, gpointer data);
// performs a single scan operation (one mode1 message, updates/logs data)
static void linuxaldl_gui_stop( GtkWidget *widget, gpointer data);
// stops scanning. this causes aldl_scan_and_log to return.
// ==========================================================================
//
// GUI accessory windows
//
// ==========================================================================
// ==================================
// Options & Settings window
// ==================================
GtkWidget* linuxaldl_gui_options_new();
// returns a GtkWidget pointer to a new options window
// ==================================
// Data Display window
// ==================================
GtkWidget* linuxaldl_gui_datareadout_new();
// returns a GtkWidget pointer to the datareadout window
static void linuxaldl_gui_datareadout_show(GtkWidget* widget, gpointer data);
// shows the data display window, setting it up for the current definition.
// data must point to the data display window object generated by
// the linuxaldl_gui_datareadout_new function.
// this function builds the data display window,
// and allocates aldl_settings.data_readout_labels
static void linuxaldl_gui_datareadout_update(GtkWidget* widget, gpointer data);
// updates the data display window, refreshing it with the current data values.
// this function will check if aldl_settings.data_readout_labels
// has been allocated yet before it tries to update the values.
// if it has not yet been allocated, it returns doing nothing.
// .csv log file updating is also done here.
// ===================================
// LOAD .LOG FILE SELECTION
// ===================================
static void linuxaldl_gui_load( GtkWidget *widget, GtkFileSelection *fs);
// load a log file to view/playback. XXX NOT YET IMPLEMENTED.
// ===================================
// SAVE .LOG FILE SELECTION
// ===================================
static void linuxaldl_gui_save( GtkWidget *widget, GtkFileSelection *fs);
// selects a log file to save to.
// =======================
// CSV FORMAT LOGGING
// =======================
static void linuxaldl_gui_write_csv_header();
// write the header line to the csv file
static void linuxaldl_gui_write_csv_line();
// write a data line for the csv file
static void linuxaldl_gui_widgetshow(GtkWidget *widget, gpointer data);
// calls gtk_widget_show on the widget specified in the data argument
static void linuxaldl_gui_widgethide(GtkWidget *widget, gpointer data);
// calls gtk_widget_hide on the widget specified in the data argument
// ==================================
// Definition selection dialog
// ==================================
static void linuxaldl_gui_try_choosedef( GtkWidget *widget, gpointer data);
// opens the definition selection dialog if no definition has been selected,
// otherwise pops up an alert and returns
GtkWidget* linuxaldl_gui_choosedef_new();
// returns a GtkWidget pointer to the definition selection dialog
// for the definition table in the global "aldl_settings" struct
static void linuxaldl_gui_load_definition( GtkWidget *widget, gpointer data);
// refreshes the definition in aldl_settings based on the definition name chosen in
// the choose definition gui dialogue
// ==================================
// Alert Window Popup
// ==================================
void quick_alert(gchar *message);
// pops up an alert with message in the body and an ok button.
// the alert will block access to other windows until the button is clicked.
// background activity will continue.
// ==============================
// Adjustment scale with label
// ==============================
// returns a vbox containing a horizontal scale with a new adjustment
// with range min to max and step size step that starts out with the initial value init_val.
// the adjustment calls the function change_callback when the value changes.
GtkWidget* hscale_new_with_label(gdouble init_val, gdouble min, gdouble max, gdouble step, GtkSignalFunc changed, gchar *adj_label);
#endif

View File

@ -0,0 +1,642 @@
/*(C) copyright 2008, Steven Snyder, All Rights Reserved
Steven T. Snyder, <stsnyder@ucla.edu> http://www.steventsnyder.com
LICENSING INFORMATION:
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program 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 General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include <termios.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <sys/ioctl.h>
#include <fcntl.h>
#include <stdio.h>
#include <linux/serial.h>
#include <errno.h>
#include <unistd.h>
#include <signal.h>
#include <string.h> // for strerror
#include <stdlib.h> // for malloc
#include <sys/time.h>
#include "sts_serial.h"
// global variables
// ================
char sts_serial_read_seq_timeout = 0; // timeout flag for read_sequence()
// serial helper function prototypes
// ====================================================
int serial_connect(const char* portpath, int flags, speed_t baudrate);
// attempts to connect to a serial device at portpath (i.e. "/dev/ttyUSB0")
// sets raw mode and sets the baud rate to baudrate. (see `man termios`)
// returns the file descriptor for the connection, or -1 if an error occurs.
// the flags field is the same as the flags for a call to read()
int set_custom_baud_rate(int fport, unsigned int desired_baudrate);
// Attempts to set the baud rate to the closest rate possible to
// the desired_baudrate argument using divisors.
// fport is the file descriptor for the port opened by a call to serial_connect() or open()
// Divisor method:
// it should be possible to do custom baud rates by using a divisor, like
// you would do when you call "setserial /dev/ttyS0 baud_base 115200 divisor 14 spd_cust"
// If the call to setserial wouldn't work for the device, the divisor method wont work here either.
// This is usually due to an unimplemented ioctl function in the device driver.
// Termios custom baud rate method:
// I think tty_ioctl.c has to be compiled into the kernel with BOTHER defined for this to work.
// set cbaud to BOTHER and c_ospeed to the desired setting.
// This is done through a call to set_custom_baud_rate_no_ioctl()
int set_custom_baud_rate_no_ioctl(int fport, unsigned int desired_baudrate);
// XXX this is an untested function (my architecture doesn't have BOTHER defined)
// Termios custom baud rate method:
// tty_ioctl.c has to be compiled into the kernel with BOTHER defined for this to work.
// This is called through set_custom_baud_rate() if a call to ioctl() fails
// ... assuming BOTHER is defined.
int readwithtimeout(int fd, void *buf, size_t count, int secs);
// readwithtimeout - read from a file descriptor with timeout
// description:
// mimics read() but with a timeout that resets whenever a byte is received.
// attempts to read up to count bytes from file descriptor fd into
// the buffer starting at buf. continues to read bytes until count bytes
// have been read or no data has been received for secs seconds.
// return value:
// on success, the number of bytes read is returned, and the file
// position is advanced by this number. it is not an error if this
// number is smaller than the number of bytes requested; this
// may happen for example because fewer bytes are actually available
// right now. on an error, -1 is returned and errno is set appropriately.
void read_sequence_timeout(int signalno);
//read_sequence_timeout()
// handles the SIGALRM signal
int read_sequence(int fd, void *buf, size_t count, char *seq, size_t seq_size, long secs, long usecs);
// read_sequence is used to wait for a specific byte/character, ignoring other sequences
// that arrive on the device. it stops when a timeout occurs or the buffer is filled.
// detailed behavior:
// waits for the first sequence starting with the characters in seq, or times
// out if secs seconds + msecs microseconds pass before seq is matched.
// returns 0 if timeout or sequence never matched, -1 on read failure,
// and otherwise returns the total number of bytes written into buf.
// all bytes up to the first byte of the start sequence are discarded/ignored
// from the device. the start sequence is copied into buf along with the
// following bytes up to count total bytes or the timeout occurs.
// count must be >= seq_size so the sequence can fit in the buffer.
unsigned int convert_baudrate(speed_t baudrate);
// returns the speed_t baudrate defined in <termios.h> in unsigned integer format
// e.g. convert_baudrate(B57600) returns 57600
void fprinthex(FILE *stream, char *seq, unsigned int len);
// print hex sequence of len bytes from char array seq.
// converts the numerical value of each byte in seq to a
// hex character string and prints it to stream.
// hexadecimal bytes are each seperated by spaces.
// there is no trailing space.
void char_to_hexstr(char val, char* buf, unsigned int len);
void int_to_hexstr(int val, char* buf, unsigned int len);
// serial communication helper function definitions
// ==========================================================================
// readwithtimeout - read from a file descriptor with timeout
// description:
// mimics read() but with a timeout that resets whenever a byte is received.
// attempts to read up to count bytes from file descriptor fd into
// the buffer starting at buf. continues to read bytes until count bytes
// have been read or no data has been received for secs seconds.
// return value:
// on success, the number of bytes read is returned, and the file
// position is advanced by this number. if this number is smaller
// than the number of bytes requested, no data was received
// for a period of sec secs; the timeout occured. the data was
// not available (e.g. the device sending the data was too slow).
// on an error, -1 is returned and errno is set appropriately.
int readwithtimeout(int fd, void *buf, size_t count, int secs)
{
fd_set readfs;
struct timeval timeout;
int res;
unsigned int attempts = 0, bytesread = 0;
// wait for input
while (bytesread < count)
{
timeout.tv_usec = 0; timeout.tv_sec = secs;
FD_SET(fd, &readfs);
res = select(fd+1, &readfs, NULL, NULL, &timeout);
if (res == 0) { // nothing to read after timeout
return bytesread;
}
else
{
res = read(fd, buf, count-bytesread);
if (res==-1)
return -1;
bytesread+= res;
attempts++;
}
}
return bytesread;
}
//read_seq_timeout()
// handles the SIGALRM signal
void read_sequence_timeout(int signalno)
{
sts_serial_read_seq_timeout = 1;
}
typedef void (*sighandler_t)(int);
// read_sequence is used to wait for a specific byte/character, ignoring other sequences
// that arrive on the device. it stops when a timeout occurs or the buffer is filled.
// detailed behavior:
// waits for the first sequence starting with the characters in seq, or times
// out if secs seconds + msecs microseconds pass before seq is matched.
// returns 0 if timeout or sequence never matched, -1 on read failure,
// and otherwise returns the total number of bytes written into buf.
// all bytes up to the first byte of the start sequence are discarded/ignored
// from the device. the start sequence is copied into buf along with the
// following bytes up to count total bytes or the timeout occurs.
// count must be >= seq_size so the sequence can fit in the buffer.
// XXX this uses the ITIMER_REAL timer for the timeout. if this timer is
// being used elsewhere in the process, its timer will be delayed by however
// long this call to read_sequence takes, since the timer is saved and then
// restored to its original state.
int read_sequence(int fd, void *buf, size_t count, char *seq, size_t seq_size, long secs, long usecs)
{
unsigned int seq_matched = 0, bytes_read = 0, i;
int res, retval = 0;
size_t seqbuf_size = count;
char* seqbuf = malloc(seqbuf_size);
struct itimerval timer_value, old_timer_value;
sighandler_t old_sig_handler;
sts_serial_read_seq_timeout = 0;
// activate the timeout alarm -- a SIGALRM will be delievered in secs seconds + uscs microseconds.
if (secs > 0 || usecs > 0)
{
old_sig_handler = signal(SIGALRM,read_sequence_timeout); // Register the timeout handler, save the old one
// XXX really should be using sigaction here..
timer_value.it_value.tv_sec = secs;
timer_value.it_value.tv_usec = usecs;
timer_value.it_interval.tv_sec = 0;
timer_value.it_interval.tv_usec = 0;
setitimer(ITIMER_REAL,&timer_value,&old_timer_value);
}
while(sts_serial_read_seq_timeout == 0)
{
// if the sequence has been matched
if (seq_matched == seq_size)
{
//printf("Sequence matched.\n");
// if count bytes have been read, stop and return.
if (bytes_read == count)
{
sts_serial_read_seq_timeout = 1;
break;
}
else{
//printf("Waiting for %d bytes.\n",count-bytes_read);
res = read(fd,buf+bytes_read,count-bytes_read);
if (res==0)
continue;
else if (res<0)
{
if (errno == EAGAIN)
continue;
printf(" read_sequence() call to read() failed: %s\n",strerror(errno));
retval=-1;
}
else bytes_read+=res;
continue;
}
}
else // if the sequence hasn't been matched...
{
res = read(fd, seqbuf, seqbuf_size);
if (res==0)
continue;
else if (res<0)
{
if (errno == EAGAIN)
continue;
printf(" read_sequence() call to read() failed: %s\n",strerror(errno));
retval=-1;
}
//printf("Read %d bytes\n",res);
// for each byte read
else for (i=0; i<res;i++)
{
if (sts_serial_read_seq_timeout == 1)
break;
// if the byte matches the next byte of the sequence to match,
// or the sequence has been matched and there are bytes left in the buffer
else if (seqbuf[i]==seq[seq_matched] || (seq_matched == seq_size))
{
// copy the byte into the buffer
((char *)buf)[bytes_read] = ((char*)seqbuf)[i];
bytes_read++; // increment the number of bytes written to buf
if (seq_matched<seq_size)
{
seq_matched++; // increment the number of seq bytes matched
}
}
else // otherwise the sequence didn't match...
{
// .. reset the counts
seq_matched = 0;
bytes_read = 0;
}
}
} // if the sequence hasn't been matched...
}
// disable the timeout alarm
if (secs > 0 || usecs > 0)
{
signal(SIGALRM,old_sig_handler); // register the old timeout handler
// XXX really should be using sigaction here
setitimer(ITIMER_REAL,&old_timer_value,0); // restore the old timer
}
free(seqbuf);
if (retval == -1)
return retval;
else return bytes_read;
}
// Attempts to set the baud rate to the closest rate possible to
// the desired_baudrate argument using divisors.
// fport is the file descriptor for the port opened by a call to serial_connect() or open()
// Divisor method:
// it should be possible to do custom baud rates by using a divisor, like
// you would do when you call "setserial /dev/ttyS0 baud_base 115200 divisor 14 spd_cust"
// If the call to setserial wouldn't work for the device, the divisor method wont work here either.
// This is usually due to an unimplemented ioctl function in the device driver.
// Termios custom baud rate method:
// I think tty_ioctl.c has to be compiled into the kernel with BOTHER defined for this to work.
// set cbaud to BOTHER and c_ospeed to the desired setting.
// This is done through a call to set_custom_baud_rate_no_ioctl()
int set_custom_baud_rate(int fport, unsigned int desired_baudrate)
{
unsigned int new_baudrate;
struct termios port_attrib;
struct serial_struct serial_info;
int divisor = 1;
if (tcgetattr(fport, &port_attrib) < 0)
{
printf(" tcgetattr() failed to get port settings.\n");
return -1;
}
if (ioctl(fport, TIOCGSERIAL, &serial_info) !=0)
{
printf(" ioctl TIOCGSERIAL failed to get port settings: %s.\n",strerror(errno));
return set_custom_baud_rate_no_ioctl(fport, desired_baudrate);
}
// set the baudrate to B38400 (custom baud setting)
if (cfsetspeed(&port_attrib,B38400) < 0)
{ printf(" Call to cfsetspeed failed. Unable to set baud rate.\n");
return -1;
}
// clear the serial line
tcflush(fport, TCIOFLUSH);
// XXX should make this round to nearest integer instead of
// just using integer division with drops the fractional component
// set the base baud rate if it is less than 115200, to 115200
if (serial_info.baud_base < 115200)
serial_info.baud_base = 115200;
divisor = serial_info.baud_base / desired_baudrate;
// set the custom divisor
serial_info.custom_divisor = divisor;
// set the ASYNC_SPD_CUST flag
serial_info.flags |= (ASYNC_SPD_MASK & ASYNC_SPD_CUST);
// apply the port settings (divisor and baud base)
if (ioctl(fport,TIOCSSERIAL,&serial_info) !=0)
{
printf(" ioctl() TIOCSSERIAL failed to set custom baud rate: %s.\n",strerror(errno));
return set_custom_baud_rate_no_ioctl(fport, desired_baudrate);
}
// apply the port settings (baud rate)
if (tcsetattr(fport,TCSANOW,&port_attrib) < 0)
{
printf(" Failed to apply new port settings.\n");
return -1;
}
// try to get the new termios port settings
if (tcgetattr(fport, &port_attrib) < 0)
{
printf(" Failed to get new port settings.\n");
return -1;
}
// check the new baud rate
new_baudrate = cfgetospeed(&port_attrib);
if ((new_baudrate != B38400) && (new_baudrate != CBAUDEX))
{
printf(" Custom baud rate could not be set with tcsetattr.\n");
return -1;
}
// try to get the new ioctl port settings
if (ioctl(fport, TIOCGSERIAL, &serial_info) !=0)
{
printf(" ioctl TIOCGSERIAL failed to get new port settings.\n");
return set_custom_baud_rate_no_ioctl(fport, desired_baudrate);
}
// check the new baud rate and divisor
if (serial_info.custom_divisor!= divisor)
{
printf(" Custom baud rate could not be set by ioctl.\n");
return set_custom_baud_rate_no_ioctl(fport, desired_baudrate);
}
new_baudrate = serial_info.baud_base/serial_info.custom_divisor;
printf(" Baud rate set to: %d. (%d was requested)\n",new_baudrate, desired_baudrate);
if (desired_baudrate != new_baudrate)
printf(" Exact baud rate could not be set due to hardware limitations.\n");
// clear the serial line
tcflush(fport, TCIOFLUSH);
return 0;
}
// Termios custom baud rate method:
// tty_ioctl.c has to be compiled into the kernel with BOTHER defined for this to work.
// This is called through set_custom_baud_rate() if a call to ioctl() fails
// ... assuming BOTHER is defined.
// XXX this is an untested function (my architecture doesn't have BOTHER defined)
int set_custom_baud_rate_no_ioctl(int fport, unsigned int desired_baudrate)
{
#ifndef BOTHER
return -1;
#endif
#ifdef BOTHER
unsigned int new_baudrate;
struct ktermios port_attrib;
int divisor = 1;
if (tcgetattr(fport, &port_attrib) < 0)
{
printf(" tcgetattr() failed to get port settings.\n");
return -1;
}
// set the baudrate to BOTHER (custom baud setting)
port_attrib.c_cflag &= ~CBAUD; // clear the baud setting
port_attrib.c_cflag |= CBAUDEX; // use custom baud
port_attrib.c_ospeed = desired_baudrate; // custom baud rate
// clear the serial line
tcflush(fport, TCIOFLUSH);
// apply the port settings (baud rate)
if (tcsetattr(fport,TCSANOW,&port_attrib) < 0)
{
printf(" Failed to apply new port settings.\n");
return -1;
}
// try to get the new termios port settings
if (tcgetattr(fport, &port_attrib) < 0)
{
printf(" Failed to get new port settings.\n");
return -1;
}
// check the new baud rate
new_baudrate = cfgetospeed(&port_attrib);
if (new_baudrate != desired_baudrate)
{
printf(" Custom baud rate could not be set with tcsetattr.\n");
return -1;
}
printf(" Baud rate set to: %d. (%d was requested)\n",new_baudrate, desired_baudrate);
if (desired_baudrate != new_baudrate)
printf(" Exact baud rate could not be set due to hardware limitations.\n");
return 0;
#endif
}
// attempts to connect to a serial device at portpath (i.e. "/dev/ttyUSB0")
// sets raw mode and sets the baud rate to baudrate. (see `man termios`)
// returns the file descriptor for the connection, or -1 if an error occurs.
// note that this only supports baud rates defined in termios.
int serial_connect(const char* portpath, int flags, speed_t baudrate)
{
speed_t new_baudrate;
struct termios port_attrib; // termios attributes struct
int fport = open(portpath,flags);
if (fport == -1)
{
printf("Unable to open %s.\n", portpath);
printf("Check that the device is plugged in and turned on.\n");
return -1;
}
// get the current port settings
if (tcgetattr(fport, &port_attrib) < 0)
{
printf(" Failed to get port settings.\n");
close(fport);
return -1;
}
// set raw mode
cfmakeraw(&port_attrib);
// set the baud rate to baudrate
if (cfsetspeed(&port_attrib,baudrate) < 0)
{ printf(" Invalid baud rate specified or other baud rate error.\n");
close(fport);
return -1;}
// clear the serial line
tcflush(fport, TCIOFLUSH);
// apply the port settings (baud rate and raw mode)
if (tcsetattr(fport,TCSANOW,&port_attrib) < 0)
{
printf(" Failed to apply new port settings.\n");
close(fport);
return -1;
}
// try to get the new port settings
if (tcgetattr(fport, &port_attrib) < 0)
{
printf(" Failed to get port settings.\n");
close(fport);
return -1;
}
// print the new baud rate
new_baudrate = cfgetospeed(&port_attrib);
if (new_baudrate == baudrate)
printf(" Port opened at baud rate: %d.\n",convert_baudrate(baudrate));
else
{
printf("Couldn't set baud rate.\n");
close(fport);
return -1;
}
return fport;
}
// returns the speed_t baudrate defined in <termios.h> in unsigned integer format
// e.g. convert_baudrate(B57600) returns 57600. on unrecognized baudrate, returns 0.
unsigned int convert_baudrate(speed_t baudrate)
{
unsigned int res;
switch (baudrate)
{
case B0 : res = 0; break;
case B50 : res = 50; break;
case B75 : res = 75; break;
case B110 : res = 110; break;
case B134 : res = 134; break;
case B150 : res = 150; break;
case B200 : res = 200; break;
case B300 : res = 300; break;
case B600 : res = 600; break;
case B1200 : res = 1200; break;
case B1800 : res = 1800; break;
case B2400 : res = 2400; break;
case B4800 : res = 4800; break;
case B9600 : res = 9600; break;
case B19200 : res = 19200; break;
case B38400 : res = 38400; break;
case B57600 : res = 57600; break;
case B115200 : res = 115200; break;
case B230400 : res = 230400; break;
case B460800 : res = 460800; break;
default: res = 0;
}
return res;
}
// print hex sequence of len bytes from char array seq.
// converts the numerical value of each byte in seq to a
// hex character string and prints it to stream.
// hexadecimal bytes are each seperated by spaces.
// there is no trailing space.
void fprinthex(FILE *stream, char *seq, unsigned int seq_len)
{
unsigned int i;
char hexbuf[3];
for (i=0; i<seq_len; i++)
{
char_to_hexstr(seq[i],hexbuf,3);
fprintf(stream,"%s",hexbuf);
if (i<(seq_len-1))
fprintf(stream," ");
}
}
// convert an integer or char value into a hex string
// and places it in buf. the value is treated as unsigned.
// buf is a char array of length len bytes, val is the
// integer or char value to be converted.
// character conversion: buf must be 3 bytes long
// one for each hex digit and one for the null terminator.
// if len is too small, this function will print an
// error message and return.
// integer conversion: buf must be 9 bytes long
void char_to_hexstr(char val, char* buf, unsigned int len)
{
unsigned char value = (unsigned) val;
char hex_char[] = { '0','1','2','3','4','5','6','7','8','9','A','B','C','D','E','F'};
if (len < 3)
{
fprintf(stderr,"Buffer not large enough for hex conversion.\n");
return;
}
buf[1] = hex_char[value%16];
buf[0] = hex_char[(value>>4)%16];
buf[2] = '\0';
}
void int_to_hexstr(int val, char* buf, unsigned int len)
{
unsigned int value = (unsigned) val;
char hex_char[] = { '0','1','2','3','4','5','6','7','8','9','A','B','C','D','E','F'};
int i=0;
if (len < 9)
{
fprintf(stderr,"Buffer not large enough for hex conversion.\n");
return;
}
for (i=0; i<8; i++)
buf[7-i] = hex_char[(value>>(4*i))%16];
buf[i] = '\0';
}

View File

@ -0,0 +1,114 @@
#ifndef STS_SERIAL_INCLUDED
#define STS_SERIAL_INCLUDED
/*(C) copyright 2008, Steven Snyder, All Rights Reserved
Steven T. Snyder, <stsnyder@ucla.edu> http://www.steventsnyder.com
LICENSING INFORMATION:
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program 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 General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include <termios.h>
#include <sys/types.h>
#include <fcntl.h>
// serial helper function prototypes
// ====================================================
int serial_connect(const char* portpath, int flags, speed_t baudrate);
// attempts to connect to a serial device at portpath (i.e. "/dev/ttyUSB0")
// sets raw mode and sets the baud rate to baudrate. (see `man termios`)
// returns the file descriptor for the connection, or -1 if an error occurs.
// the flags field is the same as the flags for a call to read()
int set_custom_baud_rate(int fport, unsigned int desired_baudrate);
// Attempts to set the baud rate to the closest rate possible to
// the desired_baudrate argument using divisors.
// fport is the file descriptor for the port opened by a call to serial_connect() or open()
// Divisor method:
// it should be possible to do custom baud rates by using a divisor, like
// you would do when you call "setserial /dev/ttyS0 baud_base 115200 divisor 14 spd_cust"
// If the call to setserial wouldn't work for the device, the divisor method wont work here either.
// This is usually due to an unimplemented ioctl function in the device driver.
// Termios custom baud rate method:
// I think tty_ioctl.c has to be compiled into the kernel with BOTHER defined for this to work.
// set cbaud to BOTHER and c_ospeed to the desired setting.
// This is done through a call to set_custom_baud_rate_no_ioctl()
int set_custom_baud_rate_no_ioctl(int fport, unsigned int desired_baudrate);
// XXX this is an untested function (my architecture doesn't have BOTHER defined)
// Termios custom baud rate method:
// tty_ioctl.c has to be compiled into the kernel with BOTHER defined for this to work.
// This is called through set_custom_baud_rate() if a call to ioctl() fails
// ... assuming BOTHER is defined.
int readwithtimeout(int fd, void *buf, size_t count, int secs);
// readwithtimeout - read from a file descriptor with timeout
// description:
// mimics read() but with a timeout that resets whenever a byte is received.
// attempts to read up to count bytes from file descriptor fd into
// the buffer starting at buf. continues to read bytes until count bytes
// have been read or no data has been received for secs seconds.
// return value:
// on success, the number of bytes read is returned, and the file
// position is advanced by this number. it is not an error if this
// number is smaller than the number of bytes requested; this
// may happen for example because fewer bytes are actually available
// right now. on an error, -1 is returned and errno is set appropriately.
void read_sequence_timeout(int signalno);
//read_sequence_timeout()
// handles the SIGALRM signal
int read_sequence(int fd, void *buf, size_t count, char *seq, size_t seq_size, long secs, long usecs);
// read_sequence is used to wait for a specific byte/character, ignoring other sequences
// that arrive on the device. it stops when a timeout occurs or the buffer is filled.
// detailed behavior:
// waits for the first sequence starting with the characters in seq, or times
// out if secs seconds + msecs microseconds pass before seq is matched.
// returns 0 if timeout or sequence never matched, -1 on read failure,
// and otherwise returns the total number of bytes written into buf.
// all bytes up to the first byte of the start sequence are discarded/ignored
// from the device. the start sequence is copied into buf along with the
// following bytes up to count total bytes or the timeout occurs.
// count must be >= seq_size so the sequence can fit in the buffer.
unsigned int convert_baudrate(speed_t baudrate);
// returns the speed_t baudrate defined in <termios.h> in unsigned integer format
// e.g. convert_baudrate(B57600) returns 57600
void fprinthex(FILE *stream, char *seq, unsigned int seq_len);
// print hex sequence of len bytes from char array seq.
// converts the numerical value of each byte in seq to a
// hex character string and prints it to stream.
// hexadecimal bytes are each seperated by spaces.
// there is no trailing space.
void char_to_hexstr(char val, char* buf, unsigned int len);
void int_to_hexstr(int val, char* buf, unsigned int len);
#endif

28
src/Makefile Normal file
View File

@ -0,0 +1,28 @@
# linuxaldl Makefile
CC = gcc
CFLAGS = -g -W -Wall -Wno-unused `pkg-config --cflags gtk+-2.0`
V = @
all: linuxaldl
sts_serial.o: sts_serial.c
@echo + cc sts_serial.c
$(V)$(CC) $(CFLAGS) -c sts_serial.c
linuxaldl.o: linuxaldl.c
@echo + cc linuxaldl.c
$(V)$(CC) $(CFLAGS) -c linuxaldl.c
linuxaldl_gui.o: linuxaldl_gui.c
@echo + cc linuxaldl_gui.c
$(V)$(CC) $(CFLAGS) -c linuxaldl_gui.c
linuxaldl: linuxaldl.o linuxaldl_gui.o sts_serial.o
@echo + link main
$(V)$(CC) $(CFLAGS) -lpopt `pkg-config --libs gtk+-2.0` -o ../bin/$@ linuxaldl.o linuxaldl_gui.o sts_serial.o
clean:
@echo + clean
$(V)rm -rf *.o ../bin/linuxaldl

481
src/linuxaldl.c Normal file
View File

@ -0,0 +1,481 @@
/*(C) copyright 2008, Steven Snyder, All Rights Reserved
Steven T. Snyder, <stsnyder@ucla.edu> http://www.steventsnyder.com
LICENSING INFORMATION:
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program 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 General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include <unistd.h>
#include <stdio.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <sys/signal.h>
#include <fcntl.h>
#include <popt.h> // for command line parsing
#include <gtk/gtk.h>
#include <stdlib.h>
#include <string.h> // for memcpy
#include <errno.h>
#include "linuxaldl.h"
#include "linuxaldl_definitions.h"
#include "linuxaldl_gui.h"
#include "sts_serial.h"
// global variables
// =================================================
linuxaldl_settings aldl_settings = { NULL, 0, NULL, 1, 0, NULL, NULL, aldl_definition_table, NULL, NULL, NULL, 150, 100};
// ============================================================================
//
// linuxaldl
// main ()
//
// ============================================================================
int main(int argc, const char* argv[]){
int res; // temporary storage for function results
int guimode = 0;
// ========================================================================
// COMMAND LINE OPTION PARSING
// ========================================================================
poptContext popt_aldl;
// popt option table
// -----------------
struct poptOption aldl_opt_table[] =
{
{ "serial",'\0',
POPT_ARG_STRING | POPT_ARGFLAG_ONEDASH,&aldl_settings.aldlportname,0,
"Serial port the aldl interface is on",
"/dev/ttyUSB0" },
{ "mask",'\0',
POPT_ARG_STRING | POPT_ARGFLAG_ONEDASH,&aldl_settings.aldldefname,0,
"ALDL code definition to use",
"DF"},
POPT_AUTOHELP
{ NULL, 0, 0, NULL, 0, 0, NULL}
};
// popt context
popt_aldl = poptGetContext(NULL, argc, argv,aldl_opt_table,0);
poptSetOtherOptionHelp(popt_aldl,"[logfile.log]\nTo use GUI: linuxaldl [-serial=/dev/ttyUSB0]");
if (argc<2) { poptPrintUsage(popt_aldl,stderr,0); return 1; }
res = poptGetNextOpt(popt_aldl); // parse the command line arguments
// if no serial port selected, print usage instructions and exit
if (aldl_settings.aldlportname == NULL)
{ poptPrintUsage(popt_aldl,stderr,0); return 1; }
aldl_settings.logfilename = (char*)poptGetArg(popt_aldl);
// if no log file specified or no definition file specified
if ((aldl_settings.logfilename == NULL || !(poptPeekArg(popt_aldl)==NULL || aldl_settings.aldldefname==NULL)))
{
guimode = 1;
}
else // in command line mode, choose definition using the -mask=DEF argument
{
// XXX suggestion: how about adding support for pre-selecting the definition at the command line?
// get the aldl definition address
aldl_settings.definition = aldl_get_definition(aldl_settings.aldldefname);
// if no definition by that name exists, exit
if (aldl_settings.definition == NULL)
{
fprintf(stderr,"Error: No definition with name \"%s\" found.",
aldl_settings.aldldefname);
fprintf(stderr,"Consult the documentation.\n");
fprintf(stderr," Note: definition names are case sensitive.\n");
return -1;
}
}
poptFreeContext(popt_aldl); // free the popt context
// ========================================================================
// CONNECT / VERIFY ALDL INTERFACE
// ========================================================================
// Establish a connection to the aldl
// ===================================
printf("Trying to connect to ALDL interface on %s...\n",aldl_settings.aldlportname);
// connect to the device and set the serial port settings
aldl_settings.faldl = serial_connect(aldl_settings.aldlportname,O_RDWR | O_NOCTTY | O_NONBLOCK,BAUDRATE);
if (aldl_settings.faldl == -1)
{
fprintf(stderr," Couldn't open to %s\n",aldl_settings.aldlportname);
return -1;
}
// set the custom baud rate:
// the ALDL interface operates at 8192. it would be preferable to get as close to this
// baud rate as possible. if it cannot be set; it should still work at the standard
// baud rate of 9600; the framing errors aren't excessive enough to cause problems,
// and will be caught by bad checksums.
if (set_custom_baud_rate(aldl_settings.faldl,8192)!=0)
{
fprintf(stderr," Couldn't set baud rate to 8192. Using standard rate (9600).\n");
fprintf(stderr," There may be framing errors.\n");
}
// verify the aldl
if (verifyaldl()<0)
{
fprintf(stderr," ALDL verification failure. No response from ECM.\n");
tcflush(aldl_settings.faldl, TCIOFLUSH);
close(aldl_settings.faldl);
return -1;
}
// GUI mode if no .log file specified at the command line
// ========================================================================
// LOAD GUI MODE
// ========================================================================
if (guimode)
{
// GUI mode
linuxaldl_gui(argc, (char**)argv);
}
// ========================================================================
// COMMAND LINE MODE
// ========================================================================
else
{
// Open the .log file for writing, create if it doesnt exist
// ------------------------------------------------------------
aldl_settings.flogfile = open(aldl_settings.logfilename,O_RDWR | O_CREAT, 0666);
if (aldl_settings.flogfile == -1)
{
fprintf(stderr,"Unable to open/create %s for writing.\n",aldl_settings.logfilename);
return 0; }
printf("Opened %s for writing.\n",aldl_settings.logfilename);
// Read from the aldl
// ------------------
res = aldl_scan_and_log(aldl_settings.flogfile);
if (res==-1) fprintf(stderr,"Error: Fatal read error occured. log file may be corrupted.\n");
else printf("Received %d bytes from device and wrote to file: %s.\n", res,aldl_settings.logfilename);
close(aldl_settings.flogfile);
}
// ========================================================================
// CLEANUP (FLUSH SERIAL LINE, CLOSE PORT)
// ========================================================================
// discard any unwritten data
tcflush(aldl_settings.faldl, TCIOFLUSH);
// close the port
close(aldl_settings.faldl);
printf("Connection closed.\n");
return 0;
}
// ============================================================
//
// linuxaldl general function definitions
//
// ============================================================
// (mostly used for the command line interface but also main())
// wake up / verify the aldl
// This function should check that the aldl interface is working by listening
// for ECM chatter, or some other operation to determine whether there is
// a line connected to the serial port.
int verifyaldl()
{
//XXX NOT IMPLEMENTED
return 0;
}
int aldl_scan_and_log(int fd)
{
//XXX NOT IMPLEMENTED
return 0;
}
// sends an artibtrary aldl message contained in the buffer msg_buf.
// the checksum must be set in the buffer by the caller.
// the following macros can be used as arguments:
// _ALDL_MESSAGE_MODE8
// _ALDL_MESSAGE_MODE9
// which use the mode 8 and mode 9 message definitions from the
// current aldl definition.
// returns 0 on success.
int send_aldl_message(char* msg_buf, unsigned int size)
{
int res;
#ifdef _LINUXALDL_DEBUG
printf("Sending sequence: ");
fprinthex(stdout,msg_buf,size);
printf("\n");
#endif
res = write(aldl_settings.faldl,&msg_buf,size);
if (res <= 0)
return -1;
else if ((unsigned)res<size)
return -1;
tcdrain(aldl_settings.faldl);
return res;
}
// requests a mode1 message from the ECM using the currently loaded
// aldl definition.
// returns the number of bytes received, if the message was complete.
// 0 is no response/timeout/partial message
// -1 is returned if the checksum is bad.
// XXX this is likely to fail if mode 8 is not set, because the call to read
// will in all probability return part of a normal mode message. a correct
// implementation should wait for a mode 1 message header in the response,
// so that mode 8 isn't even required.
int get_mode1_message(char* inbuffer, unsigned int size)
{
int res;
char checkval;
char outbuffer[__MAX_REQUEST_SIZE]; // max request size defined in linuxaldl_definitions.h
aldl_definition* def = aldl_settings.definition;
unsigned int mode1_len = def->mode1_response_length;
if (size < mode1_len)
{
printf("Read buffer must be at least %d bytes.\n",mode1_len);
return -1;
}
// put the mode 1 request message and checksum in the output buffer
memcpy(outbuffer,def->mode1_request,def->mode1_request_length-1);
outbuffer[def->mode1_request_length-1] = get_checksum(outbuffer,def->mode1_request_length-1);
// form the response message start sequence
char seq[] = { def->mode1_request[0], 0x52+def->mode1_response_length, 0x01};
// flush the serial receive buffer
tcflush(aldl_settings.faldl,TCIFLUSH);
// write the request to the serial interface
write(aldl_settings.faldl,&outbuffer,def->mode1_request_length);
// wait for the bytes to be written
tcdrain(aldl_settings.faldl);
// wait for response from ECM
// read sequence, 50msec timeout
res=read_sequence(aldl_settings.faldl, inbuffer, mode1_len,
seq, 3, 0,
aldl_settings.scan_timeout*1000);
if (res<0)
{
fprintf(stderr,"Error receiving mode1 message: %s\n",strerror(errno));
return -1;
}
if ((unsigned)res<mode1_len)
{
#ifdef _LINUXALDL_DEBUG
fprintf(stderr,"MODE1 timeout occured. (Received %d/%d bytes)\n",res,mode1_len);
#endif
return 0;
}
char checksum = get_checksum(inbuffer,mode1_len-1);
if (inbuffer[mode1_len-1]!=checksum)
{
fprintf(stderr,"MODE 1 bad checksum.\n");
return -1;
}
return res;
}
// reads up to len bytes into inbuffer from the interface.
// listens for a maximum of timeout seconds.
// returns -1 on failure, 0 on timeout with no bytes received,
// and otherwise returns the number of bytes received
int aldl_listen_raw(char* inbuffer, unsigned int len, int timeout)
{
int res;
res = readwithtimeout(aldl_settings.faldl,inbuffer,len,timeout);
return res;
}
// calculates the single-byte checksum, summing from the start of buffer
// through len bytes. the checksum is calculated by adding each byte
// together and ignoring overflow, then taking the two's complement and adding 1
char get_checksum(char* buffer, unsigned int len)
{
char acc = 0x00;
unsigned int i;
for (i=0; i<len; i++)
{
//printf("%d,",buffer[i]);
//if (!(i%16)) printf("\n");
acc+=buffer[i];
}
acc=0xFF-acc;
acc+=0x01;
//printf("Checksum: %d\n",acc);
return acc;
}
// looks up def_name in the aldl_definition_table until it finds the first
// definition in the table with the name def_name
// if the definition is not in the table, returns NULL
aldl_definition* aldl_get_definition(const char* defname)
{
int index = 0;
aldl_definition* result = aldl_definition_table[0];
if (defname == NULL)
return NULL;
while(result!=NULL){
if (strcmp(defname,result->name)==0)
break;
index++;
result = aldl_definition_table[index];
}
return result;
}
// updates data_set_floats and/or data_set_strings using the current data_set_raw bytes.
// if the flags argument is ALDL_UPDATE_STRINGS then only sets will be updated.
// if flags is ALDL_UPDATE_FLOATS then only floats will be updated, and the data_set_strings
// array will not be modified in any way.
// if flags is ALDL_UPDATE_FLOATS|ALDL_UPDATE_STRINGS, then both will be updated.
// if the aldl_settings.data_set_floats or aldl_settings.data_set_strings arrays have
// not yet been initialized (e.g. are NULL pointers) then they will not be modified.
void aldl_update_sets(int flags)
{
unsigned int i=0;
byte_def_t* defs = aldl_settings.definition->mode1_def;
byte_def_t* cur_def;
float converted_val;
char* new_data_string=NULL;
while (defs[i].label != NULL) // while not at the last defined byte
{
cur_def = defs+i;
// if the item is a seperator, skip it
if (cur_def->operation == ALDL_OP_SEPERATOR)
{
i++;
continue;
}
// convert the raw data to a float based on the byte definition
if (cur_def->bits==8)
{
converted_val = aldl_raw8_to_float(aldl_settings.data_set_raw[cur_def->byte_offset-1],
cur_def->operation, cur_def->op_factor, cur_def->op_offset);
}
else if (cur_def->bits==16)
{
converted_val = aldl_raw16_to_float(aldl_settings.data_set_raw[cur_def->byte_offset-1],
aldl_settings.data_set_raw[cur_def->byte_offset],
cur_def->operation, cur_def->op_factor, cur_def->op_offset);
}
else
{ // other numbers of bits not supported
i++;
continue;
}
if ((flags & ALDL_UPDATE_FLOATS) && aldl_settings.data_set_floats != NULL)
aldl_settings.data_set_floats[i] = converted_val;
// convert the result to a string
if ((flags & ALDL_UPDATE_STRINGS) && aldl_settings.data_set_strings != NULL)
{
new_data_string=malloc(10); // allocate ten bytes for the string
snprintf(new_data_string,10,"%.1f",converted_val); // convert the floating point value to a string
// if there is currently a string registered, free it
if (aldl_settings.data_set_strings[i] != NULL)
free(aldl_settings.data_set_strings[i]);
// register the new string in the table
aldl_settings.data_set_strings[i] = new_data_string;
}
//fprintf(stderr,"Updating element %s\n",cur_def->label);
i++;
}
}
// converts the raw 8-bit data value val into a float by performing operation
// using op_factor and op_offset.
// see the documentation for the byte_def_t struct in linuxaldl.h for more information
float aldl_raw8_to_float(unsigned char val, int operation, float op_factor, float op_offset)
{
float result = val;
if (operation == ALDL_OP_MULTIPLY)
result = ((float)val*op_factor)+op_offset;
else if (operation == ALDL_OP_DIVIDE)
result = (op_factor/val)+op_offset;
else
{
result = -999;
fprintf(stderr," aldl_raw_to_float8() error: undefined operation: %d",operation);
}
return result;
}
// converts the raw 16-bit data value val into a float by performing operation
// using op_factor and op_offset.
// see the documentation for the byte_def_t struct in linuxaldl.h for more information
float aldl_raw16_to_float(unsigned char msb, unsigned char lsb, int operation, float op_factor, float op_offset)
{
float result = ((float)msb*256)+(float)lsb;
if (operation == ALDL_OP_MULTIPLY)
result = (result*op_factor)+op_offset;
else if (operation == ALDL_OP_DIVIDE)
result = (op_factor/result)+op_offset;
else
{
result = -999.0;
fprintf(stderr," aldl_raw_to_float16() error: undefined operation: %d",operation);
}
return result;
}

199
src/linuxaldl.h Normal file
View File

@ -0,0 +1,199 @@
#ifndef LINUXALDL_INCLUDED
#define LINUXALDL_INCLUDED
/*(C) copyright 2008, Steven Snyder, All Rights Reserved
Steven T. Snyder, <stsnyder@ucla.edu> http://www.steventsnyder.com
LICENSING INFORMATION:
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program 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 General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
// debug mode
//#define _LINUXALDL_DEBUG
#define MAX_CONNECT_ATTEMPTS 3
#define BAUDRATE B9600
// macros
#define _ALDL_MESSAGE_MODE8 aldl_settings.definition->mode8_request,aldl_settings.definition->mode8_request_length
#define _ALDL_MESSAGE_MODE9 aldl_settings.definition->mode9_request,aldl_settings.definition->mode9_request_length
#define __MAX_REQUEST_SIZE 16 // maximum size (bytes) of a request message
// to send to the ECM
#define LINUXALDL_MODE1_END_DEF {NULL,0,0,0,0,0,NULL}
typedef enum _ALDL_OP { ALDL_OP_MULTIPLY=0, ALDL_OP_DIVIDE=1, ALDL_OP_SEPERATOR=9} ALDL_OP_t;
#define _DEF_SEP(label) {label,0,0,ALDL_OP_SEPERATOR,0,0,NULL}
// ============================================================================
// ALDL DEFINITION STRUCTS
// ============================================================================
// See linuxaldl_definitions.h for instructions on how to make a new definition
// byte_def_t struct
typedef struct _linuxaldl_byte_definition{
const char* label;
unsigned int byte_offset; // the offset from the 1st byte of the data part
// of the mode1 message
unsigned int bits; // 8 or 16 are currently supported
unsigned int operation; // ALDL_OP_MULTIPLY: (X*factor)+offest
// ALDL_OP_DIVIDE: (factor/X)+offset
// ALDL_OP_SEPERATOR: use this for a seperator for the display,
// not a data item. with this option no other
// values matter except label.
// you can also use the _DEF_SEP(label) macro like:
// _DEF_SEP("---Basic Data---")
float op_factor; // factor for the operation
float op_offset; // offset for the operation
const char* units;
} byte_def_t;
typedef struct _linuxaldl_definition{
const char* name;
char mode1_request[__MAX_REQUEST_SIZE]; // the mode 1 request message, including the checksum
unsigned int mode1_request_length; // the length of the mode 1 message including the checksum
unsigned int mode1_response_length; // the total length of the response from the ecm
unsigned int mode1_data_length; // the number of data bytes in the mode1 message response
unsigned int mode1_data_offset; // the byte offest from the start of the mode1 message response
// to the first byte of the data. e.g. if the data part of the
// message is the 4th byte onward, this should be 3. (1+3 = 4)
byte_def_t* mode1_def; // pointer to start of table of byte_def_t structs.
// the last element must be LINUXALDL_MODE1_END_DEF
char mode8_request[__MAX_REQUEST_SIZE]; // the mode 8 (silence) request message, incl checksum
unsigned int mode8_request_length; // the length of the mode 8 message incl checksum
char mode9_request[__MAX_REQUEST_SIZE]; // the mode 9 (un-silence) request message, incl checksum
unsigned int mode9_request_length; // the length of the mode 9 message including the checksum
} aldl_definition;
// looks up def_name in the aldl_definition_table until it finds the first
// definition in the table with the name def_name
// if the definition is not in the table, returns NULL
aldl_definition* aldl_get_definition(const char* defname);
typedef struct _linuxaldl_settings
{
const char* aldlportname; // path to aldl interface port
int faldl; // aldl serial interface file descriptor
const char* logfilename; // filename for the log file
int flogfile; // file descriptor for log file
int scanning; // 1 when the timer has been set for making scans
// 0 when not scanning
const char* aldldefname; // name for the ALDL definition to be used
aldl_definition* definition; // see linuxaldl_definitions.h
aldl_definition** aldl_definition_table; // array of pointers to data definitions.
// this table is allocated in linuxaldl_definitions.h
// and its value assigned upon the initialization of
// the global "aldl_settings" variable
char* data_set_raw; // the current/most recent set of data from a mode1 message.
// this is allocated when a definition is selected
char** data_set_strings; // pointer to array of data set in string format.
// allocated when a definition is selected in the GUI
float* data_set_floats; // data set in float format
// allocated when a definition is selected in the GUI
unsigned int scan_interval; // msec between scan requests
unsigned int scan_timeout; // msec to timeout on scan request.
// note that read-sequence takes timeout in usec.
// usec = msec*1000
} linuxaldl_settings;
// function prototypes
// =================================================
int verifyaldl();
// wake up / verify the ALDL interface
int aldl_scan_and_log(int fd);
// listens for aldl data and writes it to the file descriptor fd
// stops when terminate_scan = 1 in the global settings struct and
// returns number of bytes written to fd.
char get_checksum(char* buffer, unsigned int len);
// calculates the single-byte checksum, summing from the start of buffer
// through len bytes. the checksum is calculated by summing the bytes,
// dropping carried bits, then adding 1 and taking the two's complement
// (subtract from FF)
int send_aldl_message(char* msg_buf, unsigned int size);
// sends an artibtrary aldl message contained in the buffer msg_buf.
// the checksum must be set in the buffer by the caller.
// the following macros can be used as arguments:
// _ALDL_MESSAGE_MODE8
// _ALDL_MESSAGE_MODE9
// which use the mode 8 and mode 9 message definitions from the
// current aldl definition.
int get_mode1_message(char* inbuffer, unsigned int size);
// requests a mode1 message from the ECM using the currently loaded
// aldl definition.
// returns 0 if the message was received successfully, -1 no response
// or bad checksum.
int aldl_listen_raw(char* inbuffer, unsigned int len, int timeout);
// reads up to len bytes into inbuffer from the interface.
// listens for a maximum of timeout seconds.
// returns -1 on failure, 0 on timeout with no bytes received,
// and otherwise returns the number of bytes received
typedef enum _ALDL_UPDATE_FLAGS { ALDL_UPDATE_STRINGS=1, ALDL_UPDATE_FLOATS=2} ALDL_UPDATE_FLAGS_t;
void aldl_update_sets(int flags);
// updates data_set_floats and/or data_set_strings using the current data_set_raw bytes.
// if the flags argument is ALDL_UPDATE_STRINGS then both sets will be updated.
// if it is ALDL_UPDATE_FLOATS then only floats will be updated, and the data_set_strings
// array will not be modified in any way.
float aldl_raw8_to_float(unsigned char val, int operation, float op_factor, float op_offset);
// converts the raw 8-bit data value val into a float by performing operation
// using op_factor and op_offset.
// see the documentation for the byte_def_t struct for more information
float aldl_raw16_to_float(unsigned char msb, unsigned char lsb, int operation, float op_factor, float op_offset);
// converts the raw 16-bit data value defined by lsb and msb into a float by performing operation
// using op_factor and op_offset.
// see the documentation for the byte_def_t struct for more information
#endif

119
src/linuxaldl_definitions.h Normal file
View File

@ -0,0 +1,119 @@
#ifndef LINUXALDL_DEFINITIONS_INCLUDED
#define LINUXALDL_DEFINITIONS_INCLUDED
/*(C) copyright 2008, Steven Snyder, All Rights Reserved
Steven T. Snyder, <stsnyder@ucla.edu> http://www.steventsnyder.com
LICENSING INFORMATION:
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program 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 General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include <string.h>
#include "linuxaldl.h"
// ===================================================================
// WRITING A DEFINITION FOR LINUXALDL
// ===================================================================
// XXX IMPORTANT NOTE: The definition format is likely to be extremely
// volatile up until version 1.0. I don't recommend spending a lot of
// time writing a definition. It probably wont work in the next version.
// Labels/names/units must not contain white space, commas, newlines,
// or double quotes.
// They may contain: a-z A-Z 0-9 ~!@#$%^&*()-=_+|\/}{:<>?.[];'
// Label/names/units may not be NULL, except for units for seperators,
// and in the last element of the mode1_def[] array. (see below)
// The last element of the mode1_def[] array must be LINUXALDL_MODE1_END_DEF
// (which is a byte_def_t with label and units NULL and all other values 0).
// ===================================================================
// see the DF definition below for a complete example of a definition
// ==========================================
//
// DF CODE MASK DEFINITION
// Engine: 1991-1993 3.4 DOHC V6 (LQ1) Vin "X"
//
// aldl_definition_table entry: aldl_DF
// mode1 definition table: aldl_DF_mode1
// ===========================================
byte_def_t aldl_DF_mode1[]=
{
_DEF_SEP("---Basic Data---"),
{"Engine RPM", 11, 8, 0, 25.0, 0.0, "RPM"},
{"Throttle Position", 10, 8, 0, 0.003906, 0.00, "%"},
{"Vehicle Speed", 17, 8, 0, 1.0, 0.0, "MPH"},
{"Engine Airflow", 37, 8, 0, 1.0, 0.0, "gm/sec"},
{"Coolant Temp", 7, 8, 0, 1.35, -40.0, "Deg F"},
{"Intake Air Temp", 30, 8, 0, 1.0, 0.0, "adc"},
{"MAP", 29, 8, 0, 0.369, 10.354, "kPa"},
_DEF_SEP("----Fuel----"),
{"Desired AFR", 41, 8, 0, 0.100, 0.0, "A/F"},
{"Narrowband O2", 19, 8, 0, 4.42, 0.0, "mV"},
{"Final Base Pulse Width", 42, 16, 0, 0.015259, 0.0, "mSec"},
{"Current BLM Cell", 23, 8, 0, 1.0, 0.0, ""},
{"BLM", 22, 8, 0, 1.0, 0.0, "counts"},
{"Integrator", 24, 8, 0, 1.0, 0.0, "counts"},
{"Base Pulse Fine Corr.",21,8, 0, 1.0, 0.0, "counts"},
{"BLM Cell 0 Timer", 36, 8, 0, 1.0, 0.0, "counts"},
_DEF_SEP("--Ignition--"),
{"Knock Events", 51, 8, 0, 1.0, 0.0, "counts"},
{"Spark Advance", 40, 8, 0, 0.351560, 0.0, "degrees"},
{"Knock Retard", 46, 8, 0, 0.175781, 0.0, "degrees"},
_DEF_SEP("--Accessory Data--"),
{"PROM ID", 1, 16, 0, 1.0, 0.0, "ID"},
{"TPS Voltage", 9, 8, 0, 0.019531, 0.0, "volts"},
{"IAC Steps", 25, 8, 0, 1.0, 0.0, "steps"},
{"IAC Min Position", 22, 8, 0, 1.0, 0.0, "steps"},
{"Barometric Pressure", 28, 8, 0, 0.369, 10.3542,"kPa"},
{"Engine Run Time", 48, 16, 0, 1.0, 0.0, "secs"},
{"Catalytic Conv Temp", 50, 8, 0, 3.0, 300.0, "Deg C"},
{"Fuel Pump Relay Volts",31,8, 0, 0.1, 0.0, "volts"},
{"O2 Cross-Count", 20, 8, 0, 1.0, 0.0, "counts"},
{"Desired Idle Speed", 27, 8, 0, 12.5, 0.0, "RPM"},
{"Battery Voltage", 34, 8, 0, 0.1, 0.0, "volts"},
{"CCP Duty Cycle", 45, 8, 0, 0.390650, 0.0, "% CCP"},
{"RPM/MPH", 47, 8, 0, 1.0, 0.0, "RPM/MPH"},
{"A/C Pressure Sensor", 33, 8, 0, 1.0, 0.0, "A/D Counts"},
{"Corrosivity Sensor", 44, 8, 0, 0.0196, 0.0, "volts"},
LINUXALDL_MODE1_END_DEF
};
aldl_definition aldl_DF = { "91-93 3.4 DOHC LQ1 ($DF)",
{0xF4, 0x57, 0x01, 0x00, 0xB4}, 5, 67, 63, 3, aldl_DF_mode1,
{0xF4, 0x56, 0x08, 0xAE}, 4,
{0xF4, 0x56, 0x09, 0xAD}, 4
};
// ===========================================
// End DF code mask definition
// ===========================================
// =================================================================================
// Definition table -- pointers to each definition must be in this table to use them
// =================================================================================
// aldl_get_definition() uses this table to find the definition corresponding
// to the string given at the command line for the mask= argument.
// the gui uses this table to make the list of definitions.
// the last entry must be NULL.
aldl_definition* aldl_definition_table[2] = { &aldl_DF, NULL };
#endif

1064
src/linuxaldl_gui.c Normal file

File diff suppressed because it is too large Load Diff

206
src/linuxaldl_gui.h Normal file
View File

@ -0,0 +1,206 @@
#ifndef LINUXALDL_GUI_INCLUDED
#define LINUXALDL_GUI_INCLUDED
/*(C) copyright 2008, Steven Snyder, All Rights Reserved
Steven T. Snyder, <stsnyder@ucla.edu> http://www.steventsnyder.com
LICENSING INFORMATION:
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program 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 General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include <gtk/gtk.h>
#include "linuxaldl.h"
#include <stdio.h>
typedef enum _aldl_log_format { ALDL_LOG_RAW, ALDL_LOG_CSV } aldl_log_format_t;
// linuxaldl GUI-specific settings/data struct
// ============================================
typedef struct _linuxaldl_gui_settings
{
GtkWidget** data_readout_labels; // array of pointers to the data labels for the definition.
// this is dynamically allocated by the program.
// data_readout_labels[i] points to the label that
// contains a string representation of the value of
// the data element described by definition->mode1_def[i].
// where mode1_def[j] defines a label/seperator,
// the value of data_readout_labels[j] is undefined.
struct timeval data_timestamp; // timestamp for data_set
aldl_log_format_t log_format; // log file format.
FILE* slogfile; // log file stream for CSV format. not used for raw log file format.
int scanning_tag; // the tag returned by gtk_timeout_add for the interval scan
} linuxaldl_gui_settings;
// linuxaldl GUI function prototypes
// ==================================================================
// ==================================
// main GUI function
// ==================================
int linuxaldl_gui(int argc, char* argv[]);
// runs the linuxaldl GTK+ graphical user interface
// ===================================
// EXIT / DELETE_EVENT
// ===================================
static gboolean linuxaldl_gui_quit( GtkWidget *widget, GdkEvent *event, gpointer data);
// called on delete_event, closes the connection (if there is one)
// and call gtk_main_quit(). if a transfer is currently in progress,
// should pop up a dialogue to confirm quitting.
static gboolean hide_on_delete( GtkWidget *widget, GdkEvent *event, gpointer data);
// hides the window then returns TRUE so that a window is not destroyed on a delete event
// ===================================
// SCAN OPERATION FOR GUI MODE
// ===================================
static void linuxaldl_gui_scan_interval_changed( GtkAdjustment *adj, gpointer data);
// callback for change in the adjustment for the aldl_settings.scan_interval field.
// if scanning is not taking place, does nothing except store the new values and enforce
// timeout/ scan interval constraints (interval must be at least 20msec more than timeout).
// otherwise it reassigns the scan interval to the new value immediately.
// adj must point to the GtkAdjustment for the scan interval.
gint linuxaldl_gui_scan_on_interval(gpointer data);
// callback for gtk_timeout interval timer. if aldl_settings.scanning == 1
// then this function will call linuxaldl_gui_scan
static void linuxaldl_gui_scan_toggle( GtkWidget *widget, gpointer data);
// starts/stops scanning. output is written to the log file if one was specified
// otherwise it is written to stdout.
static void linuxaldl_gui_scan(GtkWidget *widget, gpointer data);
// performs a single scan operation (one mode1 message, updates/logs data)
static void linuxaldl_gui_stop( GtkWidget *widget, gpointer data);
// stops scanning. this causes aldl_scan_and_log to return.
// ==========================================================================
//
// GUI accessory windows
//
// ==========================================================================
// ==================================
// Options & Settings window
// ==================================
GtkWidget* linuxaldl_gui_options_new();
// returns a GtkWidget pointer to a new options window
// ==================================
// Data Display window
// ==================================
GtkWidget* linuxaldl_gui_datareadout_new();
// returns a GtkWidget pointer to the datareadout window
static void linuxaldl_gui_datareadout_show(GtkWidget* widget, gpointer data);
// shows the data display window, setting it up for the current definition.
// data must point to the data display window object generated by
// the linuxaldl_gui_datareadout_new function.
// this function builds the data display window,
// and allocates aldl_settings.data_readout_labels
static void linuxaldl_gui_datareadout_update(GtkWidget* widget, gpointer data);
// updates the data display window, refreshing it with the current data values.
// this function will check if aldl_settings.data_readout_labels
// has been allocated yet before it tries to update the values.
// if it has not yet been allocated, it returns doing nothing.
// .csv log file updating is also done here.
// ===================================
// LOAD .LOG FILE SELECTION
// ===================================
static void linuxaldl_gui_load( GtkWidget *widget, GtkFileSelection *fs);
// load a log file to view/playback. XXX NOT YET IMPLEMENTED.
// ===================================
// SAVE .LOG FILE SELECTION
// ===================================
static void linuxaldl_gui_save( GtkWidget *widget, GtkFileSelection *fs);
// selects a log file to save to.
// =======================
// CSV FORMAT LOGGING
// =======================
static void linuxaldl_gui_write_csv_header();
// write the header line to the csv file
static void linuxaldl_gui_write_csv_line();
// write a data line for the csv file
static void linuxaldl_gui_widgetshow(GtkWidget *widget, gpointer data);
// calls gtk_widget_show on the widget specified in the data argument
static void linuxaldl_gui_widgethide(GtkWidget *widget, gpointer data);
// calls gtk_widget_hide on the widget specified in the data argument
// ==================================
// Definition selection dialog
// ==================================
static void linuxaldl_gui_try_choosedef( GtkWidget *widget, gpointer data);
// opens the definition selection dialog if no definition has been selected,
// otherwise pops up an alert and returns
GtkWidget* linuxaldl_gui_choosedef_new();
// returns a GtkWidget pointer to the definition selection dialog
// for the definition table in the global "aldl_settings" struct
static void linuxaldl_gui_load_definition( GtkWidget *widget, gpointer data);
// refreshes the definition in aldl_settings based on the definition name chosen in
// the choose definition gui dialogue
// ==================================
// Alert Window Popup
// ==================================
void quick_alert(gchar *message);
// pops up an alert with message in the body and an ok button.
// the alert will block access to other windows until the button is clicked.
// background activity will continue.
// ==============================
// Adjustment scale with label
// ==============================
// returns a vbox containing a horizontal scale with a new adjustment
// with range min to max and step size step that starts out with the initial value init_val.
// the adjustment calls the function change_callback when the value changes.
GtkWidget* hscale_new_with_label(gdouble init_val, gdouble min, gdouble max, gdouble step, GtkSignalFunc changed, gchar *adj_label);
#endif

642
src/sts_serial.c Normal file
View File

@ -0,0 +1,642 @@
/*(C) copyright 2008, Steven Snyder, All Rights Reserved
Steven T. Snyder, <stsnyder@ucla.edu> http://www.steventsnyder.com
LICENSING INFORMATION:
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program 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 General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include <termios.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <sys/ioctl.h>
#include <fcntl.h>
#include <stdio.h>
#include <linux/serial.h>
#include <errno.h>
#include <unistd.h>
#include <signal.h>
#include <string.h> // for strerror
#include <stdlib.h> // for malloc
#include <sys/time.h>
#include "sts_serial.h"
// global variables
// ================
char sts_serial_read_seq_timeout = 0; // timeout flag for read_sequence()
// serial helper function prototypes
// ====================================================
int serial_connect(const char* portpath, int flags, speed_t baudrate);
// attempts to connect to a serial device at portpath (i.e. "/dev/ttyUSB0")
// sets raw mode and sets the baud rate to baudrate. (see `man termios`)
// returns the file descriptor for the connection, or -1 if an error occurs.
// the flags field is the same as the flags for a call to read()
int set_custom_baud_rate(int fport, unsigned int desired_baudrate);
// Attempts to set the baud rate to the closest rate possible to
// the desired_baudrate argument using divisors.
// fport is the file descriptor for the port opened by a call to serial_connect() or open()
// Divisor method:
// it should be possible to do custom baud rates by using a divisor, like
// you would do when you call "setserial /dev/ttyS0 baud_base 115200 divisor 14 spd_cust"
// If the call to setserial wouldn't work for the device, the divisor method wont work here either.
// This is usually due to an unimplemented ioctl function in the device driver.
// Termios custom baud rate method:
// I think tty_ioctl.c has to be compiled into the kernel with BOTHER defined for this to work.
// set cbaud to BOTHER and c_ospeed to the desired setting.
// This is done through a call to set_custom_baud_rate_no_ioctl()
int set_custom_baud_rate_no_ioctl(int fport, unsigned int desired_baudrate);
// XXX this is an untested function (my architecture doesn't have BOTHER defined)
// Termios custom baud rate method:
// tty_ioctl.c has to be compiled into the kernel with BOTHER defined for this to work.
// This is called through set_custom_baud_rate() if a call to ioctl() fails
// ... assuming BOTHER is defined.
int readwithtimeout(int fd, void *buf, size_t count, int secs);
// readwithtimeout - read from a file descriptor with timeout
// description:
// mimics read() but with a timeout that resets whenever a byte is received.
// attempts to read up to count bytes from file descriptor fd into
// the buffer starting at buf. continues to read bytes until count bytes
// have been read or no data has been received for secs seconds.
// return value:
// on success, the number of bytes read is returned, and the file
// position is advanced by this number. it is not an error if this
// number is smaller than the number of bytes requested; this
// may happen for example because fewer bytes are actually available
// right now. on an error, -1 is returned and errno is set appropriately.
void read_sequence_timeout(int signalno);
//read_sequence_timeout()
// handles the SIGALRM signal
int read_sequence(int fd, void *buf, size_t count, char *seq, size_t seq_size, long secs, long usecs);
// read_sequence is used to wait for a specific byte/character, ignoring other sequences
// that arrive on the device. it stops when a timeout occurs or the buffer is filled.
// detailed behavior:
// waits for the first sequence starting with the characters in seq, or times
// out if secs seconds + msecs microseconds pass before seq is matched.
// returns 0 if timeout or sequence never matched, -1 on read failure,
// and otherwise returns the total number of bytes written into buf.
// all bytes up to the first byte of the start sequence are discarded/ignored
// from the device. the start sequence is copied into buf along with the
// following bytes up to count total bytes or the timeout occurs.
// count must be >= seq_size so the sequence can fit in the buffer.
unsigned int convert_baudrate(speed_t baudrate);
// returns the speed_t baudrate defined in <termios.h> in unsigned integer format
// e.g. convert_baudrate(B57600) returns 57600
void fprinthex(FILE *stream, char *seq, unsigned int len);
// print hex sequence of len bytes from char array seq.
// converts the numerical value of each byte in seq to a
// hex character string and prints it to stream.
// hexadecimal bytes are each seperated by spaces.
// there is no trailing space.
void char_to_hexstr(char val, char* buf, unsigned int len);
void int_to_hexstr(int val, char* buf, unsigned int len);
// serial communication helper function definitions
// ==========================================================================
// readwithtimeout - read from a file descriptor with timeout
// description:
// mimics read() but with a timeout that resets whenever a byte is received.
// attempts to read up to count bytes from file descriptor fd into
// the buffer starting at buf. continues to read bytes until count bytes
// have been read or no data has been received for secs seconds.
// return value:
// on success, the number of bytes read is returned, and the file
// position is advanced by this number. if this number is smaller
// than the number of bytes requested, no data was received
// for a period of sec secs; the timeout occured. the data was
// not available (e.g. the device sending the data was too slow).
// on an error, -1 is returned and errno is set appropriately.
int readwithtimeout(int fd, void *buf, size_t count, int secs)
{
fd_set readfs;
struct timeval timeout;
int res;
unsigned int attempts = 0, bytesread = 0;
// wait for input
while (bytesread < count)
{
timeout.tv_usec = 0; timeout.tv_sec = secs;
FD_SET(fd, &readfs);
res = select(fd+1, &readfs, NULL, NULL, &timeout);
if (res == 0) { // nothing to read after timeout
return bytesread;
}
else
{
res = read(fd, buf, count-bytesread);
if (res==-1)
return -1;
bytesread+= res;
attempts++;
}
}
return bytesread;
}
//read_seq_timeout()
// handles the SIGALRM signal
void read_sequence_timeout(int signalno)
{
sts_serial_read_seq_timeout = 1;
}
typedef void (*sighandler_t)(int);
// read_sequence is used to wait for a specific byte/character, ignoring other sequences
// that arrive on the device. it stops when a timeout occurs or the buffer is filled.
// detailed behavior:
// waits for the first sequence starting with the characters in seq, or times
// out if secs seconds + msecs microseconds pass before seq is matched.
// returns 0 if timeout or sequence never matched, -1 on read failure,
// and otherwise returns the total number of bytes written into buf.
// all bytes up to the first byte of the start sequence are discarded/ignored
// from the device. the start sequence is copied into buf along with the
// following bytes up to count total bytes or the timeout occurs.
// count must be >= seq_size so the sequence can fit in the buffer.
// XXX this uses the ITIMER_REAL timer for the timeout. if this timer is
// being used elsewhere in the process, its timer will be delayed by however
// long this call to read_sequence takes, since the timer is saved and then
// restored to its original state.
int read_sequence(int fd, void *buf, size_t count, char *seq, size_t seq_size, long secs, long usecs)
{
unsigned int seq_matched = 0, bytes_read = 0, i;
int res, retval = 0;
size_t seqbuf_size = count;
char* seqbuf = malloc(seqbuf_size);
struct itimerval timer_value, old_timer_value;
sighandler_t old_sig_handler;
sts_serial_read_seq_timeout = 0;
// activate the timeout alarm -- a SIGALRM will be delievered in secs seconds + uscs microseconds.
if (secs > 0 || usecs > 0)
{
old_sig_handler = signal(SIGALRM,read_sequence_timeout); // Register the timeout handler, save the old one
// XXX really should be using sigaction here..
timer_value.it_value.tv_sec = secs;
timer_value.it_value.tv_usec = usecs;
timer_value.it_interval.tv_sec = 0;
timer_value.it_interval.tv_usec = 0;
setitimer(ITIMER_REAL,&timer_value,&old_timer_value);
}
while(sts_serial_read_seq_timeout == 0)
{
// if the sequence has been matched
if (seq_matched == seq_size)
{
//printf("Sequence matched.\n");
// if count bytes have been read, stop and return.
if (bytes_read == count)
{
sts_serial_read_seq_timeout = 1;
break;
}
else{
//printf("Waiting for %d bytes.\n",count-bytes_read);
res = read(fd,buf+bytes_read,count-bytes_read);
if (res==0)
continue;
else if (res<0)
{
if (errno == EAGAIN)
continue;
printf(" read_sequence() call to read() failed: %s\n",strerror(errno));
retval=-1;
}
else bytes_read+=res;
continue;
}
}
else // if the sequence hasn't been matched...
{
res = read(fd, seqbuf, seqbuf_size);
if (res==0)
continue;
else if (res<0)
{
if (errno == EAGAIN)
continue;
printf(" read_sequence() call to read() failed: %s\n",strerror(errno));
retval=-1;
}
//printf("Read %d bytes\n",res);
// for each byte read
else for (i=0; i<res;i++)
{
if (sts_serial_read_seq_timeout == 1)
break;
// if the byte matches the next byte of the sequence to match,
// or the sequence has been matched and there are bytes left in the buffer
else if (seqbuf[i]==seq[seq_matched] || (seq_matched == seq_size))
{
// copy the byte into the buffer
((char *)buf)[bytes_read] = ((char*)seqbuf)[i];
bytes_read++; // increment the number of bytes written to buf
if (seq_matched<seq_size)
{
seq_matched++; // increment the number of seq bytes matched
}
}
else // otherwise the sequence didn't match...
{
// .. reset the counts
seq_matched = 0;
bytes_read = 0;
}
}
} // if the sequence hasn't been matched...
}
// disable the timeout alarm
if (secs > 0 || usecs > 0)
{
signal(SIGALRM,old_sig_handler); // register the old timeout handler
// XXX really should be using sigaction here
setitimer(ITIMER_REAL,&old_timer_value,0); // restore the old timer
}
free(seqbuf);
if (retval == -1)
return retval;
else return bytes_read;
}
// Attempts to set the baud rate to the closest rate possible to
// the desired_baudrate argument using divisors.
// fport is the file descriptor for the port opened by a call to serial_connect() or open()
// Divisor method:
// it should be possible to do custom baud rates by using a divisor, like
// you would do when you call "setserial /dev/ttyS0 baud_base 115200 divisor 14 spd_cust"
// If the call to setserial wouldn't work for the device, the divisor method wont work here either.
// This is usually due to an unimplemented ioctl function in the device driver.
// Termios custom baud rate method:
// I think tty_ioctl.c has to be compiled into the kernel with BOTHER defined for this to work.
// set cbaud to BOTHER and c_ospeed to the desired setting.
// This is done through a call to set_custom_baud_rate_no_ioctl()
int set_custom_baud_rate(int fport, unsigned int desired_baudrate)
{
unsigned int new_baudrate;
struct termios port_attrib;
struct serial_struct serial_info;
int divisor = 1;
if (tcgetattr(fport, &port_attrib) < 0)
{
printf(" tcgetattr() failed to get port settings.\n");
return -1;
}
if (ioctl(fport, TIOCGSERIAL, &serial_info) !=0)
{
printf(" ioctl TIOCGSERIAL failed to get port settings: %s.\n",strerror(errno));
return set_custom_baud_rate_no_ioctl(fport, desired_baudrate);
}
// set the baudrate to B38400 (custom baud setting)
if (cfsetspeed(&port_attrib,B38400) < 0)
{ printf(" Call to cfsetspeed failed. Unable to set baud rate.\n");
return -1;
}
// clear the serial line
tcflush(fport, TCIOFLUSH);
// XXX should make this round to nearest integer instead of
// just using integer division with drops the fractional component
// set the base baud rate if it is less than 115200, to 115200
if (serial_info.baud_base < 115200)
serial_info.baud_base = 115200;
divisor = serial_info.baud_base / desired_baudrate;
// set the custom divisor
serial_info.custom_divisor = divisor;
// set the ASYNC_SPD_CUST flag
serial_info.flags |= (ASYNC_SPD_MASK & ASYNC_SPD_CUST);
// apply the port settings (divisor and baud base)
if (ioctl(fport,TIOCSSERIAL,&serial_info) !=0)
{
printf(" ioctl() TIOCSSERIAL failed to set custom baud rate: %s.\n",strerror(errno));
return set_custom_baud_rate_no_ioctl(fport, desired_baudrate);
}
// apply the port settings (baud rate)
if (tcsetattr(fport,TCSANOW,&port_attrib) < 0)
{
printf(" Failed to apply new port settings.\n");
return -1;
}
// try to get the new termios port settings
if (tcgetattr(fport, &port_attrib) < 0)
{
printf(" Failed to get new port settings.\n");
return -1;
}
// check the new baud rate
new_baudrate = cfgetospeed(&port_attrib);
if ((new_baudrate != B38400) && (new_baudrate != CBAUDEX))
{
printf(" Custom baud rate could not be set with tcsetattr.\n");
return -1;
}
// try to get the new ioctl port settings
if (ioctl(fport, TIOCGSERIAL, &serial_info) !=0)
{
printf(" ioctl TIOCGSERIAL failed to get new port settings.\n");
return set_custom_baud_rate_no_ioctl(fport, desired_baudrate);
}
// check the new baud rate and divisor
if (serial_info.custom_divisor!= divisor)
{
printf(" Custom baud rate could not be set by ioctl.\n");
return set_custom_baud_rate_no_ioctl(fport, desired_baudrate);
}
new_baudrate = serial_info.baud_base/serial_info.custom_divisor;
printf(" Baud rate set to: %d. (%d was requested)\n",new_baudrate, desired_baudrate);
if (desired_baudrate != new_baudrate)
printf(" Exact baud rate could not be set due to hardware limitations.\n");
// clear the serial line
tcflush(fport, TCIOFLUSH);
return 0;
}
// Termios custom baud rate method:
// tty_ioctl.c has to be compiled into the kernel with BOTHER defined for this to work.
// This is called through set_custom_baud_rate() if a call to ioctl() fails
// ... assuming BOTHER is defined.
// XXX this is an untested function (my architecture doesn't have BOTHER defined)
int set_custom_baud_rate_no_ioctl(int fport, unsigned int desired_baudrate)
{
#ifndef BOTHER
return -1;
#endif
#ifdef BOTHER
unsigned int new_baudrate;
struct ktermios port_attrib;
int divisor = 1;
if (tcgetattr(fport, &port_attrib) < 0)
{
printf(" tcgetattr() failed to get port settings.\n");
return -1;
}
// set the baudrate to BOTHER (custom baud setting)
port_attrib.c_cflag &= ~CBAUD; // clear the baud setting
port_attrib.c_cflag |= CBAUDEX; // use custom baud
port_attrib.c_ospeed = desired_baudrate; // custom baud rate
// clear the serial line
tcflush(fport, TCIOFLUSH);
// apply the port settings (baud rate)
if (tcsetattr(fport,TCSANOW,&port_attrib) < 0)
{
printf(" Failed to apply new port settings.\n");
return -1;
}
// try to get the new termios port settings
if (tcgetattr(fport, &port_attrib) < 0)
{
printf(" Failed to get new port settings.\n");
return -1;
}
// check the new baud rate
new_baudrate = cfgetospeed(&port_attrib);
if (new_baudrate != desired_baudrate)
{
printf(" Custom baud rate could not be set with tcsetattr.\n");
return -1;
}
printf(" Baud rate set to: %d. (%d was requested)\n",new_baudrate, desired_baudrate);
if (desired_baudrate != new_baudrate)
printf(" Exact baud rate could not be set due to hardware limitations.\n");
return 0;
#endif
}
// attempts to connect to a serial device at portpath (i.e. "/dev/ttyUSB0")
// sets raw mode and sets the baud rate to baudrate. (see `man termios`)
// returns the file descriptor for the connection, or -1 if an error occurs.
// note that this only supports baud rates defined in termios.
int serial_connect(const char* portpath, int flags, speed_t baudrate)
{
speed_t new_baudrate;
struct termios port_attrib; // termios attributes struct
int fport = open(portpath,flags);
if (fport == -1)
{
printf("Unable to open %s.\n", portpath);
printf("Check that the device is plugged in and turned on.\n");
return -1;
}
// get the current port settings
if (tcgetattr(fport, &port_attrib) < 0)
{
printf(" Failed to get port settings.\n");
close(fport);
return -1;
}
// set raw mode
cfmakeraw(&port_attrib);
// set the baud rate to baudrate
if (cfsetspeed(&port_attrib,baudrate) < 0)
{ printf(" Invalid baud rate specified or other baud rate error.\n");
close(fport);
return -1;}
// clear the serial line
tcflush(fport, TCIOFLUSH);
// apply the port settings (baud rate and raw mode)
if (tcsetattr(fport,TCSANOW,&port_attrib) < 0)
{
printf(" Failed to apply new port settings.\n");
close(fport);
return -1;
}
// try to get the new port settings
if (tcgetattr(fport, &port_attrib) < 0)
{
printf(" Failed to get port settings.\n");
close(fport);
return -1;
}
// print the new baud rate
new_baudrate = cfgetospeed(&port_attrib);
if (new_baudrate == baudrate)
printf(" Port opened at baud rate: %d.\n",convert_baudrate(baudrate));
else
{
printf("Couldn't set baud rate.\n");
close(fport);
return -1;
}
return fport;
}
// returns the speed_t baudrate defined in <termios.h> in unsigned integer format
// e.g. convert_baudrate(B57600) returns 57600. on unrecognized baudrate, returns 0.
unsigned int convert_baudrate(speed_t baudrate)
{
unsigned int res;
switch (baudrate)
{
case B0 : res = 0; break;
case B50 : res = 50; break;
case B75 : res = 75; break;
case B110 : res = 110; break;
case B134 : res = 134; break;
case B150 : res = 150; break;
case B200 : res = 200; break;
case B300 : res = 300; break;
case B600 : res = 600; break;
case B1200 : res = 1200; break;
case B1800 : res = 1800; break;
case B2400 : res = 2400; break;
case B4800 : res = 4800; break;
case B9600 : res = 9600; break;
case B19200 : res = 19200; break;
case B38400 : res = 38400; break;
case B57600 : res = 57600; break;
case B115200 : res = 115200; break;
case B230400 : res = 230400; break;
case B460800 : res = 460800; break;
default: res = 0;
}
return res;
}
// print hex sequence of len bytes from char array seq.
// converts the numerical value of each byte in seq to a
// hex character string and prints it to stream.
// hexadecimal bytes are each seperated by spaces.
// there is no trailing space.
void fprinthex(FILE *stream, char *seq, unsigned int seq_len)
{
unsigned int i;
char hexbuf[3];
for (i=0; i<seq_len; i++)
{
char_to_hexstr(seq[i],hexbuf,3);
fprintf(stream,"%s",hexbuf);
if (i<(seq_len-1))
fprintf(stream," ");
}
}
// convert an integer or char value into a hex string
// and places it in buf. the value is treated as unsigned.
// buf is a char array of length len bytes, val is the
// integer or char value to be converted.
// character conversion: buf must be 3 bytes long
// one for each hex digit and one for the null terminator.
// if len is too small, this function will print an
// error message and return.
// integer conversion: buf must be 9 bytes long
void char_to_hexstr(char val, char* buf, unsigned int len)
{
unsigned char value = (unsigned) val;
char hex_char[] = { '0','1','2','3','4','5','6','7','8','9','A','B','C','D','E','F'};
if (len < 3)
{
fprintf(stderr,"Buffer not large enough for hex conversion.\n");
return;
}
buf[1] = hex_char[value%16];
buf[0] = hex_char[(value>>4)%16];
buf[2] = '\0';
}
void int_to_hexstr(int val, char* buf, unsigned int len)
{
unsigned int value = (unsigned) val;
char hex_char[] = { '0','1','2','3','4','5','6','7','8','9','A','B','C','D','E','F'};
int i=0;
if (len < 9)
{
fprintf(stderr,"Buffer not large enough for hex conversion.\n");
return;
}
for (i=0; i<8; i++)
buf[7-i] = hex_char[(value>>(4*i))%16];
buf[i] = '\0';
}

114
src/sts_serial.h Normal file
View File

@ -0,0 +1,114 @@
#ifndef STS_SERIAL_INCLUDED
#define STS_SERIAL_INCLUDED
/*(C) copyright 2008, Steven Snyder, All Rights Reserved
Steven T. Snyder, <stsnyder@ucla.edu> http://www.steventsnyder.com
LICENSING INFORMATION:
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program 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 General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include <termios.h>
#include <sys/types.h>
#include <fcntl.h>
// serial helper function prototypes
// ====================================================
int serial_connect(const char* portpath, int flags, speed_t baudrate);
// attempts to connect to a serial device at portpath (i.e. "/dev/ttyUSB0")
// sets raw mode and sets the baud rate to baudrate. (see `man termios`)
// returns the file descriptor for the connection, or -1 if an error occurs.
// the flags field is the same as the flags for a call to read()
int set_custom_baud_rate(int fport, unsigned int desired_baudrate);
// Attempts to set the baud rate to the closest rate possible to
// the desired_baudrate argument using divisors.
// fport is the file descriptor for the port opened by a call to serial_connect() or open()
// Divisor method:
// it should be possible to do custom baud rates by using a divisor, like
// you would do when you call "setserial /dev/ttyS0 baud_base 115200 divisor 14 spd_cust"
// If the call to setserial wouldn't work for the device, the divisor method wont work here either.
// This is usually due to an unimplemented ioctl function in the device driver.
// Termios custom baud rate method:
// I think tty_ioctl.c has to be compiled into the kernel with BOTHER defined for this to work.
// set cbaud to BOTHER and c_ospeed to the desired setting.
// This is done through a call to set_custom_baud_rate_no_ioctl()
int set_custom_baud_rate_no_ioctl(int fport, unsigned int desired_baudrate);
// XXX this is an untested function (my architecture doesn't have BOTHER defined)
// Termios custom baud rate method:
// tty_ioctl.c has to be compiled into the kernel with BOTHER defined for this to work.
// This is called through set_custom_baud_rate() if a call to ioctl() fails
// ... assuming BOTHER is defined.
int readwithtimeout(int fd, void *buf, size_t count, int secs);
// readwithtimeout - read from a file descriptor with timeout
// description:
// mimics read() but with a timeout that resets whenever a byte is received.
// attempts to read up to count bytes from file descriptor fd into
// the buffer starting at buf. continues to read bytes until count bytes
// have been read or no data has been received for secs seconds.
// return value:
// on success, the number of bytes read is returned, and the file
// position is advanced by this number. it is not an error if this
// number is smaller than the number of bytes requested; this
// may happen for example because fewer bytes are actually available
// right now. on an error, -1 is returned and errno is set appropriately.
void read_sequence_timeout(int signalno);
//read_sequence_timeout()
// handles the SIGALRM signal
int read_sequence(int fd, void *buf, size_t count, char *seq, size_t seq_size, long secs, long usecs);
// read_sequence is used to wait for a specific byte/character, ignoring other sequences
// that arrive on the device. it stops when a timeout occurs or the buffer is filled.
// detailed behavior:
// waits for the first sequence starting with the characters in seq, or times
// out if secs seconds + msecs microseconds pass before seq is matched.
// returns 0 if timeout or sequence never matched, -1 on read failure,
// and otherwise returns the total number of bytes written into buf.
// all bytes up to the first byte of the start sequence are discarded/ignored
// from the device. the start sequence is copied into buf along with the
// following bytes up to count total bytes or the timeout occurs.
// count must be >= seq_size so the sequence can fit in the buffer.
unsigned int convert_baudrate(speed_t baudrate);
// returns the speed_t baudrate defined in <termios.h> in unsigned integer format
// e.g. convert_baudrate(B57600) returns 57600
void fprinthex(FILE *stream, char *seq, unsigned int seq_len);
// print hex sequence of len bytes from char array seq.
// converts the numerical value of each byte in seq to a
// hex character string and prints it to stream.
// hexadecimal bytes are each seperated by spaces.
// there is no trailing space.
void char_to_hexstr(char val, char* buf, unsigned int len);
void int_to_hexstr(int val, char* buf, unsigned int len);
#endif