From: Hugo Villeneuve Date: Tue, 1 Dec 2020 18:50:01 +0000 (-0500) Subject: Initial import X-Git-Url: http://gitweb.hugovil.com/sitemap.xml?a=commitdiff_plain;h=bd42b9ced80e3bcfa83a6f726d419c66f3bb23af;p=hvrtc.git Initial import Setup autotools project. Signed-off-by: Hugo Villeneuve --- bd42b9ced80e3bcfa83a6f726d419c66f3bb23af diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..614e2ff --- /dev/null +++ b/.gitignore @@ -0,0 +1,22 @@ +*.o +*/.deps/ +*~ +/aclocal.m4 +/autom4te.cache +/config.cache +/config.log +/config.status +/configure +Makefile +Makefile.in +config-h.in +config.h +stamp-h1 +src/hvrtc +m4/libtool.m4 +m4/ltoptions.m4 +m4/ltsugar.m4 +m4/ltversion.m4 +m4/lt~obsolete.m4 +build-aux/ltmain.sh +libtool diff --git a/AUTHORS b/AUTHORS new file mode 100644 index 0000000..35db534 --- /dev/null +++ b/AUTHORS @@ -0,0 +1,4 @@ +Authors of hvrtc. + +Written by Hugo Villeneuve. +Based on "Real Time Clock Driver Test/Example Program" by Paul Gortmaker. diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..d60c31a --- /dev/null +++ b/COPYING @@ -0,0 +1,340 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc. + 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Library General Public License instead.) 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 +this service 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 make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. 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. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute 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 and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the 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 a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, 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. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE 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. + + 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 +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This 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 2 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, write to the Free Software + Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision 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, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This 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 Library General +Public License instead of this License. diff --git a/ChangeLog b/ChangeLog new file mode 100644 index 0000000..e69de29 diff --git a/INSTALL b/INSTALL new file mode 100644 index 0000000..a4b3414 --- /dev/null +++ b/INSTALL @@ -0,0 +1,229 @@ +Copyright 1994, 1995, 1996, 1999, 2000, 2001, 2002 Free Software +Foundation, Inc. + + This file is free documentation; the Free Software Foundation gives +unlimited permission to copy, distribute and modify it. + +Basic Installation +================== + + These are generic installation instructions. + + The `configure' shell script attempts to guess correct values for +various system-dependent variables used during compilation. It uses +those values to create a `Makefile' in each directory of the package. +It may also create one or more `.h' files containing system-dependent +definitions. Finally, it creates a shell script `config.status' that +you can run in the future to recreate the current configuration, and a +file `config.log' containing compiler output (useful mainly for +debugging `configure'). + + It can also use an optional file (typically called `config.cache' +and enabled with `--cache-file=config.cache' or simply `-C') that saves +the results of its tests to speed up reconfiguring. (Caching is +disabled by default to prevent problems with accidental use of stale +cache files.) + + If you need to do unusual things to compile the package, please try +to figure out how `configure' could check whether to do them, and mail +diffs or instructions to the address given in the `README' so they can +be considered for the next release. If you are using the cache, and at +some point `config.cache' contains results you don't want to keep, you +may remove or edit it. + + The file `configure.ac' (or `configure.in') is used to create +`configure' by a program called `autoconf'. You only need +`configure.ac' if you want to change it or regenerate `configure' using +a newer version of `autoconf'. + +The simplest way to compile this package is: + + 1. `cd' to the directory containing the package's source code and type + `./configure' to configure the package for your system. If you're + using `csh' on an old version of System V, you might need to type + `sh ./configure' instead to prevent `csh' from trying to execute + `configure' itself. + + Running `configure' takes awhile. While running, it prints some + messages telling which features it is checking for. + + 2. Type `make' to compile the package. + + 3. Optionally, type `make check' to run any self-tests that come with + the package. + + 4. Type `make install' to install the programs and any data files and + documentation. + + 5. You can remove the program binaries and object files from the + source code directory by typing `make clean'. To also remove the + files that `configure' created (so you can compile the package for + a different kind of computer), type `make distclean'. There is + also a `make maintainer-clean' target, but that is intended mainly + for the package's developers. If you use it, you may have to get + all sorts of other programs in order to regenerate files that came + with the distribution. + +Compilers and Options +===================== + + Some systems require unusual options for compilation or linking that +the `configure' script does not know about. Run `./configure --help' +for details on some of the pertinent environment variables. + + You can give `configure' initial values for configuration parameters +by setting variables in the command line or in the environment. Here +is an example: + + ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix + + *Note Defining Variables::, for more details. + +Compiling For Multiple Architectures +==================================== + + You can compile the package for more than one kind of computer at the +same time, by placing the object files for each architecture in their +own directory. To do this, you must use a version of `make' that +supports the `VPATH' variable, such as GNU `make'. `cd' to the +directory where you want the object files and executables to go and run +the `configure' script. `configure' automatically checks for the +source code in the directory that `configure' is in and in `..'. + + If you have to use a `make' that does not support the `VPATH' +variable, you have to compile the package for one architecture at a +time in the source code directory. After you have installed the +package for one architecture, use `make distclean' before reconfiguring +for another architecture. + +Installation Names +================== + + By default, `make install' will install the package's files in +`/usr/local/bin', `/usr/local/man', etc. You can specify an +installation prefix other than `/usr/local' by giving `configure' the +option `--prefix=PATH'. + + You can specify separate installation prefixes for +architecture-specific files and architecture-independent files. If you +give `configure' the option `--exec-prefix=PATH', the package will use +PATH as the prefix for installing programs and libraries. +Documentation and other data files will still use the regular prefix. + + In addition, if you use an unusual directory layout you can give +options like `--bindir=PATH' to specify different values for particular +kinds of files. Run `configure --help' for a list of the directories +you can set and what kinds of files go in them. + + If the package supports it, you can cause programs to be installed +with an extra prefix or suffix on their names by giving `configure' the +option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'. + +Optional Features +================= + + Some packages pay attention to `--enable-FEATURE' options to +`configure', where FEATURE indicates an optional part of the package. +They may also pay attention to `--with-PACKAGE' options, where PACKAGE +is something like `gnu-as' or `x' (for the X Window System). The +`README' should mention any `--enable-' and `--with-' options that the +package recognizes. + + For packages that use the X Window System, `configure' can usually +find the X include and library files automatically, but if it doesn't, +you can use the `configure' options `--x-includes=DIR' and +`--x-libraries=DIR' to specify their locations. + +Specifying the System Type +========================== + + There may be some features `configure' cannot figure out +automatically, but needs to determine by the type of machine the package +will run on. Usually, assuming the package is built to be run on the +_same_ architectures, `configure' can figure that out, but if it prints +a message saying it cannot guess the machine type, give it the +`--build=TYPE' option. TYPE can either be a short name for the system +type, such as `sun4', or a canonical name which has the form: + + CPU-COMPANY-SYSTEM + +where SYSTEM can have one of these forms: + + OS KERNEL-OS + + See the file `config.sub' for the possible values of each field. If +`config.sub' isn't included in this package, then this package doesn't +need to know the machine type. + + If you are _building_ compiler tools for cross-compiling, you should +use the `--target=TYPE' option to select the type of system they will +produce code for. + + If you want to _use_ a cross compiler, that generates code for a +platform different from the build platform, you should specify the +"host" platform (i.e., that on which the generated programs will +eventually be run) with `--host=TYPE'. + +Sharing Defaults +================ + + If you want to set default values for `configure' scripts to share, +you can create a site shell script called `config.site' that gives +default values for variables like `CC', `cache_file', and `prefix'. +`configure' looks for `PREFIX/share/config.site' if it exists, then +`PREFIX/etc/config.site' if it exists. Or, you can set the +`CONFIG_SITE' environment variable to the location of the site script. +A warning: not all `configure' scripts look for a site script. + +Defining Variables +================== + + Variables not defined in a site shell script can be set in the +environment passed to `configure'. However, some packages may run +configure again during the build, and the customized values of these +variables may be lost. In order to avoid this problem, you should set +them in the `configure' command line, using `VAR=value'. For example: + + ./configure CC=/usr/local2/bin/gcc + +will cause the specified gcc to be used as the C compiler (unless it is +overridden in the site shell script). + +`configure' Invocation +====================== + + `configure' recognizes the following options to control how it +operates. + +`--help' +`-h' + Print a summary of the options to `configure', and exit. + +`--version' +`-V' + Print the version of Autoconf used to generate the `configure' + script, and exit. + +`--cache-file=FILE' + Enable the cache: use and save the results of the tests in FILE, + traditionally `config.cache'. FILE defaults to `/dev/null' to + disable caching. + +`--config-cache' +`-C' + Alias for `--cache-file=config.cache'. + +`--quiet' +`--silent' +`-q' + Do not print messages saying which checks are being made. To + suppress all normal output, redirect it to `/dev/null' (any error + messages will still be shown). + +`--srcdir=DIR' + Look for the package's source code in directory DIR. Usually + `configure' can determine that directory automatically. + +`configure' also accepts some other, not widely useful, options. Run +`configure --help' for more details. + diff --git a/Makefile.am b/Makefile.am new file mode 100644 index 0000000..63bedb7 --- /dev/null +++ b/Makefile.am @@ -0,0 +1,37 @@ +## Makefile.am -- Process this file with automake to produce Makefile.in + +SUBDIRS = \ + src \ + doc + +ACLOCAL_AMFLAGS = -I m4 + +LIBTOOL_MACROS = \ + m4/libtool.m4 \ + m4/ltoptions.m4 \ + m4/ltsugar.m4 \ + m4/ltversion.m4 \ + m4/lt~obsolete.m4 + +CLEANFILES = *~ + +DISTCLEANFILES = .deps/*.P + +MAINTAINERCLEANFILES = \ + Makefile.in \ + aclocal.m4 \ + configure \ + config-h.in \ + stamp-h.in \ + $(ac_aux_dir)/depcomp \ + $(ac_aux_dir)/install-sh \ + $(ac_aux_dir)/missing \ + $(ac_aux_dir)/mkinstalldirs \ + $(ac_aux_dir)/config.guess \ + $(ac_aux_dir)/config.sub \ + $(ac_aux_dir)/ltmain.sh \ + $(ac_aux_dir)/compile \ + $(ac_aux_dir)/test-driver \ + $(ac_aux_dir)/ar-lib \ + $(ac_aux_dir)/ylwrap \ + $(LIBTOOL_MACROS) diff --git a/NEWS b/NEWS new file mode 100644 index 0000000..89079b7 --- /dev/null +++ b/NEWS @@ -0,0 +1,2 @@ +2020-12-01: hvrtc-1.0.0 has been released. + Initial version. diff --git a/README b/README new file mode 100644 index 0000000..3ab4472 --- /dev/null +++ b/README @@ -0,0 +1,17 @@ +hvrtc + +hvrtc is a tool to configure/query RTC devices. + +For recent project news, see the NEWS file. + +Project website: + + http://www.hugovil.com/hvrtc + +Installation: + + For installation instructions, see the INSTALL file. + +Cross-compiling: + + ./configure --host=arm-linux-gnueabi diff --git a/THANKS b/THANKS new file mode 100644 index 0000000..e69de29 diff --git a/autogen.sh b/autogen.sh new file mode 100755 index 0000000..ef6884b --- /dev/null +++ b/autogen.sh @@ -0,0 +1,6 @@ +#!/bin/sh +# autogen.sh -- Use this script to create generated files from the git distribution + +set -e +autoreconf -vi +rm -rf autom4te.cache diff --git a/build-aux/.gitignore b/build-aux/.gitignore new file mode 100644 index 0000000..21a44b5 --- /dev/null +++ b/build-aux/.gitignore @@ -0,0 +1,9 @@ +compile +config.guess +config.rpath +config.sub +depcomp +install-sh +missing +test-driver +ar-lib diff --git a/configure.ac b/configure.ac new file mode 100644 index 0000000..1dbf496 --- /dev/null +++ b/configure.ac @@ -0,0 +1,41 @@ +# configure.ac -- Process this file with autoconf to produce configure + +dnl Initialization stuff. +AC_INIT([hvrtc],[1.0.0],[hugo@hugovil.com],[hvrtc],[http://www.hugovil.com/hvrtc/]) +AC_CONFIG_AUX_DIR([build-aux]) +AC_CONFIG_MACRO_DIR([m4]) +AC_CONFIG_SRCDIR(src/options.c) +AC_CONFIG_HEADERS(config.h:config-h.in) + +dnl -Wno-extra-portability: +dnl To get rid of message: +dnl linking libraries using a non-POSIX archiver requires 'AM_PROG_AR'... +dnl -Wall: +dnl Ask automake to turn on all warnings (not a gcc flag) +AM_INIT_AUTOMAKE([no-define gnits dist-bzip2 color-tests + -Wall -Wno-extra-portability]) +AM_SILENT_RULES([yes]) + +dnl Testing the C compiler. +AC_LANG([C]) + +dnl Testing for libtool support. +LT_INIT + +dnl Checking for typedefs, structures, and compiler characteristics. +AC_C_CONST +AC_TYPE_PID_T +AC_TYPE_SIZE_T + +dnl Basic warning CFLAGS values +WARNINGCFLAGS="-Wall -Wextra -Wformat -Wformat-security" + +AC_SUBST(WARNINGCFLAGS) +AC_SUBST(ac_aux_dir) + +dnl Creating output file(s) +AC_CONFIG_FILES([Makefile + src/Makefile + doc/Makefile]) + +AC_OUTPUT diff --git a/doc/Makefile.am b/doc/Makefile.am new file mode 100644 index 0000000..c02f4c2 --- /dev/null +++ b/doc/Makefile.am @@ -0,0 +1,9 @@ +## Makefile.am -- Process this file with automake to produce Makefile.in + +man1_MANS = hvrtc.man + +EXTRA_DIST = $(man1_MANS) + +CLEANFILES = *~ + +MAINTAINERCLEANFILES = Makefile.in diff --git a/doc/hvrtc.man b/doc/hvrtc.man new file mode 100644 index 0000000..bfa3e92 --- /dev/null +++ b/doc/hvrtc.man @@ -0,0 +1,30 @@ +.TH HVRTC 1 "December 2020" "hvrtc" "User's Manual" + +.SH NAME +hvrtc \- tool to configure/query RTC devices. + +.SH SYNOPSIS +.B hvrtc +[\fIOPTION\fR]... [\fIFILENAME\fR] + +.SH DESCRIPTION +\fBhvrtc\fR is a ... [TODO]. + +.SH "OPTIONS" + +.TP +\fB\-h\fR +display usage and exit +.TP +\fB\-version\fR +output version information and exit + +.SH CREDITS +\fBhvrtc\fR was originally written by Hugo Villeneuve , based on +"Real Time Clock Driver Test/Example Program" by Paul Gortmaker. + +.SH COPYRIGHT +\fBhvrtc\fR is free; anyone may redistribute it to anyone under the terms +stated in the GNU General Public License. A copy of the license is included in +the \fBhvrtc\fR distribution. You can also browse it online at +.I http://www.gnu.org/copyleft/gpl.html diff --git a/m4/.gitignore b/m4/.gitignore new file mode 100644 index 0000000..e69de29 diff --git a/src/Makefile.am b/src/Makefile.am new file mode 100644 index 0000000..eda9928 --- /dev/null +++ b/src/Makefile.am @@ -0,0 +1,15 @@ +# This file is processed by GNU automake to generate Makefile.in + +AM_CPPFLAGS = \ + $(WARNINGCFLAGS) + +bin_PROGRAMS = hvrtc + +hvrtc_SOURCES = \ + main.c \ + options.c options.h + +CLEANFILES = *~ + +MAINTAINERCLEANFILES = \ + Makefile.in diff --git a/src/main.c b/src/main.c new file mode 100644 index 0000000..e824131 --- /dev/null +++ b/src/main.c @@ -0,0 +1,308 @@ +/* + * Released under the GNU General Public License, version 2, + * + * Based on "Real Time Clock Driver Test/Example Program" + * Copyright (C) 1996, Paul Gortmaker. + * + * Copyright (C) 2020 Hugo Villeneuve + */ + +#include "config.h" + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include "options.h" + +extern struct options_t options; + +static int rtc_param_get_bsm(int fd) +{ + const char *mode; + struct rtc_param par; + int ret; + + par.param = RTC_PARAM_BACKUP_SWITCH_MODE; + ret = ioctl(fd, RTC_PARAM_GET, &par); + if (ret < 0) { + perror("get RTC_PARAM_BACKUP_SWITCH_MODE"); + return ret; + } + + switch (par.uvalue) { + case RTC_BSM_DISABLED: + mode = "disabled"; + break; + case RTC_BSM_DIRECT: + mode = "direct"; + break; + case RTC_BSM_LEVEL: + mode = "level"; + break; + case RTC_BSM_STANDBY: + mode = "standby"; + break; + default: + mode = "unknown"; + break; + }; + + printf("Backup switch mode: %s\n", mode); + + return 0; +} + +static int rtc_param_set_bsm(int fd, int value) +{ + struct rtc_param par; + int ret; + + par.param = RTC_PARAM_BACKUP_SWITCH_MODE; + par.uvalue = value; + + printf("Set backup switch mode to: $%02X\n", value); + + ret = ioctl(fd, RTC_PARAM_SET, &par); + if (ret < 0) { + perror("set RTC_PARAM_BACKUP_SWITCH_MODE"); + return ret; + } + + return 0; +} + +int +main(int argc, char **argv) +{ + int rc; + int i, fd, retval, irqcount = 0; + unsigned long tmp, data; + struct rtc_time rtc_tm; + + rc = parse_command_line_options(argc, argv); + if (rc) + exit(EXIT_FAILURE); + + fd = open(options.rtc_path, O_RDONLY); + if (fd == -1) { + perror(options.rtc_path); + exit(errno); + } + + if (options.bsm) { + if (options.bsm_arg >= 0) { + retval = rtc_param_set_bsm(fd, options.bsm_arg); + if (retval < 0) + exit(retval); + } else { + retval = rtc_param_get_bsm(fd); + if (retval < 0) + exit(retval); + } + } + + printf("RTC test\n"); + + /* Test for backup conditions */ + retval = ioctl(fd, RTC_VL_READ, &tmp); + if (retval < 0) { + fprintf(stderr, "\n...RTC_VL_READ ioctl not supported.\n"); + } else { + fprintf(stderr, "RTC_VL_READ: $%02lX\n", tmp); + + if (tmp & RTC_VL_BACKUP_LOW) + fprintf(stderr, "Backup low voltage detected, check/replace RTC battery\n"); + + if (tmp & RTC_VL_BACKUP_SWITCH) + fprintf(stderr, "Backup switchover happened\n"); + + if (tmp & RTC_VL_DATA_INVALID) + fprintf(stderr, "Voltage too low, RTC data is invalid\n"); + } + + /* Turn on update interrupts (one per second) */ + retval = ioctl(fd, RTC_UIE_ON, 0); + if (retval == -1) { + if (errno == ENOTTY) { + fprintf(stderr, + "\n...Update IRQs not supported.\n"); + goto test_READ; + } + perror("RTC_UIE_ON ioctl"); + exit(errno); + } + fprintf(stderr, "Counting 5 update (1/sec) interrupts from reading %s:", + options.rtc_path); + fflush(stderr); + for (i=1; i<6; i++) { + /* This read will block */ + retval = read(fd, &data, sizeof(unsigned long)); + if (retval == -1) { + perror("read"); + exit(errno); + } + fprintf(stderr, " %d",i); + fflush(stderr); + irqcount++; + } + fprintf(stderr, "\nAgain, from using select(2) on /dev/rtc:"); + fflush(stderr); + for (i=1; i<6; i++) { + struct timeval tv = {5, 0}; /* 5 second timeout on select */ + fd_set readfds; + FD_ZERO(&readfds); + FD_SET(fd, &readfds); + /* The select will wait until an RTC interrupt happens. */ + retval = select(fd+1, &readfds, NULL, NULL, &tv); + if (retval == -1) { + perror("select"); + exit(errno); + } + /* This read won't block unlike the select-less case above. */ + retval = read(fd, &data, sizeof(unsigned long)); + if (retval == -1) { + perror("read"); + exit(errno); + } + fprintf(stderr, " %d",i); + fflush(stderr); + irqcount++; + } + /* Turn off update interrupts */ + retval = ioctl(fd, RTC_UIE_OFF, 0); + if (retval == -1) { + perror("RTC_UIE_OFF ioctl"); + exit(errno); + } +test_READ: + /* Read the RTC time/date */ + retval = ioctl(fd, RTC_RD_TIME, &rtc_tm); + if (retval == -1) { + perror("RTC_RD_TIME ioctl"); + exit(errno); + } + fprintf(stderr, "\n\nCurrent RTC date/time is %d-%d-%d, %02d:%02d:%02d.\n", + rtc_tm.tm_mday, rtc_tm.tm_mon + 1, rtc_tm.tm_year + 1900, + rtc_tm.tm_hour, rtc_tm.tm_min, rtc_tm.tm_sec); + /* Set the alarm to 5 sec in the future, and check for rollover */ + rtc_tm.tm_sec += 5; + if (rtc_tm.tm_sec >= 60) { + rtc_tm.tm_sec %= 60; + rtc_tm.tm_min++; + } + if (rtc_tm.tm_min == 60) { + rtc_tm.tm_min = 0; + rtc_tm.tm_hour++; + } + if (rtc_tm.tm_hour == 24) + rtc_tm.tm_hour = 0; + retval = ioctl(fd, RTC_ALM_SET, &rtc_tm); + if (retval == -1) { + if (errno == ENOTTY) { + fprintf(stderr, + "\n...Alarm IRQs not supported.\n"); + goto test_PIE; + } + perror("RTC_ALM_SET ioctl"); + exit(errno); + } + /* Read the current alarm settings */ + retval = ioctl(fd, RTC_ALM_READ, &rtc_tm); + if (retval == -1) { + perror("RTC_ALM_READ ioctl"); + exit(errno); + } + fprintf(stderr, "Alarm time now set to %02d:%02d:%02d.\n", + rtc_tm.tm_hour, rtc_tm.tm_min, rtc_tm.tm_sec); + + /* Enable alarm interrupts */ + retval = ioctl(fd, RTC_AIE_ON, 0); + if (retval == -1) { + perror("RTC_AIE_ON ioctl"); + exit(errno); + } + fprintf(stderr, "Waiting 5 seconds for alarm..."); + fflush(stderr); + /* This blocks until the alarm ring causes an interrupt */ + retval = read(fd, &data, sizeof(unsigned long)); + if (retval == -1) { + perror("read"); + exit(errno); + } + irqcount++; + fprintf(stderr, " okay. Alarm rang.\n"); + /* Disable alarm interrupts */ + retval = ioctl(fd, RTC_AIE_OFF, 0); + if (retval == -1) { + perror("RTC_AIE_OFF ioctl"); + exit(errno); + } +test_PIE: + /* Read periodic IRQ rate */ + retval = ioctl(fd, RTC_IRQP_READ, &tmp); + if (retval == -1) { + /* not all RTCs support periodic IRQs */ + if (errno == ENOTTY) { + fprintf(stderr, "\nNo periodic IRQ support\n"); + goto done; + } + perror("RTC_IRQP_READ ioctl"); + exit(errno); + } + fprintf(stderr, "\nPeriodic IRQ rate is %ldHz.\n", tmp); + fprintf(stderr, "Counting 20 interrupts at:"); + fflush(stderr); + /* The frequencies 128Hz, 256Hz, ... 8192Hz are only allowed for root. */ + for (tmp=2; tmp<=64; tmp*=2) { + retval = ioctl(fd, RTC_IRQP_SET, tmp); + if (retval == -1) { + /* not all RTCs can change their periodic IRQ rate */ + if (errno == ENOTTY) { + fprintf(stderr, + "\n...Periodic IRQ rate is fixed\n"); + goto done; + } + perror("RTC_IRQP_SET ioctl"); + exit(errno); + } + fprintf(stderr, "\n%ldHz:\t", tmp); + fflush(stderr); + /* Enable periodic interrupts */ + retval = ioctl(fd, RTC_PIE_ON, 0); + if (retval == -1) { + perror("RTC_PIE_ON ioctl"); + exit(errno); + } + for (i=1; i<21; i++) { + /* This blocks */ + retval = read(fd, &data, sizeof(unsigned long)); + if (retval == -1) { + perror("read"); + exit(errno); + } + fprintf(stderr, " %d",i); + fflush(stderr); + irqcount++; + } + /* Disable periodic interrupts */ + retval = ioctl(fd, RTC_PIE_OFF, 0); + if (retval == -1) { + perror("RTC_PIE_OFF ioctl"); + exit(errno); + } + } +done: + close(fd); + + return 0; +} diff --git a/src/options.c b/src/options.c new file mode 100644 index 0000000..e92f3a1 --- /dev/null +++ b/src/options.c @@ -0,0 +1,134 @@ +/* + * options.c -- functions for processing command-line options and arguments + * + * Copyright (C) 2011 Hugo Villeneuve + * + * This file is released under the GPLv2 + */ + +#if HAVE_CONFIG_H +# include "config.h" +#endif + +#include +#include +#include +#include +#include +#include /* va_start */ + +#if STDC_HEADERS +# include +#elif HAVE_STRINGS_H +# include +#endif + +#include "options.h" + +#define STREQ(s1, s2) (strcmp ((s1), (s2)) == 0) + +const char *argp_program_version = PACKAGE_VERSION; +const char *argp_program_bug_address = PACKAGE_BUGREPORT; + +/* + * Program documentation. + * Adjacent string constants are concatenated as one string constant. + */ +static const char str_doc[] = PACKAGE_NAME " -- " PACKAGE_DESCRIPTION; + +/* How many non-option arguments we accept. */ +#define ARGS_COUNT 0 + +/* A description of the non-option arguments we accept. */ +static const char args_doc[] = ""; + +/* The options we understand. */ +static struct argp_option argp_options[] = { + {"bsm", 'b', "value", OPTION_ARG_OPTIONAL, "Get/Set Backup Switch Mode (BSM)", 0}, + {"dev", 'd', "path", 0, "RTC device path (optional)", 0}, + { 0 } +}; + +struct options_t options; + +/* Log error message. */ +void log_err(const char *format, ...) +{ + FILE *stream = stderr; + va_list ap; + + va_start(ap, format); + (void) vfprintf(stream, format, ap); + va_end(ap); +} + +/* Log error message and exits with error code. */ +void log_fail(const char *format, ...) +{ + va_list ap; + + va_start(ap, format); + log_err(format, ap); + va_end(ap); + + exit(EXIT_FAILURE); +} + +static void +decode_int(char *arg, struct argp_state *state, int *dest) +{ + char *endptr; + + *dest = strtol(arg, &endptr, 0); + + if (*endptr != '\0') { + log_err("Invalid option: %s\n", arg); + argp_usage(state); + } +} + +/* Parse a single option. */ +static error_t +parse_opt(int key, char *arg, struct argp_state *state) +{ + switch (key) { + case 'b': + options.bsm = true; + if (arg) + decode_int(arg, state, &options.bsm_arg); + break; + case 'd': + options.rtc_path = arg; + break; + case ARGP_KEY_ARG: + /* We do not support any arguments after the options. */ + argp_usage(state); + break; + default: + return ARGP_ERR_UNKNOWN; + } + + return 0; +} + +/* Our argp parser. */ +static struct argp argp = {argp_options, parse_opt, args_doc, str_doc, + NULL, NULL, NULL}; + +/* Initializes the different options passed as arguments on the command line. */ +int parse_command_line_options(int argc, char *argv[]) +{ + error_t rc; + + /* Setting default values. */ + bzero(&options, sizeof(struct options_t)); + options.rtc_path = "/dev/rtc0"; + options.bsm_arg = -1; + + /* Parse our arguments. */ + rc = argp_parse(&argp, argc, argv, 0, 0, NULL); + if (rc != 0) + log_fail("Failed to parse command line arguments\n"); + + return rc; +} diff --git a/src/options.h b/src/options.h new file mode 100644 index 0000000..a4077ff --- /dev/null +++ b/src/options.h @@ -0,0 +1,26 @@ +/* + * options.h + * + * Copyright (C) 1999 Hugo Villeneuve + * + * This file is released under the GPLv2 + */ + +#ifndef OPTIONS_H +#define OPTIONS_H 1 + +#include + +#define PACKAGE_COPYRIGHT "(c) Hugo Villeneuve" + +#define PACKAGE_DESCRIPTION "RTC configuration/query tool" + +struct options_t { + char *rtc_path; + int bsm; + int bsm_arg; +}; + +int parse_command_line_options(int argc, char *argv[]); + +#endif /* OPTIONS_H */