The purpose of this library is to help applications to transact to FireWire unit, mainly for sound devices.

This library is build with GNU Autotools. This commit add some definitions for them, therefore this library depends on: - GNU Autoconf 2.62 or later - GNU Automake 1.10.1 or later - GNU libtool 2.26 or later

This library is released under GNU Lesser General Public License Version 2.1.

Current version of this library is 0.4.0 (major.minor.micro). For libtool interface versioning, this library applies this formula: - current = minor * 10 + micro - revision = major - age = the current

Signed-off-by: Takashi Sakamoto o-takashi@sakamocchi.jp --- Makefile | 2 +- libhinawa/AUTHORS | 1 + libhinawa/COPYING | 504 +++++++++++++++++++++++++++++++++++++++++++++++++ libhinawa/ChangeLog | 5 + libhinawa/Makefile.am | 2 + libhinawa/NEWS | 0 libhinawa/README | 10 + libhinawa/autogen.sh | 10 + libhinawa/configure.ac | 48 +++++ 9 files changed, 581 insertions(+), 1 deletion(-) create mode 100644 libhinawa/AUTHORS create mode 100644 libhinawa/COPYING create mode 100644 libhinawa/ChangeLog create mode 100644 libhinawa/Makefile.am create mode 100644 libhinawa/NEWS create mode 100644 libhinawa/README create mode 100755 libhinawa/autogen.sh create mode 100644 libhinawa/configure.ac

diff --git a/Makefile b/Makefile index b2da046..39ffa2f 100644 --- a/Makefile +++ b/Makefile @@ -3,7 +3,7 @@ TOP = . SUBDIRS = as10k1 envy24control hdsploader hdspconf hdspmixer \ mixartloader pcxhrloader rmedigicontrol sb16_csp seq sscape_ctl \ us428control usx2yloader vxloader echomixer ld10k1 qlo10k1 \ - hwmixvolume hdajackretask hda-verb + hwmixvolume hdajackretask hda-verb libhinawa

all: @for i in $(SUBDIRS); do \ diff --git a/libhinawa/AUTHORS b/libhinawa/AUTHORS new file mode 100644 index 0000000..51e9e93 --- /dev/null +++ b/libhinawa/AUTHORS @@ -0,0 +1 @@ +Takashi Sakamoto o-takashi@sakamocchi.jp diff --git a/libhinawa/COPYING b/libhinawa/COPYING new file mode 100644 index 0000000..b1e3f5a --- /dev/null +++ b/libhinawa/COPYING @@ -0,0 +1,504 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 2.1, February 1999 + + Copyright (C) 1991, 1999 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. + +[This is the first released version of the Lesser GPL. It also counts + as the successor of the GNU Library Public License, version 2, hence + the version number 2.1.] + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +Licenses are intended to guarantee your freedom to share and change +free software--to make sure the software is free for all its users. + + This license, the Lesser General Public License, applies to some +specially designated software packages--typically libraries--of the +Free Software Foundation and other authors who decide to use it. You +can use it too, but we suggest you first think carefully about whether +this license or the ordinary General Public License is the better +strategy to use in any particular case, based on the explanations below. + + When we speak of free software, we are referring to freedom of use, +not price. Our General Public Licenses are designed to make sure that +you have the freedom to distribute copies of free software (and charge +for this service if you wish); that you receive source code or can get +it if you want it; that you can change the software and use pieces of +it in new free programs; and that you are informed that you can do +these things. + + To protect your rights, we need to make restrictions that forbid +distributors to deny you these rights or to ask you to surrender these +rights. These restrictions translate to certain responsibilities for +you if you distribute copies of the library or if you modify it. + + For example, if you distribute copies of the library, whether gratis +or for a fee, you must give the recipients all the rights that we gave +you. You must make sure that they, too, receive or can get the source +code. If you link other code with the library, you must provide +complete object files to the recipients, so that they can relink them +with the library after making changes to the library and recompiling +it. And you must show them these terms so they know their rights. + + We protect your rights with a two-step method: (1) we copyright the +library, and (2) we offer you this license, which gives you legal +permission to copy, distribute and/or modify the library. + + To protect each distributor, we want to make it very clear that +there is no warranty for the free library. Also, if the library is +modified by someone else and passed on, the recipients should know +that what they have is not the original version, so that the original +author's reputation will not be affected by problems that might be +introduced by others. + + Finally, software patents pose a constant threat to the existence of +any free program. We wish to make sure that a company cannot +effectively restrict the users of a free program by obtaining a +restrictive license from a patent holder. Therefore, we insist that +any patent license obtained for a version of the library must be +consistent with the full freedom of use specified in this license. + + Most GNU software, including some libraries, is covered by the +ordinary GNU General Public License. This license, the GNU Lesser +General Public License, applies to certain designated libraries, and +is quite different from the ordinary General Public License. We use +this license for certain libraries in order to permit linking those +libraries into non-free programs. + + When a program is linked with a library, whether statically or using +a shared library, the combination of the two is legally speaking a +combined work, a derivative of the original library. The ordinary +General Public License therefore permits such linking only if the +entire combination fits its criteria of freedom. The Lesser General +Public License permits more lax criteria for linking other code with +the library. + + We call this license the "Lesser" General Public License because it +does Less to protect the user's freedom than the ordinary General +Public License. It also provides other free software developers Less +of an advantage over competing non-free programs. These disadvantages +are the reason we use the ordinary General Public License for many +libraries. However, the Lesser license provides advantages in certain +special circumstances. + + For example, on rare occasions, there may be a special need to +encourage the widest possible use of a certain library, so that it becomes +a de-facto standard. To achieve this, non-free programs must be +allowed to use the library. A more frequent case is that a free +library does the same job as widely used non-free libraries. In this +case, there is little to gain by limiting the free library to free +software only, so we use the Lesser General Public License. + + In other cases, permission to use a particular library in non-free +programs enables a greater number of people to use a large body of +free software. For example, permission to use the GNU C Library in +non-free programs enables many more people to use the whole GNU +operating system, as well as its variant, the GNU/Linux operating +system. + + Although the Lesser General Public License is Less protective of the +users' freedom, it does ensure that the user of a program that is +linked with the Library has the freedom and the wherewithal to run +that program using a modified version of the Library. + + The precise terms and conditions for copying, distribution and +modification follow. Pay close attention to the difference between a +"work based on the library" and a "work that uses the library". The +former contains code derived from the library, whereas the latter must +be combined with the library in order to run. + + GNU LESSER GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any software library or other +program which contains a notice placed by the copyright holder or +other authorized party saying it may be distributed under the terms of +this Lesser General Public License (also called "this License"). +Each licensee is addressed as "you". + + A "library" means a collection of software functions and/or data +prepared so as to be conveniently linked with application programs +(which use some of those functions and data) to form executables. + + The "Library", below, refers to any such software library or work +which has been distributed under these terms. A "work based on the +Library" means either the Library or any derivative work under +copyright law: that is to say, a work containing the Library or a +portion of it, either verbatim or with modifications and/or translated +straightforwardly into another language. (Hereinafter, translation is +included without limitation in the term "modification".) + + "Source code" for a work means the preferred form of the work for +making modifications to it. For a library, complete source code means +all the source code for all modules it contains, plus any associated +interface definition files, plus the scripts used to control compilation +and installation of the library. + + Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running a program using the Library is not restricted, and output from +such a program is covered only if its contents constitute a work based +on the Library (independent of the use of the Library in a tool for +writing it). Whether that is true depends on what the Library does +and what the program that uses the Library does. + + 1. You may copy and distribute verbatim copies of the Library's +complete source code as you receive it, in any medium, provided that +you conspicuously and appropriately publish on each copy an +appropriate copyright notice and disclaimer of warranty; keep intact +all the notices that refer to this License and to the absence of any +warranty; and distribute a copy of this License along with the +Library. + + You may charge a fee for the physical act of transferring a copy, +and you may at your option offer warranty protection in exchange for a +fee. + + 2. You may modify your copy or copies of the Library or any portion +of it, thus forming a work based on the Library, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) The modified work must itself be a software library. + + b) You must cause the files modified to carry prominent notices + stating that you changed the files and the date of any change. + + c) You must cause the whole of the work to be licensed at no + charge to all third parties under the terms of this License. + + d) If a facility in the modified Library refers to a function or a + table of data to be supplied by an application program that uses + the facility, other than as an argument passed when the facility + is invoked, then you must make a good faith effort to ensure that, + in the event an application does not supply such function or + table, the facility still operates, and performs whatever part of + its purpose remains meaningful. + + (For example, a function in a library to compute square roots has + a purpose that is entirely well-defined independent of the + application. Therefore, Subsection 2d requires that any + application-supplied function or table used by this function must + be optional: if the application does not supply it, the square + root function must still compute square roots.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Library, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Library, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote +it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Library. + +In addition, mere aggregation of another work not based on the Library +with the Library (or with a work based on the Library) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may opt to apply the terms of the ordinary GNU General Public +License instead of this License to a given copy of the Library. To do +this, you must alter all the notices that refer to this License, so +that they refer to the ordinary GNU General Public License, version 2, +instead of to this License. (If a newer version than version 2 of the +ordinary GNU General Public License has appeared, then you can specify +that version instead if you wish.) Do not make any other change in +these notices. + + Once this change is made in a given copy, it is irreversible for +that copy, so the ordinary GNU General Public License applies to all +subsequent copies and derivative works made from that copy. + + This option is useful when you wish to copy part of the code of +the Library into a program that is not a library. + + 4. You may copy and distribute the Library (or a portion or +derivative of it, under Section 2) in object code or executable form +under the terms of Sections 1 and 2 above provided that you accompany +it with the complete corresponding machine-readable source code, which +must be distributed under the terms of Sections 1 and 2 above on a +medium customarily used for software interchange. + + If distribution of object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the +source code from the same place satisfies the requirement to +distribute the source code, even though third parties are not +compelled to copy the source along with the object code. + + 5. A program that contains no derivative of any portion of the +Library, but is designed to work with the Library by being compiled or +linked with it, is called a "work that uses the Library". Such a +work, in isolation, is not a derivative work of the Library, and +therefore falls outside the scope of this License. + + However, linking a "work that uses the Library" with the Library +creates an executable that is a derivative of the Library (because it +contains portions of the Library), rather than a "work that uses the +library". The executable is therefore covered by this License. +Section 6 states terms for distribution of such executables. + + When a "work that uses the Library" uses material from a header file +that is part of the Library, the object code for the work may be a +derivative work of the Library even though the source code is not. +Whether this is true is especially significant if the work can be +linked without the Library, or if the work is itself a library. The +threshold for this to be true is not precisely defined by law. + + If such an object file uses only numerical parameters, data +structure layouts and accessors, and small macros and small inline +functions (ten lines or less in length), then the use of the object +file is unrestricted, regardless of whether it is legally a derivative +work. (Executables containing this object code plus portions of the +Library will still fall under Section 6.) + + Otherwise, if the work is a derivative of the Library, you may +distribute the object code for the work under the terms of Section 6. +Any executables containing that work also fall under Section 6, +whether or not they are linked directly with the Library itself. + + 6. As an exception to the Sections above, you may also combine or +link a "work that uses the Library" with the Library to produce a +work containing portions of the Library, and distribute that work +under terms of your choice, provided that the terms permit +modification of the work for the customer's own use and reverse +engineering for debugging such modifications. + + You must give prominent notice with each copy of the work that the +Library is used in it and that the Library and its use are covered by +this License. You must supply a copy of this License. If the work +during execution displays copyright notices, you must include the +copyright notice for the Library among them, as well as a reference +directing the user to the copy of this License. Also, you must do one +of these things: + + a) Accompany the work with the complete corresponding + machine-readable source code for the Library including whatever + changes were used in the work (which must be distributed under + Sections 1 and 2 above); and, if the work is an executable linked + with the Library, with the complete machine-readable "work that + uses the Library", as object code and/or source code, so that the + user can modify the Library and then relink to produce a modified + executable containing the modified Library. (It is understood + that the user who changes the contents of definitions files in the + Library will not necessarily be able to recompile the application + to use the modified definitions.) + + b) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (1) uses at run time a + copy of the library already present on the user's computer system, + rather than copying library functions into the executable, and (2) + will operate properly with a modified version of the library, if + the user installs one, as long as the modified version is + interface-compatible with the version that the work was made with. + + c) Accompany the work with a written offer, valid for at + least three years, to give the same user the materials + specified in Subsection 6a, above, for a charge no more + than the cost of performing this distribution. + + d) If distribution of the work is made by offering access to copy + from a designated place, offer equivalent access to copy the above + specified materials from the same place. + + e) Verify that the user has already received a copy of these + materials or that you have already sent this user a copy. + + For an executable, the required form of the "work that uses the +Library" must include any data and utility programs needed for +reproducing the executable from it. However, as a special exception, +the materials to be distributed need not include anything that is +normally distributed (in either source or binary form) with the major +components (compiler, kernel, and so on) of the operating system on +which the executable runs, unless that component itself accompanies +the executable. + + It may happen that this requirement contradicts the license +restrictions of other proprietary libraries that do not normally +accompany the operating system. Such a contradiction means you cannot +use both them and the Library together in an executable that you +distribute. + + 7. You may place library facilities that are a work based on the +Library side-by-side in a single library together with other library +facilities not covered by this License, and distribute such a combined +library, provided that the separate distribution of the work based on +the Library and of the other library facilities is otherwise +permitted, and provided that you do these two things: + + a) Accompany the combined library with a copy of the same work + based on the Library, uncombined with any other library + facilities. This must be distributed under the terms of the + Sections above. + + b) Give prominent notice with the combined library of the fact + that part of it is a work based on the Library, and explaining + where to find the accompanying uncombined form of the same work. + + 8. You may not copy, modify, sublicense, link with, or distribute +the Library except as expressly provided under this License. Any +attempt otherwise to copy, modify, sublicense, link with, or +distribute the Library is void, and will automatically terminate your +rights under this License. However, parties who have received copies, +or rights, from you under this License will not have their licenses +terminated so long as such parties remain in full compliance. + + 9. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Library or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Library (or any work based on the +Library), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Library or works based on it. + + 10. Each time you redistribute the Library (or any work based on the +Library), the recipient automatically receives a license from the +original licensor to copy, distribute, link with or modify the Library +subject to these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties with +this License. + + 11. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Library at all. For example, if a patent +license would not permit royalty-free redistribution of the Library by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Library. + +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply, +and the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 12. If the distribution and/or use of the Library is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Library under this License may add +an explicit geographical distribution limitation excluding those countries, +so that distribution is permitted only in or among countries not thus +excluded. In such case, this License incorporates the limitation as if +written in the body of this License. + + 13. The Free Software Foundation may publish revised and/or new +versions of the Lesser General Public License from time to time. +Such new versions will be similar in spirit to the present version, +but may differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Library +specifies a version number of this License which applies to it and +"any later version", you have the option of following the terms and +conditions either of that version or of any later version published by +the Free Software Foundation. If the Library does not specify a +license version number, you may choose any version ever published by +the Free Software Foundation. + + 14. If you wish to incorporate parts of the Library into other free +programs whose distribution conditions are incompatible with these, +write to the author to ask for permission. For software which is +copyrighted by the Free Software Foundation, write to the Free +Software Foundation; we sometimes make exceptions for this. Our +decision will be guided by the two goals of preserving the free status +of all derivatives of our free software and of promoting the sharing +and reuse of software generally. + + NO WARRANTY + + 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO +WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY +KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE +LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN +WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY +AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU +FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR +CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE +LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING +RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A +FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF +SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH +DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Libraries + + If you develop a new library, and you want it to be of the greatest +possible use to the public, we recommend making it free software that +everyone can redistribute and change. You can do so by permitting +redistribution under these terms (or, alternatively, under the terms of the +ordinary General Public License). + + To apply these terms, attach the following notices to the library. It is +safest to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + <one line to give the library's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + +Also add information on how to contact you by electronic and paper mail. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the library, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the + library `Frob' (a library for tweaking knobs) written by James Random Hacker. + + <signature of Ty Coon>, 1 April 1990 + Ty Coon, President of Vice + +That's all there is to it! + + diff --git a/libhinawa/ChangeLog b/libhinawa/ChangeLog new file mode 100644 index 0000000..53adf2d --- /dev/null +++ b/libhinawa/ChangeLog @@ -0,0 +1,5 @@ +2015-01-24 Takashi Sakamoto o-takashi@sakamocchi.jp + version 0.4.0 release + +2015-01-18 Takashi Sakamoto o-takashi@sakamocchi.jp + version 0.3.0 release diff --git a/libhinawa/Makefile.am b/libhinawa/Makefile.am new file mode 100644 index 0000000..e39f07b --- /dev/null +++ b/libhinawa/Makefile.am @@ -0,0 +1,2 @@ +# Include m4 macros +ACLOCAL_AMFLAGS = -I m4 ${ACLOCAL_FLAGS} diff --git a/libhinawa/NEWS b/libhinawa/NEWS new file mode 100644 index 0000000..e69de29 diff --git a/libhinawa/README b/libhinawa/README new file mode 100644 index 0000000..234ed91 --- /dev/null +++ b/libhinawa/README @@ -0,0 +1,10 @@ +Requirements +- GNU Autoconf 2.62 or later +- GNU Automake 1.10.1 or later +- GNU libtool 2.2.6 or later + +How to build + $ ./autogen.sh + $ ./configure + $ make + $ make install diff --git a/libhinawa/autogen.sh b/libhinawa/autogen.sh new file mode 100755 index 0000000..54ecfa2 --- /dev/null +++ b/libhinawa/autogen.sh @@ -0,0 +1,10 @@ +#!/bin/sh + +set -u +set -e + +if [ ! -e m4 ] ; then + mkdir -p m4 +fi + +autoreconf --install diff --git a/libhinawa/configure.ac b/libhinawa/configure.ac new file mode 100644 index 0000000..2eeef0d --- /dev/null +++ b/libhinawa/configure.ac @@ -0,0 +1,48 @@ +# my versioning +m4_define([my_major], [0]) +m4_define([my_minor], [4]) +m4_define([my_micro], [0]) +m4_define([my_version], [my_major.my_minor.my_revision]) + +# Use -version option for libtool +m4_define([my_current], [m4_eval(my_minor * 10 + my_micro)]) +m4_define([my_revision],[my_major]) +m4_define([my_age], [my_current]) +m4_define([my_iface], [my_current:my_revision:my_age]) + +# Autoconf 2.62 is bootstrapped with Automake 1.10.1. +# https://lists.gnu.org/archive/html/autotools-announce/2008-04/msg00002.html +AC_PREREQ(2.62) +# Initialize Autoconf +AC_INIT([hinawa], [my_version], [o-takashi@sakamocchi.jp]) +# The directory for helper scripts +AC_CONFIG_AUX_DIR([config]) +# The directory for M4 macros +AC_CONFIG_MACRO_DIR([m4]) +# The header for variables with AC_DEFINE +AC_CONFIG_HEADERS([config.h]) + +# Automake 1.13 or later +AM_INIT_AUTOMAKE([1.10.1]) +# Don't output command lines +AM_SILENT_RULES([yes]) + +# GNU libtool 2.2.6 is bootstrapped with Automake 1.10.1 and Autoconf 2.62. +# https://lists.gnu.org/archive/html/autotools-announce/2008-09/msg00000.html +LT_PREREQ(2.2.6) +# Initialize GNU libtool +LT_INIT +# Define library version +LT_IFACE="my_iface" +AC_SUBST(LT_IFACE) + +# Detect C language compiler +AC_PROG_CC + +# The files generated from *.in +AC_CONFIG_FILES([ + Makefile +]) + +# Generate scripts and launch +AC_OUTPUT

Linux FireWire subsystem gives a way to listen to any units on IEEE 1394 bus. This subsystem adds FireWire character devices and applications can get any events by reading the devices.

This commit adds HINAWA_TYPE_FW_UNIT object to perform this. This object is written with GObject way.

When constructing this object, applications gets file descriptor by open() with a path of FireWire character devices. When calling listen(), the object starts listening. Then the 'generation' property of this object is valid and 'bus-update' signal is generated at IEEE 1394 bus-reset event. When destructing the object, the file descriptor is released.

I note that src/hinawa_sigs_marshal.* are newly generated by glib tools to detect the signature of GObject signal handler. These files should be regenerated when new signals are added or existed signals are changes, thus don't forget to 'make clean' when applying following patches.

Signed-off-by: Takashi Sakamoto o-takashi@sakamocchi.jp --- libhinawa/doc/reference/hinawa-docs.sgml | 1 + libhinawa/src/Makefile.am | 27 ++- libhinawa/src/fw_unit.c | 335 +++++++++++++++++++++++++++++++ libhinawa/src/fw_unit.h | 52 +++++ libhinawa/src/internal.h | 13 ++ 5 files changed, 425 insertions(+), 3 deletions(-) create mode 100644 libhinawa/src/fw_unit.c create mode 100644 libhinawa/src/fw_unit.h create mode 100644 libhinawa/src/internal.h

diff --git a/libhinawa/doc/reference/hinawa-docs.sgml b/libhinawa/doc/reference/hinawa-docs.sgml index 43c5c4e..662d8c5 100644 --- a/libhinawa/doc/reference/hinawa-docs.sgml +++ b/libhinawa/doc/reference/hinawa-docs.sgml @@ -30,6 +30,7 @@ functionality in ALSA firewire stack, the others are abstractions of the transaction functionality in Linux firewire stack. </para> + <xi:include href="xml/fw_unit.xml"/> </chapter> </part>

diff --git a/libhinawa/src/Makefile.am b/libhinawa/src/Makefile.am index 5673255..9eda8f4 100644 --- a/libhinawa/src/Makefile.am +++ b/libhinawa/src/Makefile.am @@ -1,5 +1,7 @@ # Remove auto-generated files when cleaning -CLEANFILES = +CLEANFILES = \ + hinawa_sigs_marshal.* +

AM_CPPFLAGS = \ -I$(top_builddir) \ @@ -19,6 +21,25 @@ libhinawa_la_LIBADD = \ $(GLIB_LIBS)

libhinawa_la_SOURCES = \ - hinawa_context.c + hinawa_context.c \ + hinawa_sigs_marshal.h \ + hinawa_sigs_marshal.c \ + fw_unit.h \ + fw_unit.c + +pkginclude_HEADERS = \ + hinawa_sigs_marshal.h \ + fw_unit.h + +hinawa_sigs_marshal.list: + $(AM_V_GEN)( find | grep .c$$ | xargs cat | \ + sed -n -e 's/.*hinawa_sigs_marshal_([A-Z]*__[A-Z_]*).*/\1/p' |\ + sed -e 's/__/:/' -e 'y/_/,/' ) | sort -u > $@ + +hinawa_sigs_marshal.h: hinawa_sigs_marshal.list + $(AM_V_GEN)( glib-genmarshal --header \ + --prefix=hinawa_sigs_marshal $< ) > $@

-pkginclude_HEADERS = +hinawa_sigs_marshal.c: hinawa_sigs_marshal.list hinawa_sigs_marshal.h + $(AM_V_GEN)(echo '#include "hinawa_sigs_marshal.h"'; \ + glib-genmarshal --body --prefix=hinawa_sigs_marshal $< ) > $@ diff --git a/libhinawa/src/fw_unit.c b/libhinawa/src/fw_unit.c new file mode 100644 index 0000000..b948ef8 --- /dev/null +++ b/libhinawa/src/fw_unit.c @@ -0,0 +1,335 @@ +#include <sys/ioctl.h> +#include <sys/types.h> +#include <sys/stat.h> +#include <fcntl.h> +#include <unistd.h> + +#include "hinawa_context.h" +#include "fw_unit.h" +#include "internal.h" + +#ifdef HAVE_CONFIG_H +# include <config.h> +#endif + +/** + * SECTION:fw_unit + * @Title: HinawaFwUnit + * @Short_description: An event listener for FireWire unit + * + * A #HinawaFwUnit is an event listener for a certain FireWire unit. + * This class is an application of Linux FireWire subsystem. + * All of operations utilize ioctl(2) with subsystem specific request commands. + */ +typedef struct { + GSource src; + HinawaFwUnit *unit; + gpointer tag; +} FwUnitSource; + +struct _HinawaFwUnitPrivate { + int fd; + guint64 generation; + + unsigned int len; + void *buf; + FwUnitSource *src; +}; +G_DEFINE_TYPE_WITH_PRIVATE(HinawaFwUnit, hinawa_fw_unit, G_TYPE_OBJECT) +#define FW_UNIT_GET_PRIVATE(obj) \ + (G_TYPE_INSTANCE_GET_PRIVATE((obj), \ + HINAWA_TYPE_FW_UNIT, HinawaFwUnitPrivate)) + +/* This object has properties. */ +enum fw_unit_prop_type { + FW_UNIT_PROP_TYPE_GENERATION = 1, + FW_UNIT_PROP_TYPE_COUNT, +}; +static GParamSpec *fw_unit_props[FW_UNIT_PROP_TYPE_COUNT] = { NULL, }; + +/* This object has one signal. */ +enum fw_unit_sig_type { + FW_UNIT_SIG_TYPE_BUS_UPDATE = 0, + FW_UNIT_SIG_TYPE_COUNT, +}; +static guint fw_unit_sigs[FW_UNIT_SIG_TYPE_COUNT] = { 0 }; + +static void fw_unit_get_property(GObject *obj, guint id, + GValue *val, GParamSpec *spec) +{ + HinawaFwUnit *self = HINAWA_FW_UNIT(obj); + HinawaFwUnitPrivate *priv = FW_UNIT_GET_PRIVATE(self); + + switch (id) { + case FW_UNIT_PROP_TYPE_GENERATION: + g_value_set_uint64(val, priv->generation); + break; + default: + G_OBJECT_WARN_INVALID_PROPERTY_ID(obj, id, spec); + break; + } +} + +static void fw_unit_set_property(GObject *obj, guint id, + const GValue *val, GParamSpec *spec) +{ + G_OBJECT_WARN_INVALID_PROPERTY_ID(obj, id, spec); +} + +static void fw_unit_dispose(GObject *obj) +{ + HinawaFwUnit *self = HINAWA_FW_UNIT(obj); + HinawaFwUnitPrivate *priv = FW_UNIT_GET_PRIVATE(self); + + hinawa_fw_unit_unlisten(self); + + close(priv->fd); + + G_OBJECT_CLASS(hinawa_fw_unit_parent_class)->dispose(obj); +} + +static void fw_unit_finalize(GObject *gobject) +{ + G_OBJECT_CLASS(hinawa_fw_unit_parent_class)->finalize(gobject); +} + +static void hinawa_fw_unit_class_init(HinawaFwUnitClass *klass) +{ + GObjectClass *gobject_class = G_OBJECT_CLASS(klass); + + gobject_class->get_property = fw_unit_get_property; + gobject_class->set_property = fw_unit_set_property; + gobject_class->dispose = fw_unit_dispose; + gobject_class->finalize = fw_unit_finalize; + + fw_unit_props[FW_UNIT_PROP_TYPE_GENERATION] = + g_param_spec_uint64("generation", "generation", + "current level of generation on this bus.", + 0, ULONG_MAX, 0, + G_PARAM_READABLE); + + g_object_class_install_properties(gobject_class, + FW_UNIT_PROP_TYPE_COUNT, + fw_unit_props); + + /** + * HinawaFwUnit::bus-update: + * @self: A #HinawaFwUnit + * + * When IEEE 1394 bus is updated, the ::bus-update signal is generated. + * Handlers can read current generation in the bus via 'generation' + * property. + */ + fw_unit_sigs[FW_UNIT_SIG_TYPE_BUS_UPDATE] = + g_signal_new("bus-update", + G_OBJECT_CLASS_TYPE(klass), + G_SIGNAL_RUN_LAST, + 0, + NULL, NULL, + g_cclosure_marshal_VOID__VOID, + G_TYPE_NONE, 0, G_TYPE_NONE); +} + +static void hinawa_fw_unit_init(HinawaFwUnit *self) +{ + self->priv = hinawa_fw_unit_get_instance_private(self); +} + +/** + * hinawa_fw_unit_open: + * @self: A #HinawaFwUnit + * @path: A path to Linux FireWire character device + * @exception: A #GError + */ +void hinawa_fw_unit_open(HinawaFwUnit *self, gchar *path, GError **exception) +{ + HinawaFwUnitPrivate *priv; + int fd; + struct fw_cdev_get_info info = {0}; + struct fw_cdev_event_bus_reset br = {0}; + + g_return_if_fail(HINAWA_IS_FW_UNIT(self)); + priv = FW_UNIT_GET_PRIVATE(self); + + fd = open(path, O_RDONLY); + if (fd < 0) { + g_set_error(exception, g_quark_from_static_string(__func__), + errno, "%s", strerror(errno)); + return; + } + + info.version = 4; + info.bus_reset = (guint64)&br; + info.bus_reset_closure = (guint64)self; + if (ioctl(fd, FW_CDEV_IOC_GET_INFO, &info) < 0) { + g_set_error(exception, g_quark_from_static_string(__func__), + errno, "%s", strerror(errno)); + close(fd); + return; + } + + priv->fd = fd; + priv->generation = br.generation; +} + +/* Internal use only. */ +void hinawa_fw_unit_ioctl(HinawaFwUnit *self, int req, void *args, int *err) +{ + HinawaFwUnitPrivate *priv; + + g_return_if_fail(HINAWA_IS_FW_UNIT(self)); + priv = FW_UNIT_GET_PRIVATE(self); + + *err = 0; + if (ioctl(priv->fd, req, args) < 0) + *err = errno; +} + +static void handle_update(HinawaFwUnit *self, + struct fw_cdev_event_bus_reset *event) +{ + HinawaFwUnitPrivate *priv; + + g_return_if_fail(HINAWA_IS_FW_UNIT(self)); + priv = FW_UNIT_GET_PRIVATE(self); + + priv->generation = event->generation; + + g_signal_emit(self, fw_unit_sigs[FW_UNIT_SIG_TYPE_BUS_UPDATE], 0, + NULL); +} + +static gboolean prepare_src(GSource *src, gint *timeout) +{ + /* Set 2msec for poll(2) timeout. */ + *timeout = 2; + + /* This source is not ready, let's poll(2) */ + return FALSE; +} + +static gboolean check_src(GSource *gsrc) +{ + FwUnitSource *src = (FwUnitSource *)gsrc; + HinawaFwUnit *unit = src->unit; + HinawaFwUnitPrivate *priv = FW_UNIT_GET_PRIVATE(unit); + struct fw_cdev_event_common *common; + int len; + GIOCondition condition; + + if (unit == NULL) + goto end; + + /* Let's process this source if any inputs are available. */ + condition = g_source_query_unix_fd((GSource *)src, src->tag); + if (!(condition & G_IO_IN)) + goto end; + + len = read(priv->fd, priv->buf, priv->len); + if (len <= 0) + goto end; + + common = (struct fw_cdev_event_common *)priv->buf; + + if (HINAWA_IS_FW_UNIT(common->closure) && + common->type == FW_CDEV_EVENT_BUS_RESET) + handle_update(HINAWA_FW_UNIT(common->closure), + (struct fw_cdev_event_bus_reset *)common); +end: + /* Don't go to dispatch, then continue to process this source. */ + return FALSE; +} + +static gboolean dispatch_src(GSource *src, GSourceFunc callback, + gpointer user_data) +{ + /* Just be sure to continue to process this source. */ + return TRUE; +} + +/** + * hinawa_fw_unit_listen: + * @self: A #HinawaFwUnit + * @exception: A #GError + * + * Start to listen to any events from the unit. + */ +void hinawa_fw_unit_listen(HinawaFwUnit *self, GError **exception) +{ + static GSourceFuncs funcs = { + .prepare = prepare_src, + .check = check_src, + .dispatch = dispatch_src, + .finalize = NULL, + }; + HinawaFwUnitPrivate *priv; + void *buf; + GSource *src; + + g_return_if_fail(HINAWA_IS_FW_UNIT(self)); + priv = FW_UNIT_GET_PRIVATE(self); + + /* + * MEMO: allocate one page because we cannot assume the size of + * transaction frame. + */ + buf = g_malloc0(getpagesize()); + if (buf == NULL) { + g_set_error(exception, g_quark_from_static_string(__func__), + ENOMEM, "%s", strerror(ENOMEM)); + return; + } + + src = g_source_new(&funcs, sizeof(FwUnitSource)); + if (src == NULL) { + g_set_error(exception, g_quark_from_static_string(__func__), + ENOMEM, "%s", strerror(ENOMEM)); + g_free(buf); + return; + } + + g_source_set_name(src, "HinawaFwUnit"); + g_source_set_priority(src, G_PRIORITY_HIGH_IDLE); + g_source_set_can_recurse(src, TRUE); + + ((FwUnitSource *)src)->unit = self; + priv->src = (FwUnitSource *)src; + priv->buf = buf; + priv->len = getpagesize(); + + ((FwUnitSource *)src)->tag = + hinawa_context_add_src(src, priv->fd, G_IO_IN, exception); + if (*exception != NULL) { + g_free(buf); + g_source_destroy(src); + priv->buf = NULL; + priv->len = 0; + priv->src = NULL; + return; + } +} + +/** + * hinawa_fw_unit_unlisten: + * @self: A #HinawaFwUnit + * + * Stop to listen to any events from the unit. + */ +void hinawa_fw_unit_unlisten(HinawaFwUnit *self) +{ + HinawaFwUnitPrivate *priv; + + g_return_if_fail(HINAWA_IS_FW_UNIT(self)); + priv = FW_UNIT_GET_PRIVATE(self); + + if (priv->src == NULL) + return; + + g_source_destroy((GSource *)priv->src); + g_free(priv->src); + priv->src = NULL; + + g_free(priv->buf); + priv->buf = NULL; + priv->len = 0; +} diff --git a/libhinawa/src/fw_unit.h b/libhinawa/src/fw_unit.h new file mode 100644 index 0000000..f8f38a4 --- /dev/null +++ b/libhinawa/src/fw_unit.h @@ -0,0 +1,52 @@ +#ifndef __ALSA_TOOLS_HINAWA_FW_UNIT_H__ +#define __ALSA_TOOLS_HINAWA_FW_UNIT_H__ + +#include <glib.h> +#include <glib-object.h> + +G_BEGIN_DECLS + +#define HINAWA_TYPE_FW_UNIT (hinawa_fw_unit_get_type()) + +#define HINAWA_FW_UNIT(obj) \ + (G_TYPE_CHECK_INSTANCE_CAST((obj), \ + HINAWA_TYPE_FW_UNIT, \ + HinawaFwUnit)) +#define HINAWA_IS_FW_UNIT(obj) \ + (G_TYPE_CHECK_INSTANCE_TYPE((obj), \ + HINAWA_TYPE_FW_UNIT)) + +#define HINAWA_FW_UNIT_CLASS(klass) \ + (G_TYPE_CHECK_CLASS_CAST((klass), \ + HINAWA_TYPE_FW_UNIT, \ + HinawaFwUnitClass)) +#define HINAWA_IS_FW_UNIT_CLASS(klass) \ + (G_TYPE_CHECK_CLASS_TYPE((klass), \ + HINAWA_TYPE_FW_UNIT)) +#define HINAWA_FW_UNIT_GET_CLASS(obj) \ + (G_TYPE_INSTANCE_GET_CLASS((obj), \ + HINAWA_TYPE_FW_UNIT, \ + HinawaFwUnitClass)) + +typedef struct _HinawaFwUnit HinawaFwUnit; +typedef struct _HinawaFwUnitClass HinawaFwUnitClass; +typedef struct _HinawaFwUnitPrivate HinawaFwUnitPrivate; + +struct _HinawaFwUnit { + GObject parent_instance; + + HinawaFwUnitPrivate *priv; +}; + +struct _HinawaFwUnitClass { + GObjectClass parent_class; +}; + +GType hinawa_fw_unit_get_type(void) G_GNUC_CONST; + +void hinawa_fw_unit_open(HinawaFwUnit *self, gchar *path, GError **exception); + +void hinawa_fw_unit_listen(HinawaFwUnit *self, GError **exception); +void hinawa_fw_unit_unlisten(HinawaFwUnit *self); + +#endif diff --git a/libhinawa/src/internal.h b/libhinawa/src/internal.h new file mode 100644 index 0000000..83f920b --- /dev/null +++ b/libhinawa/src/internal.h @@ -0,0 +1,13 @@ +#ifndef __ALSA_TOOLS_HINAWA_INTERNAL_H__ +#define __ALSA_TOOLS_HINAWA_INTERNAL_H__ + +#include <errno.h> +#include <string.h> + +#include <linux/firewire-cdev.h> +#include <linux/firewire-constants.h> + +#include "fw_unit.h" + +void hinawa_fw_unit_ioctl(HinawaFwUnit *self, int req, void *args, int *err); +#endif

The units on IEEE 1394 bus transfers any requests to a certain address on receiver. To receive the request, the receiver should listen to the address and respond it.

Linux FireWire subsystem gives a way to perform this. Applications reserve a range of address on IEEE 1394 host controller by ioctl(2). When the host controller receives any requests, the subsystem generates readable events for applications. When reading the events, the application should transfer a response by ioctl(2). The range of address is an exclusive resource on the host controller, thus the other applications cannot reserve it.

This commit adds HINAWA_TYPE_FW_RESP object to perform this. When constructing the instance, applications can reserve the range of address by register() method. When the host controller receives a request inner the range, the instance generates 'requested' signal. If the application want to transfer some data in the response frame, the handler should return 32bit array. Else return NULL.

Signed-off-by: Takashi Sakamoto o-takashi@sakamocchi.jp --- libhinawa/doc/reference/hinawa-docs.sgml | 1 + libhinawa/src/Makefile.am | 7 +- libhinawa/src/fw_resp.c | 232 +++++++++++++++++++++++++++++++ libhinawa/src/fw_resp.h | 51 +++++++ libhinawa/src/fw_unit.c | 4 + libhinawa/src/internal.h | 3 + 6 files changed, 296 insertions(+), 2 deletions(-) create mode 100644 libhinawa/src/fw_resp.c create mode 100644 libhinawa/src/fw_resp.h

diff --git a/libhinawa/doc/reference/hinawa-docs.sgml b/libhinawa/doc/reference/hinawa-docs.sgml index 662d8c5..419e431 100644 --- a/libhinawa/doc/reference/hinawa-docs.sgml +++ b/libhinawa/doc/reference/hinawa-docs.sgml @@ -31,6 +31,7 @@ of the transaction functionality in Linux firewire stack. </para> <xi:include href="xml/fw_unit.xml"/> + <xi:include href="xml/fw_resp.xml"/> </chapter> </part>

diff --git a/libhinawa/src/Makefile.am b/libhinawa/src/Makefile.am index d9519ab..7c09088 100644 --- a/libhinawa/src/Makefile.am +++ b/libhinawa/src/Makefile.am @@ -25,11 +25,14 @@ libhinawa_la_SOURCES = \ hinawa_sigs_marshal.h \ hinawa_sigs_marshal.c \ fw_unit.h \ - fw_unit.c + fw_unit.c \ + fw_resp.h \ + fw_resp.c

pkginclude_HEADERS = \ hinawa_sigs_marshal.h \ - fw_unit.h + fw_unit.h \ + fw_resp.h

hinawa_sigs_marshal.list: $(AM_V_GEN)( find | grep .c$$ | xargs cat | \ diff --git a/libhinawa/src/fw_resp.c b/libhinawa/src/fw_resp.c new file mode 100644 index 0000000..2ee559b --- /dev/null +++ b/libhinawa/src/fw_resp.c @@ -0,0 +1,232 @@ +#include <sys/ioctl.h> +#include "fw_resp.h" +#include "internal.h" +#include "hinawa_sigs_marshal.h" + +#ifdef HAVE_CONFIG_H +# include <config.h> +#endif + +/** + * SECTION:fw_resp + * @Title: HinawaFwResp + * @Short_description: A transaction responder for a FireWire unit + * + * A HinawaFwResp responds requests from any units. + * + * Any of transaction frames should be aligned to 32bit (quadlet). + * This class is an application of Linux FireWire subsystem. All of operations + * utilize ioctl(2) with subsystem specific request commands. + */ +struct _HinawaFwRespPrivate { + HinawaFwUnit *unit; + + guchar *buf; + guint width; + guint64 addr_handle; + + GArray *req_frame; +}; +G_DEFINE_TYPE_WITH_PRIVATE(HinawaFwResp, hinawa_fw_resp, G_TYPE_OBJECT) +#define FW_RESP_GET_PRIVATE(obj) \ + (G_TYPE_INSTANCE_GET_PRIVATE((obj), \ + HINAWA_TYPE_FW_RESP, HinawaFwRespPrivate)) + +/* This object has one signal. */ +enum fw_resp_sig_type { + FW_RESP_SIG_TYPE_REQ = 0, + FW_RESP_SIG_TYPE_COUNT, +}; +static guint fw_resp_sigs[FW_RESP_SIG_TYPE_COUNT] = { 0 }; + +static void fw_resp_dispose(GObject *gobject) +{ + HinawaFwResp *self = HINAWA_FW_RESP(gobject); + + hinawa_fw_resp_unregister(self); + + G_OBJECT_CLASS(hinawa_fw_resp_parent_class)->dispose(gobject); +} + +static void fw_resp_finalize(GObject *gobject) +{ + G_OBJECT_CLASS(hinawa_fw_resp_parent_class)->finalize(gobject); +} + +static void hinawa_fw_resp_class_init(HinawaFwRespClass *klass) +{ + GObjectClass *gobject_class = G_OBJECT_CLASS(klass); + + gobject_class->get_property = NULL; + gobject_class->set_property = NULL; + gobject_class->dispose = fw_resp_dispose; + gobject_class->finalize = fw_resp_finalize; + + /** + * HinawaFwResp::requested: + * @self: A #HinawaFwResp + * @tcode: Transaction code + * @req_frame: (element-type guint32) (array) (transfer none): + * The frame in request + * + * When any units transfer requests to the range of address to which + * this object listening. The ::requested signal handler can set + * data frame to 'resp_frame' if needed. + * + * Returns: (element-type guint32) (array) (nullable) (transfer full): + * A data frame for response. + */ + fw_resp_sigs[FW_RESP_SIG_TYPE_REQ] = + g_signal_new("requested", + G_OBJECT_CLASS_TYPE(klass), + G_SIGNAL_RUN_LAST, + 0, + NULL, NULL, + hinawa_sigs_marshal_BOXED__INT_BOXED, + G_TYPE_ARRAY, 2, G_TYPE_INT, G_TYPE_ARRAY); +} + +static void hinawa_fw_resp_init(HinawaFwResp *self) +{ + self->priv = hinawa_fw_resp_get_instance_private(self); +} + +/** + * hinawa_fw_resp_register: + * @self: A #HinawaFwResp + * @unit: A #HinawaFwUnit + * @addr: A start address to listen to in host controller + * @width: The byte width of address to listen to host controller + * @exception: A #GError + * + * Start to listen to a range of address in host controller + */ +void hinawa_fw_resp_register(HinawaFwResp *self, HinawaFwUnit *unit, + guint64 addr, guint width, GError **exception) +{ + HinawaFwRespPrivate *priv; + struct fw_cdev_allocate allocate = {0}; + int err; + + g_return_if_fail(HINAWA_IS_FW_RESP(self)); + priv = FW_RESP_GET_PRIVATE(self); + + if (priv->unit != NULL) { + g_set_error(exception, g_quark_from_static_string(__func__), + EINVAL, "%s", strerror(EINVAL)); + return; + } + priv->unit = g_object_ref(unit); + + allocate.offset = addr; + allocate.closure = (guint64)self; + allocate.length = width; + allocate.region_end = addr + width; + + hinawa_fw_unit_ioctl(priv->unit, FW_CDEV_IOC_ALLOCATE, &allocate, &err); + if (err != 0) { + g_set_error(exception, g_quark_from_static_string(__func__), + err, "%s", strerror(err)); + g_object_unref(priv->unit); + priv->unit = NULL; + return; + } + + priv->buf = g_malloc0(allocate.length); + if (priv->buf == NULL) { + g_set_error(exception, g_quark_from_static_string(__func__), + ENOMEM, "%s", strerror(ENOMEM)); + hinawa_fw_resp_unregister(self); + return; + } + + priv->req_frame = g_array_new(FALSE, TRUE, sizeof(guint32)); + if (priv->req_frame == NULL) { + g_set_error(exception, g_quark_from_static_string(__func__), + ENOMEM, "%s", strerror(ENOMEM)); + hinawa_fw_resp_unregister(self); + return; + } + + priv->width = allocate.length; +} + +/** + * hinawa_fw_resp_unregister: + * @self: A HinawaFwResp + * + * stop to listen to a range of address in host controller + */ +void hinawa_fw_resp_unregister(HinawaFwResp *self) +{ + HinawaFwRespPrivate *priv; + struct fw_cdev_deallocate deallocate = {0}; + int err; + + g_return_if_fail(HINAWA_IS_FW_RESP(self)); + priv = FW_RESP_GET_PRIVATE(self); + + if (priv->unit == NULL) + return; + + deallocate.handle = priv->addr_handle; + hinawa_fw_unit_ioctl(priv->unit, FW_CDEV_IOC_DEALLOCATE, &deallocate, + &err); + g_object_unref(priv->unit); + priv->unit = NULL; + + if (priv->req_frame != NULL) + g_array_free(priv->req_frame, TRUE); + priv->req_frame = NULL; +} + +/* NOTE: For HinawaFwUnit, internal. */ +void hinawa_fw_resp_handle_request(HinawaFwResp *self, + struct fw_cdev_event_request2 *event) +{ + HinawaFwRespPrivate *priv; + struct fw_cdev_send_response resp = {0}; + guint i, quads; + guint32 *buf; + GArray *resp_frame; + int err; + + g_return_if_fail(HINAWA_IS_FW_RESP(self)); + priv = FW_RESP_GET_PRIVATE(self); + + if (event->length > priv->width) { + resp.rcode = RCODE_CONFLICT_ERROR; + goto respond; + } + + /* Store requested frame. */ + quads = event->length / 4; + g_array_set_size(priv->req_frame, quads); + memcpy(priv->req_frame->data, event->data, event->length); + + /* For endiannness. */ + buf = (guint32 *)priv->req_frame->data; + for (i = 0; i < quads; i++) + buf[i] = be32toh(buf[i]); + + /* Emit signal to handlers. */ + g_signal_emit(self, fw_resp_sigs[FW_RESP_SIG_TYPE_REQ], 0, + event->tcode, priv->req_frame, &resp_frame); + + resp.rcode = RCODE_COMPLETE; + if (resp_frame == NULL || resp_frame->len == 0) + goto respond; + + /* For endianness. */ + buf = (guint32 *)resp_frame->data; + for (i = 0; i < resp_frame->len; i++) + buf[i] = htobe32(buf[i]); + + resp.length = resp_frame->len; + resp.data = (guint64)resp_frame->data; +respond: + resp.handle = event->handle; + + hinawa_fw_unit_ioctl(priv->unit, FW_CDEV_IOC_SEND_RESPONSE, &resp, + &err); +} diff --git a/libhinawa/src/fw_resp.h b/libhinawa/src/fw_resp.h new file mode 100644 index 0000000..0e3bb52 --- /dev/null +++ b/libhinawa/src/fw_resp.h @@ -0,0 +1,51 @@ +#ifndef __ALSA_TOOLS_HINAWA_FW_RESP_H__ +#define __ALSA_TOOLS_HINAWA_FW_RESP_H__ + +#include <glib.h> +#include <glib-object.h> +#include "fw_unit.h" + +G_BEGIN_DECLS + +#define HINAWA_TYPE_FW_RESP (hinawa_fw_resp_get_type()) + +#define HINAWA_FW_RESP(obj) \ + (G_TYPE_CHECK_INSTANCE_CAST((obj), \ + HINAWA_TYPE_FW_RESP, \ + HinawaFwResp)) +#define HINAWA_IS_FW_RESP(obj) \ + (G_TYPE_CHECK_INSTANCE_TYPE((obj), \ + HINAWA_TYPE_FW_RESP)) + +#define HINAWA_FW_RESP_CLASS(klass) \ + (G_TYPE_CHECK_CLASS_CAST((klass), \ + HINAWA_TYPE_FW_RESP, \ + HinawaFwResp)) +#define HINAWA_IS_FW_RESP_CLASS(klass) \ + (G_TYPE_CHECK_CLASS_TYPE((klass), \ + HINAWA_TYPE_Seq)) +#define HINAWA_FW_RESP_GET_CLASS(obj) \ + (G_TYPE_INSTANCE_GET_CLASS((obj), \ + HINAWA_TYPE_FW_RESP, \ + HinawaFwResp)) + +typedef struct _HinawaFwResp HinawaFwResp; +typedef struct _HinawaFwRespClass HinawaFwRespClass; +typedef struct _HinawaFwRespPrivate HinawaFwRespPrivate; + +struct _HinawaFwResp { + GObject parent_instance; + + HinawaFwRespPrivate *priv; +}; + +struct _HinawaFwRespClass { + GObjectClass parent_class; +}; + +GType hinawa_fw_resp_get_type(void) G_GNUC_CONST; + +void hinawa_fw_resp_register(HinawaFwResp *self, HinawaFwUnit *unit, + guint64 addr, guint width, GError **exception); +void hinawa_fw_resp_unregister(HinawaFwResp *self); +#endif diff --git a/libhinawa/src/fw_unit.c b/libhinawa/src/fw_unit.c index b948ef8..019105d 100644 --- a/libhinawa/src/fw_unit.c +++ b/libhinawa/src/fw_unit.c @@ -235,6 +235,10 @@ static gboolean check_src(GSource *gsrc) common->type == FW_CDEV_EVENT_BUS_RESET) handle_update(HINAWA_FW_UNIT(common->closure), (struct fw_cdev_event_bus_reset *)common); + else if (HINAWA_IS_FW_RESP(common->closure) && + common->type == FW_CDEV_EVENT_REQUEST2) + hinawa_fw_resp_handle_request(HINAWA_FW_RESP(common->closure), + (struct fw_cdev_event_request2 *)common); end: /* Don't go to dispatch, then continue to process this source. */ return FALSE; diff --git a/libhinawa/src/internal.h b/libhinawa/src/internal.h index 83f920b..1ee88ec 100644 --- a/libhinawa/src/internal.h +++ b/libhinawa/src/internal.h @@ -8,6 +8,9 @@ #include <linux/firewire-constants.h>

#include "fw_unit.h" +#include "fw_resp.h"

void hinawa_fw_unit_ioctl(HinawaFwUnit *self, int req, void *args, int *err); +void hinawa_fw_resp_handle_request(HinawaFwResp *self, + struct fw_cdev_event_request2 *event); #endif

There are a standard way to transport function control data to units; Function Control Protocol (FCP) in IEC 61883-1. This way uses a pair of request transaction and response transaction. All of AV/C commands which 1394TA defines is an application of FCP.

This commit adds HINAWA_TYPE_FW_FCP object for this purpose. This object uses 'fw_resp' object and 'fw_req' object to support FCP.

I note that 'AV/C Digital Interface Command Set General Specification Version 4.2' (September 1, 2004 1394TA) defines 'deferred transactions' in its clause 6.1.2. This type of AV/C command requres FCP backend to wait 'unspecified interval' for next response when receiving INTERIM type of response. To perform it, this object uses 200 mili-seconds to wait again.

Signed-off-by: Takashi Sakamoto o-takashi@sakamocchi.jp --- libhinawa/doc/reference/hinawa-docs.sgml | 1 + libhinawa/src/Makefile.am | 7 +- libhinawa/src/fw_fcp.c | 282 +++++++++++++++++++++++++++++++ libhinawa/src/fw_fcp.h | 58 +++++++ 4 files changed, 346 insertions(+), 2 deletions(-) create mode 100644 libhinawa/src/fw_fcp.c create mode 100644 libhinawa/src/fw_fcp.h

diff --git a/libhinawa/doc/reference/hinawa-docs.sgml b/libhinawa/doc/reference/hinawa-docs.sgml index ff00ecc..d5773a5 100644 --- a/libhinawa/doc/reference/hinawa-docs.sgml +++ b/libhinawa/doc/reference/hinawa-docs.sgml @@ -33,6 +33,7 @@ <xi:include href="xml/fw_unit.xml"/> <xi:include href="xml/fw_resp.xml"/> <xi:include href="xml/fw_req.xml"/> + <xi:include href="xml/fw_fcp.xml"/> </chapter> </part>

diff --git a/libhinawa/src/Makefile.am b/libhinawa/src/Makefile.am index 91726b8..0a64658 100644 --- a/libhinawa/src/Makefile.am +++ b/libhinawa/src/Makefile.am @@ -29,13 +29,16 @@ libhinawa_la_SOURCES = \ fw_resp.h \ fw_resp.c \ fw_req.h \ - fw_req.c + fw_req.c \ + fw_fcp.h \ + fw_fcp.c

pkginclude_HEADERS = \ hinawa_sigs_marshal.h \ fw_unit.h \ fw_resp.h \ - fw_req.h + fw_req.h \ + fw_fcp.h

hinawa_sigs_marshal.list: $(AM_V_GEN)( find | grep .c$$ | xargs cat | \ diff --git a/libhinawa/src/fw_fcp.c b/libhinawa/src/fw_fcp.c new file mode 100644 index 0000000..44c6d3b --- /dev/null +++ b/libhinawa/src/fw_fcp.c @@ -0,0 +1,282 @@ +#include "fw_fcp.h" +#include "fw_resp.h" +#include "fw_req.h" + +/** + * SECTION:fw_fcp + * @Title: HinawaFwFcp + * @Short_description: A FCP transaction executor to a FireWire unit + * + * A HinawaFwFcp supports Function Control Protocol (FCP) in IEC 61883-1. + * Some types of transaction in 'AV/C Digital Interface Command Set General + * Specification Version 4.2' (Sep 1 2004, 1394TA) requires low layer support, + * thus this class has a code for them. + * + * Any of transaction frames should be aligned to 8bit (byte). + * This class is an application of #HinawaFwReq / #HinawaFwResp. + */ + +#define FCP_MAXIMUM_FRAME_BYTES 0x200U +#define FCP_REQUEST_ADDR 0xfffff0000b00 +#define FCP_RESPOND_ADDR 0xfffff0000d00 + +/* For your information. */ +enum avc_type { + AVC_TYPE_CONTROL = 0x00, + AVC_TYPE_STATUS = 0x01, + AVC_TYPE_SPECIFIC_INQUIRY = 0x02, + AVC_TYPE_NOTIFY = 0x03, + AVC_TYPE_GENERAL_INQUIRY = 0x04, + /* 0x05-0x07 are reserved. */ +}; +/* continue */ +enum avc_status { + AVC_STATUS_NOT_IMPLEMENTED = 0x08, + AVC_STATUS_ACCEPTED = 0x09, + AVC_STATUS_REJECTED = 0x0a, + AVC_STATUS_IN_TRANSITION = 0x0b, + AVC_STATUS_IMPLEMENTED_STABLE = 0x0c, + AVC_STATUS_CHANGED = 0x0d, + /* reserved */ + AVC_STATUS_INTERIM = 0x0f, +}; + +struct fcp_transaction { + GArray *req_frame; /* Request frame */ + GArray *resp_frame; /* Response frame */ + GCond cond; +}; + +struct _HinawaFwFcpPrivate { + HinawaFwUnit *unit; + HinawaFwResp *resp; + + GList *transactions; + GMutex lock; +}; +G_DEFINE_TYPE_WITH_PRIVATE(HinawaFwFcp, hinawa_fw_fcp, G_TYPE_OBJECT) +#define FW_FCP_GET_PRIVATE(obj) \ + (G_TYPE_INSTANCE_GET_PRIVATE((obj), \ + HINAWA_TYPE_FW_FCP, HinawaFwFcpPrivate)) + +static void hinawa_fw_fcp_dispose(GObject *obj) +{ + HinawaFwFcp *self = HINAWA_FW_FCP(obj); + + hinawa_fw_fcp_unlisten(self); + + G_OBJECT_CLASS(hinawa_fw_fcp_parent_class)->dispose(obj); +} + +static void hinawa_fw_fcp_finalize(GObject *gobject) +{ + G_OBJECT_CLASS(hinawa_fw_fcp_parent_class)->finalize(gobject); +} + +static void hinawa_fw_fcp_class_init(HinawaFwFcpClass *klass) +{ + GObjectClass *gobject_class = G_OBJECT_CLASS(klass); + + gobject_class->dispose = hinawa_fw_fcp_dispose; + gobject_class->finalize = hinawa_fw_fcp_finalize; +} + +static void hinawa_fw_fcp_init(HinawaFwFcp *self) +{ + self->priv = hinawa_fw_fcp_get_instance_private(self); +} + +/** + * hinawa_fw_fcp_transact: + * @self: A #HinawaFwFcp + * @req_frame: (element-type guint8) (array) (in): a byte frame for request + * @resp_frame: (element-type guint8) (array) (out caller-allocates): a byte + * frame for response + * @exception: A #GError + */ +void hinawa_fw_fcp_transact(HinawaFwFcp *self, + GArray *req_frame, GArray *resp_frame, + GError **exception) +{ + HinawaFwFcpPrivate *priv; + HinawaFwReq *req; + struct fcp_transaction trans = {0}; + GMutex local_lock; + gint64 expiration; + guint32 *buf; + guint i, quads, bytes; + + g_return_if_fail(HINAWA_IS_FW_FCP(self)); + priv = FW_FCP_GET_PRIVATE(self); + + if (req_frame == NULL || g_array_get_element_size(req_frame) != 1 || + resp_frame == NULL || g_array_get_element_size(resp_frame) != 1 || + req_frame->len > FCP_MAXIMUM_FRAME_BYTES) { + g_set_error(exception, g_quark_from_static_string(__func__), + EINVAL, "%s", strerror(EINVAL)); + return; + } + + req = g_object_new(HINAWA_TYPE_FW_REQ, NULL); + + /* Copy guint8 array to guint32 array. */ + quads = (req_frame->len + sizeof(guint32) - 1) / sizeof(guint32); + trans.req_frame = g_array_sized_new(FALSE, TRUE, + sizeof(guint32), quads); + g_array_set_size(trans.req_frame, quads); + memcpy(trans.req_frame->data, req_frame->data, req_frame->len); + buf = (guint32 *)trans.req_frame->data; + for (i = 0; i < trans.req_frame->len; i++) + buf[i] = htobe32(buf[i]); + + /* Prepare response buffer. */ + trans.resp_frame = g_array_sized_new(FALSE, TRUE, + sizeof(guint32), quads); + + /* Insert this entry. */ + g_mutex_lock(&priv->lock); + priv->transactions = g_list_prepend(priv->transactions, &trans); + g_mutex_unlock(&priv->lock); + + /* NOTE: Timeout is 200 milli-seconds. */ + expiration = g_get_monotonic_time() + 200 * G_TIME_SPAN_MILLISECOND; + g_cond_init(&trans.cond); + g_mutex_init(&local_lock); + + /* Send this request frame. */ + hinawa_fw_req_write(req, priv->unit, FCP_REQUEST_ADDR, trans.req_frame, + exception); + if (*exception != NULL) + goto end; +deferred: + /* + * Wait corresponding response till timeout. + * NOTE: Timeout at bus-reset, illegally. + */ + g_mutex_lock(&local_lock); + if (!g_cond_wait_until(&trans.cond, &local_lock, expiration)) + g_set_error(exception, g_quark_from_static_string(__func__), + ETIMEDOUT, "%s", strerror(ETIMEDOUT)); + g_mutex_unlock(&local_lock); + + /* Error happened. */ + if (*exception != NULL) + goto end; + + /* It's a deffered transaction, wait 200 milli-seconds again. */ + if (trans.resp_frame->data[0] >> 24 == AVC_STATUS_INTERIM) { + expiration = g_get_monotonic_time() + + 200 * G_TIME_SPAN_MILLISECOND; + goto deferred; + } + + /* Convert guint32 array to guint8 array. */ + buf = (guint32 *)trans.resp_frame->data; + for (i = 0; i < trans.resp_frame->len; i++) + buf[i] = htobe32(buf[i]); + bytes = trans.resp_frame->len * sizeof(guint32); + g_array_set_size(resp_frame, bytes); + memcpy(resp_frame->data, trans.resp_frame->data, bytes); +end: + /* Remove this entry. */ + g_mutex_lock(&priv->lock); + priv->transactions = + g_list_remove(priv->transactions, (gpointer *)&trans); + g_mutex_unlock(&priv->lock); + + g_array_free(trans.req_frame, TRUE); + g_mutex_clear(&local_lock); + g_clear_object(&req); +} + +static GArray *handle_response(HinawaFwResp *self, gint tcode, + GArray *req_frame, gpointer user_data) +{ + HinawaFwFcp *fcp = (HinawaFwFcp *)user_data; + HinawaFwFcpPrivate *priv = FW_FCP_GET_PRIVATE(fcp); + struct fcp_transaction *trans; + GList *entry; + + g_mutex_lock(&priv->lock); + + /* Seek correcponding request. */ + for (entry = priv->transactions; entry != NULL; entry = entry->next) { + trans = (struct fcp_transaction *)entry->data; + + if ((trans->req_frame->data[1] == req_frame->data[1]) && + (trans->req_frame->data[2] == req_frame->data[2])) + break; + } + + /* No requests corresponding to this response. */ + if (entry == NULL) + goto end; + + g_array_insert_vals(trans->resp_frame, 0, + req_frame->data, req_frame->len); + g_cond_signal(&trans->cond); +end: + g_mutex_unlock(&priv->lock); + + /* Transfer no data in the response frame. */ + return NULL; +} + +/** + * hinawa_fw_fcp_listen: + * @self: A #HinawaFwFcp + * @unit: A #HinawaFwUnit + * @exception: A #GError + * + * Start to listen to FCP responses. + */ +void hinawa_fw_fcp_listen(HinawaFwFcp *self, HinawaFwUnit *unit, + GError **exception) +{ + HinawaFwFcpPrivate *priv; + + g_return_if_fail(HINAWA_IS_FW_FCP(self)); + priv = FW_FCP_GET_PRIVATE(self); + + priv->resp = g_object_new(HINAWA_TYPE_FW_RESP, NULL); + priv->unit = g_object_ref(unit); + + hinawa_fw_resp_register(priv->resp, priv->unit, + FCP_RESPOND_ADDR, FCP_MAXIMUM_FRAME_BYTES, + exception); + if (*exception != NULL) { + g_clear_object(&priv->resp); + priv->resp = NULL; + g_object_unref(priv->unit); + priv->unit = NULL; + return; + } + + g_signal_connect(priv->resp, "requested", + G_CALLBACK(handle_response), self); + + g_mutex_init(&priv->lock); + priv->transactions = NULL; +} + +/** + * hinawa_fw_fcp_unlisten: + * @self: A #HinawaFwFcp + * + * Stop to listen to FCP responses. + */ +void hinawa_fw_fcp_unlisten(HinawaFwFcp *self) +{ + HinawaFwFcpPrivate *priv; + + g_return_if_fail(HINAWA_IS_FW_FCP(self)); + priv = FW_FCP_GET_PRIVATE(self); + + if (priv->resp == NULL) + return; + + hinawa_fw_resp_unregister(priv->resp); + priv->resp = NULL; + g_object_unref(priv->unit); + priv->unit = NULL; +} diff --git a/libhinawa/src/fw_fcp.h b/libhinawa/src/fw_fcp.h new file mode 100644 index 0000000..206ebee --- /dev/null +++ b/libhinawa/src/fw_fcp.h @@ -0,0 +1,58 @@ +#ifndef __ALSA_TOOLS_HINAWA_FW_FCP_H__ +#define __ALSA_TOOLS_HINAWA_FW_FCP_H__ + +#include <glib.h> +#include <glib-object.h> +#include "internal.h" +#include "fw_unit.h" + +G_BEGIN_DECLS + +#define HINAWA_TYPE_FW_FCP (hinawa_fw_fcp_get_type()) + +#define HINAWA_FW_FCP(obj) \ + (G_TYPE_CHECK_INSTANCE_CAST((obj), \ + HINAWA_TYPE_FW_FCP, \ + HinawaFwFcp)) +#define HINAWA_IS_FW_FCP(obj) \ + (G_TYPE_CHECK_INSTANCE_TYPE((obj), \ + HINAWA_TYPE_FW_FCP)) + +#define HINAWA_FW_FCP_CLASS(klass) \ + (G_TYPE_CHECK_CLASS_CAST((klass), \ + HINAWA_TYPE_FW_FCP, \ + HinawaFwFcpClass)) +#define HINAWA_IS_FW_FCP_CLASS(klass) \ + (G_TYPE_CHECK_CLASS_TYPE((klass), \ + HINAWA_TYPE_FW_FCP)) +#define HINAWA_FW_FCP_GET_CLASS(obj) \ + (G_TYPE_INSTANCE_GET_CLASS((obj), \ + HINAWA_TYPE_FW_FCP, \ + HinawaFwFcpClass)) + +typedef struct _HinawaFwFcp HinawaFwFcp; +typedef struct _HinawaFwFcpClass HinawaFwFcpClass; +typedef struct _HinawaFwFcpPrivate HinawaFwFcpPrivate; + +struct _HinawaFwFcp { + GObject parent_instance; + + HinawaFwFcpPrivate *priv; +}; + +struct _HinawaFwFcpClass { + GObjectClass parent_class; +}; + +GType hinawa_fw_fcp_get_type(void) G_GNUC_CONST; + +HinawaFwFcp *hinawa_fw_fcp_new(GError **exception); + +void hinawa_fw_fcp_listen(HinawaFwFcp *self, HinawaFwUnit *unit, + GError **exception); +void hinawa_fw_fcp_transact(HinawaFwFcp *self, + GArray *req_frame, GArray *resp_frame, + GError **exception); +void hinawa_fw_fcp_unlisten(HinawaFwFcp *self); + +#endif

Dice is 'Digital Interface Communications Engine' which TC Applied Technologies produced. Several chipset are produced under a name of Dice. For Dice chipset, well-known FCP or AV/C commands are not used to control devices. It's performed by read/write transactions into specific addresses.

Dice has a specific mechanism called as 'notification'. When device status is changed, Dice devices tells the event by sending transaction. This notification is sent to an address to which ALSA Dice driver listens. Then the driver allows applications to read it via ALSA hwdep interface.

This commit adds HINAWA_TYPE_SND_DICE object to handle the notification. When applications calls listen() method, the instance generates 'notified' signal when the Dice unit transfer notification. This object also have transact() method. An application can change unit status and wait the notification with given bit flag.

This object is an inheritance of HINAWA_TYPE_SND_UNIT, thus any signals and properties, methods are also available.

Signed-off-by: Takashi Sakamoto o-takashi@sakamocchi.jp --- libhinawa/doc/reference/hinawa-docs.sgml | 1 + libhinawa/src/Makefile.am | 7 +- libhinawa/src/internal.h | 3 + libhinawa/src/snd_dice.c | 195 +++++++++++++++++++++++++++++++ libhinawa/src/snd_dice.h | 53 +++++++++ libhinawa/src/snd_unit.c | 5 + 6 files changed, 262 insertions(+), 2 deletions(-) create mode 100644 libhinawa/src/snd_dice.c create mode 100644 libhinawa/src/snd_dice.h

diff --git a/libhinawa/doc/reference/hinawa-docs.sgml b/libhinawa/doc/reference/hinawa-docs.sgml index 8d4483e..58c862a 100644 --- a/libhinawa/doc/reference/hinawa-docs.sgml +++ b/libhinawa/doc/reference/hinawa-docs.sgml @@ -35,6 +35,7 @@ <xi:include href="xml/fw_req.xml"/> <xi:include href="xml/fw_fcp.xml"/> <xi:include href="xml/snd_unit.xml"/> + <xi:include href="xml/snd_dice.xml"/> </chapter> </part>

diff --git a/libhinawa/src/Makefile.am b/libhinawa/src/Makefile.am index b717e4e..696e567 100644 --- a/libhinawa/src/Makefile.am +++ b/libhinawa/src/Makefile.am @@ -34,7 +34,9 @@ libhinawa_la_SOURCES = \ fw_fcp.h \ fw_fcp.c \ snd_unit.h \ - snd_unit.c + snd_unit.c \ + snd_dice.h \ + snd_dice.c

pkginclude_HEADERS = \ hinawa_sigs_marshal.h \ @@ -42,7 +44,8 @@ pkginclude_HEADERS = \ fw_resp.h \ fw_req.h \ fw_fcp.h \ - snd_unit.h + snd_unit.h \ + snd_dice.h

hinawa_sigs_marshal.list: $(AM_V_GEN)( find | grep .c$$ | xargs cat | \ diff --git a/libhinawa/src/internal.h b/libhinawa/src/internal.h index 717cda3..ddbb298 100644 --- a/libhinawa/src/internal.h +++ b/libhinawa/src/internal.h @@ -12,6 +12,7 @@ #include "fw_resp.h" #include "fw_req.h" #include "snd_unit.h" +#include "snd_dice.h"

void hinawa_fw_unit_ioctl(HinawaFwUnit *self, int req, void *args, int *err); void hinawa_fw_resp_handle_request(HinawaFwResp *self, @@ -22,4 +23,6 @@ void hinawa_fw_req_handle_response(HinawaFwReq *self, void hinawa_snd_unit_write(HinawaSndUnit *unit, const void *buf, unsigned int length, GError **exception); +void hinawa_snd_dice_handle_notification(HinawaSndDice *self, + const void *buf, unsigned int len); #endif diff --git a/libhinawa/src/snd_dice.c b/libhinawa/src/snd_dice.c new file mode 100644 index 0000000..a3b839e --- /dev/null +++ b/libhinawa/src/snd_dice.c @@ -0,0 +1,195 @@ +#include <linux/types.h> +#include <sound/firewire.h> +#include <alsa/asoundlib.h> +#include "snd_dice.h" +#include "internal.h" + +#ifdef HAVE_CONFIG_H +# include <config.h> +#endif + +/** + * SECTION:snd_dice + * @Title: HinawaSndDice + * @Short_description: A notification listener for Dice models + * + * A #HinawaSndDice listen to Dice notification and generates signal when + * received. This inherits #HinawaSndUnit. + */ + +struct notification_waiter { + guint32 bit_flag; + GCond cond; +}; + +struct _HinawaSndDicePrivate { + GList *waiters; + GMutex lock; +}; +G_DEFINE_TYPE_WITH_PRIVATE(HinawaSndDice, hinawa_snd_dice, HINAWA_TYPE_SND_UNIT) +#define SND_DICE_GET_PRIVATE(obj) \ + (G_TYPE_INSTANCE_GET_PRIVATE((obj), \ + HINAWA_TYPE_SND_DICE, \ + HinawaSndDicePrivate)) + +/* This object has one signal. */ +enum dice_sig_type { + DICE_SIG_TYPE_NOTIFIED, + DICE_SIG_TYPE_COUNT, +}; +static guint dice_sigs[DICE_SIG_TYPE_COUNT] = { 0 }; + +static void snd_dice_dispose(GObject *obj) +{ + G_OBJECT_CLASS(hinawa_snd_dice_parent_class)->dispose(obj); +} + +static void snd_dice_finalize(GObject *gobject) +{ + G_OBJECT_CLASS(hinawa_snd_dice_parent_class)->finalize(gobject); +} + +static void hinawa_snd_dice_class_init(HinawaSndDiceClass *klass) +{ + GObjectClass *gobject_class = G_OBJECT_CLASS(klass); + + gobject_class->dispose = snd_dice_dispose; + gobject_class->finalize = snd_dice_finalize; + + /** + * HinawaSndDice::notified: + * @self: A #HinawaSndDice + * @message: A notification message + * + * When Dice models transfer notification, the ::notified signal is + * generated. + */ + dice_sigs[DICE_SIG_TYPE_NOTIFIED] = + g_signal_new("notified", + G_OBJECT_CLASS_TYPE(klass), + G_SIGNAL_RUN_LAST, + 0, + NULL, NULL, + g_cclosure_marshal_VOID__ULONG, + G_TYPE_NONE, 1, G_TYPE_ULONG); +} + +static void hinawa_snd_dice_init(HinawaSndDice *self) +{ + self->priv = hinawa_snd_dice_get_instance_private(self); +} + +/** + * hinawa_snd_dice_new: + * @path: A path to ALSA hwdep device for Dice models (i.e. hw:0) + * @exception: A #GError + * + * Returns: An instance of #HinawaSndDice + */ +void hinawa_snd_dice_open(HinawaSndDice *self, gchar *path, GError **exception) +{ + HinawaSndDicePrivate *priv; + int type; + + g_return_if_fail(HINAWA_IS_SND_DICE(self)); + + hinawa_snd_unit_open(&self->parent_instance, path, exception); + if (*exception != NULL) { + g_clear_object(&self); + return; + } + + g_object_get(G_OBJECT(self), "type", &type, NULL); + if (type != SNDRV_FIREWIRE_TYPE_DICE) { + g_set_error(exception, g_quark_from_static_string(__func__), + EINVAL, "%s", strerror(EINVAL)); + g_clear_object(&self); + } + priv = SND_DICE_GET_PRIVATE(self); + + priv->waiters = NULL; + g_mutex_init(&priv->lock); +} + +/** + * hinawa_snd_dice_transact: + * @self: A #HinawaSndDice + * @addr: A destination address of target device + * @frame: (element-type guint32) (array) (in): a 32bit array + * @bit_flag: bit flag to wait + * @exception: A #GError + * + * Execute write transactions to the given address, then wait and check + * notification. + */ +void hinawa_snd_dice_transact(HinawaSndDice *self, guint64 addr, + GArray *frame, guint32 bit_flag, + GError **exception) +{ + HinawaSndDicePrivate *priv; + struct notification_waiter waiter = {0}; + gint64 expiration; + + g_return_if_fail(HINAWA_IS_SND_DICE(self)); + priv = SND_DICE_GET_PRIVATE(self); + + /* Insert this entry to list and enter critical section. */ + g_mutex_lock(&priv->lock); + priv->waiters = g_list_append(priv->waiters, &waiter); + + /* NOTE: Timeout is 200 milli-seconds. */ + expiration = g_get_monotonic_time() + 200 * G_TIME_SPAN_MILLISECOND; + g_cond_init(&waiter.cond); + + waiter.bit_flag = bit_flag; + hinawa_snd_unit_write_transact(&self->parent_instance, addr, frame, + exception); + if (*exception != NULL) + goto end; + + /* + * Wait notification till timeout and temporarily leave the critical + * section. + */ + if (!g_cond_wait_until(&waiter.cond, &priv->lock, expiration)) + g_set_error(exception, g_quark_from_static_string(__func__), + ETIMEDOUT, "%s", strerror(ETIMEDOUT)); +end: + priv->waiters = g_list_remove(priv->waiters, (gpointer *)&waiter); + + g_mutex_unlock(&priv->lock); +} + +void hinawa_snd_dice_handle_notification(HinawaSndDice *self, + const void *buf, unsigned int len) +{ + HinawaSndDicePrivate *priv; + + GList *entry; + struct notification_waiter *waiter; + + struct snd_firewire_event_dice_notification *event = + (struct snd_firewire_event_dice_notification *)buf; + + g_return_if_fail(HINAWA_IS_SND_DICE(self)); + priv = SND_DICE_GET_PRIVATE(self); + + g_signal_emit(self, dice_sigs[DICE_SIG_TYPE_NOTIFIED], + 0, event->notification); + + g_mutex_lock(&priv->lock); + + for (entry = priv->waiters; entry != NULL; entry = entry->next) { + waiter = (struct notification_waiter *)entry->data; + + if (waiter->bit_flag & event->notification) + break; + } + + g_mutex_unlock(&priv->lock); + + if (entry == NULL) + return; + + g_cond_signal(&waiter->cond); +} diff --git a/libhinawa/src/snd_dice.h b/libhinawa/src/snd_dice.h new file mode 100644 index 0000000..f33835a --- /dev/null +++ b/libhinawa/src/snd_dice.h @@ -0,0 +1,53 @@ +#ifndef __ALSA_TOOLS_HINAWA_SND_DICE_H__ +#define __ALSA_TOOLS_HINAWA_SND_DICE_H__ + +#include <glib.h> +#include <glib-object.h> +#include "snd_unit.h" + +G_BEGIN_DECLS + +#define HINAWA_TYPE_SND_DICE (hinawa_snd_dice_get_type()) + +#define HINAWA_SND_DICE(obj) \ + (G_TYPE_CHECK_INSTANCE_CAST((obj), \ + HINAWA_TYPE_SND_DICE, \ + HinawaSndDice)) +#define HINAWA_IS_SND_DICE(obj) \ + (G_TYPE_CHECK_INSTANCE_TYPE((obj), \ + HINAWA_TYPE_SND_DICE)) + +#define HINAWA_SND_DICE_CLASS(klass) \ + (G_TYPE_CHECK_CLASS_CAST((klass), \ + HINAWA_TYPE_SND_DICE, \ + HinawaSndDiceClass)) +#define HINAWA_IS_SND_DICE_CLASS(klass) \ + (G_TYPE_CHECK_CLASS_TYPE((klass), \ + HINAWA_TYPE_SND_DICE)) +#define HINAWA_SND_DICE_GET_CLASS(obj) \ + (G_TYPE_INSTANCE_GET_CLASS((obj), \ + HINAWA_TYPE_SND_DICE, \ + HinawaSndDiceClass)) + +typedef struct _HinawaSndDice HinawaSndDice; +typedef struct _HinawaSndDiceClass HinawaSndDiceClass; +typedef struct _HinawaSndDicePrivate HinawaSndDicePrivate; + +struct _HinawaSndDice { + HinawaSndUnit parent_instance; + + HinawaSndDicePrivate *priv; +}; + +struct _HinawaSndDiceClass { + HinawaSndUnitClass parent_class; +}; + +GType hinawa_snd_dice_get_type(void) G_GNUC_CONST; + +void hinawa_snd_dice_open(HinawaSndDice *self, gchar *path, GError **exception); + +void hinawa_snd_dice_transact(HinawaSndDice *self, guint64 addr, + GArray *frame, guint32 bit_flag, + GError **exception); +#endif diff --git a/libhinawa/src/snd_unit.c b/libhinawa/src/snd_unit.c index 859cab2..b7537a3 100644 --- a/libhinawa/src/snd_unit.c +++ b/libhinawa/src/snd_unit.c @@ -6,6 +6,7 @@ #include "snd_unit.h" #include "fw_req.h" #include "fw_fcp.h" +#include "snd_dice.h" #include "internal.h"

#ifdef HAVE_CONFIG_H @@ -407,6 +408,10 @@ static gboolean check_src(GSource *gsrc)

if (common->type == SNDRV_FIREWIRE_EVENT_LOCK_STATUS) handle_lock_event(unit, priv->buf, len); + else if (HINAWA_IS_SND_DICE(unit) && + common->type == SNDRV_FIREWIRE_EVENT_DICE_NOTIFICATION) + hinawa_snd_dice_handle_notification(HINAWA_SND_DICE(unit), + priv->buf, len); end: /* Don't go to dispatch, then continue to process this source. */ return FALSE;

To construct an instance of snd_unit/snd_dice/snd_efw, applications need to know which hwdep device is corresponding to the target unit.

This commit adds HINAWA_TYPE_UNIT_QUERY object to query hwdep devices for FireWire unit. This object has no constructor, therefore applications can get sibling hwdep device or the type of given hwdep device without any instances.

Signed-off-by: Takashi Sakamoto o-takashi@sakamocchi.jp --- libhinawa/doc/reference/hinawa-docs.sgml | 1 + libhinawa/src/Makefile.am | 7 +- libhinawa/src/unit_query.c | 116 +++++++++++++++++++++++++++++++ libhinawa/src/unit_query.h | 48 +++++++++++++ 4 files changed, 170 insertions(+), 2 deletions(-) create mode 100644 libhinawa/src/unit_query.c create mode 100644 libhinawa/src/unit_query.h

diff --git a/libhinawa/doc/reference/hinawa-docs.sgml b/libhinawa/doc/reference/hinawa-docs.sgml index 731ae15..dbfa0f2 100644 --- a/libhinawa/doc/reference/hinawa-docs.sgml +++ b/libhinawa/doc/reference/hinawa-docs.sgml @@ -37,6 +37,7 @@ <xi:include href="xml/snd_unit.xml"/> <xi:include href="xml/snd_dice.xml"/> <xi:include href="xml/snd_efw.xml"/> + <xi:include href="xml/unit_query.xml"/> </chapter> </part>

diff --git a/libhinawa/src/Makefile.am b/libhinawa/src/Makefile.am index b746bf1..4fbbdd3 100644 --- a/libhinawa/src/Makefile.am +++ b/libhinawa/src/Makefile.am @@ -38,7 +38,9 @@ libhinawa_la_SOURCES = \ snd_dice.h \ snd_dice.c \ snd_efw.h \ - snd_efw.c + snd_efw.c \ + unit_query.h \ + unit_query.c

pkginclude_HEADERS = \ hinawa_sigs_marshal.h \ @@ -48,7 +50,8 @@ pkginclude_HEADERS = \ fw_fcp.h \ snd_unit.h \ snd_dice.h \ - snd_efw.h + snd_efw.h \ + unit_query.h

hinawa_sigs_marshal.list: $(AM_V_GEN)( find | grep .c$$ | xargs cat | \ diff --git a/libhinawa/src/unit_query.c b/libhinawa/src/unit_query.c new file mode 100644 index 0000000..669513d --- /dev/null +++ b/libhinawa/src/unit_query.c @@ -0,0 +1,116 @@ +#include <unistd.h> +#include <alsa/asoundlib.h> +#include <sound/firewire.h> + +#include "unit_query.h" + +/** + * SECTION:unit_query + * @Title: HinawaUnitQuery + * @Short_description: An query to seek ALSA FireWire devices + * + */ +G_DEFINE_TYPE(HinawaUnitQuery, hinawa_unit_query, G_TYPE_OBJECT) + +static void unit_query_dispose(GObject *obj) +{ + G_OBJECT_CLASS(hinawa_unit_query_parent_class)->dispose(obj); +} + +static void unit_query_finalize(GObject *gobject) +{ + G_OBJECT_CLASS(hinawa_unit_query_parent_class)->finalize(gobject); +} + +static void hinawa_unit_query_class_init(HinawaUnitQueryClass *klass) +{ + GObjectClass *gobject_class = G_OBJECT_CLASS(klass); + + gobject_class->dispose = unit_query_dispose; + gobject_class->finalize = unit_query_finalize; +} + +static void hinawa_unit_query_init(HinawaUnitQuery *self) +{ + return; +} + +/** + * hinawa_unit_query_get_sibling: + * @id: The ID of sibling. + * @exception: A #GError + * + * Returns: the ID of sibling. + */ +gint hinawa_unit_query_get_sibling(gint id, GError **exception) +{ + snd_ctl_t *handle = NULL; + int err; + + /* NOTE: at least one sound device is expected to be detected. */ + err = snd_ctl_open(&handle, "hw:0", 0); + if (err < 0) + goto end; + + err = snd_ctl_hwdep_next_device(handle, &id); + if (err < 0) + goto end; + if (id < 0) { + err = -ENODEV; + goto end; + } + + hinawa_unit_query_get_unit_type(id, exception); +end: + if (err < 0) { + id = -1; + g_set_error(exception, g_quark_from_static_string(__func__), + -err, "%s", snd_strerror(err)); + } + if (handle != NULL) + snd_ctl_close(handle); + + return id; +} + +/** + * hinawa_unit_query_get_unit_type: + * @id: An ID for unit. + * @exception: An #GError + * + * Returns: The types of the unit. The value of SNDRV_FIREWIRE_TYPE_XXX. + */ +gint hinawa_unit_query_get_unit_type(gint id, GError **exception) +{ + snd_hwdep_t *handle = NULL; + char path[10] = {0}; + struct snd_firewire_get_info info; + gint type = -1; + int err; + + /* Check id and make device string */ + if (id < 0) { + err = -EINVAL; + goto end; + } + snprintf(path, sizeof(path), "hw:%d", id); + + /* Open hwdep handle. */ + err = snd_hwdep_open(&handle, path, 0); + if (err < 0) + goto end; + + /* Get FireWire sound device information. */ + err = snd_hwdep_ioctl(handle, SNDRV_FIREWIRE_IOCTL_GET_INFO, &info); + if (err < 0) + goto end; + type = info.type; +end: + if (err < 0) + g_set_error(exception, g_quark_from_static_string(__func__), + -err, "%s", snd_strerror(err)); + if (handle != NULL) + snd_hwdep_close(handle); + + return type; +} diff --git a/libhinawa/src/unit_query.h b/libhinawa/src/unit_query.h new file mode 100644 index 0000000..cdaf09b --- /dev/null +++ b/libhinawa/src/unit_query.h @@ -0,0 +1,48 @@ +#ifndef __ALSA_TOOLS_HINAWA_UNIT_QUERY_H__ +#define __ALSA_TOOLS_HINAWA_UNIT_QUERY_H__ + +#include <glib.h> +#include <glib-object.h> + +G_BEGIN_DECLS + +#define HINAWA_TYPE_UNIT_QUERY (hinawa_unit_query_get_type()) + +#define HINAWA_UNIT_QUERY(obj) \ + (G_TYPE_CHECK_INSTANCE_CAST((obj), \ + HINAWA_TYPE_UNIT_QUERY, \ + HinawaUnitQuery)) +#define HINAWA_IS_UNIT_QUERY(obj) \ + (G_TYPE_CHECK_INSTANCE_TYPE((obj), \ + HINAWA_TYPE_UNIT_QUERY)) + +#define HINAWA_UNIT_QUERY_CLASS(klass) \ + (G_TYPE_CHECK_CLASS_CAST((klass), \ + HINAWA_TYPE_UNIT_QUERY, \ + HinawaUnitQueryClass)) +#define HINAWA_IS_UNIT_QUERY_CLASS(klass) \ + (G_TYPE_CHECK_CLASS_TYPE((klass), \ + HINAWA_TYPE_UNIT_QUERY)) +#define HINAWA_UNIT_QUERY_GET_CLASS(obj) \ + (G_TYPE_INSTANCE_GET_CLASS((obj), \ + HINAWA_TYPE_UNIT_QUERY, \ + HinawaUnitQueryClass)) + +typedef struct _HinawaUnitQuery HinawaUnitQuery; +typedef struct _HinawaUnitQueryClass HinawaUnitQueryClass; + +struct _HinawaUnitQuery { + GObject parent_instance; +}; + +struct _HinawaUnitQueryClass { + GObjectClass parent_class; +}; + +GType hinawa_unit_query_get_type(void) G_GNUC_CONST; + +gint hinawa_unit_query_get_sibling(gint id, GError **exception); + +gint hinawa_unit_query_get_unit_type(gint id, GError **exception); + +#endif