NEWS: release v0.5

Makefile: remove the changelog target it's not used anymore

Remove trailing spaces here and there

README: document how to install the udev rules

Makefile: don't install the udev rules automatically in the install target

Also use kinect_patch_udev_rules to be able to patch the udev rules tile
after installing it.

Update copyright info

kinect_fetch_fw: remove an unneeded space

Factor out a kinect_patch_udev_rules script

This allows to prepare the udev rules file at "make install" time, while
still being able to fetch the firmware at some later stage.

This makes it easier for packages to have a stable udev rules file.

kinect_fetch_fw: install the firmware as UACFirmware

This makes it easier to handle it, and it is also in line with newer SDK
versions which use this name.

kinect_fetch_fw: use curly braces when they are actually useful

kinect_fetch_fw: declare FIRMWARE_PATH earlier and use it when installing

This is in preparation for renaming the destination firmware file.

kinect_fetch_fw: don't use curly braces when they are not needed

kinect_fetch_fw: don't use DESTDIR, it's not needed

If there is the need to install stuff under some common destination
directory at installation time, the caller can prepend the path to the
arguments passed to the script.

kinect_fetch_fw: use readlink -m when setting FW_DESTDIR

This way the normalization succeeds even when the parent directory in
"$1" does not exists.

For example, if FW_DESTDIR is going to be set to /lib/firmware/kinect
but /lib/firmware does not exist yet, there is no reason to fail as the
install command below is going to create all the needed sub-paths.

Fix broken links to the Kinect For Windows EULA

Drop the Changelog file and use a NEWS file

The NEWS file is intended for humans, all the other species can look at
the git history.

There is no need to keep a detailed Changelog around which is the exact
copy of the git history anyways.

kinect_upload_fw: detach possible kernel drivers

kinect_upload_fw: make libusb initialization more robust

Check the return values of all the libusb functions.

Also return more sensible values when ret is not immediately useful.

kinect_upload_fw: return -errno when fopen fails

This way all the error paths return negative codes.

kinect_upload_fw: some cosmetic changes

Adjust the code style a little bit, no functional changes.

kinect_upload_fw: rename "res" to "ret" in main()

For me it's more a return value than the actual result of some operation.

kinect_upload_fw: factor out an upload_firmware function

kinect_upload_fw: fix some warnings from clang -Weverything

kinect_upload_fw: Makefile: don't enable unsupported options with clang

kinect_upload_fw: check the return value of get_first_reply() and get_reply()

kinect_upload_fw: release the interface when exiting

kinect_upload_fw: use symbolic constants instead of magic values

kinect_upload_fw: initialize current_configuration before libusb_get_configuration()

Initialize the variable as suggested by http://libusb.sourceforge.net/api-1.0/caveats.html

kinect_upload_fw: fix setting configuration for some devices

On some Kinect devices where the desired configuration is already the
currently active one libusb_set_configuration() fails in some way
causing the subsequent bulk transfer to fail, and the program to exit,
with this message:

  libusbx: error [op_set_configuration] failed, error -1 errno 110
  About to send: 09 20 02 06 01 00 00 00 60 00 00 00 00 00 00 00 15 00 00 00 00 00 00 00
  libusbx: error [submit_bulk_transfer] submiturb failed error -1 errno=2
  Error: res: -1    transferred: 0 (expected 24)

Only set the desired configuration if it hasn't been set already.
This prevents the problems from above.

Do the configuration check as illustrated in
http://libusbx.sourceforge.net/api-1.0/caveats.html that is by checking
that the current configuration is still the desired one after claiming
the device.

ChangeLog: refresh for v0.3

Makefile: remove a trailing space

Makefile: don't create the empty dir /lib/firmware/kinect

Let kinect_fetch_fw create the frmware destination dir when necessary.

kinect_upload_fw/Makefile: fix double spacing

Remove a double space before an assignment.

kinect_upload_fw/endian.c: fix warning and rename a function

Remove the bigend() function, it is never used and causes a compiler
warning:

  endian.c:10:12: warning: ‘bigend’ defined but not used [-Wunused-function]
   static int bigend(void) {

Also rename the litend() function to little_endian(), there is no need
to use a short name in this case.

README: reword and re-indent some paragraphs

Makefile: misc fixes

Use $(MAKE) for recursive invocations, fix a typo s/prare/prepare/, and
fix wording in a comment.

kinect_upload_fw: initialize 'transferred' before USB transfers

This makes sure the subsequent error messages print a sane value when
libusb fails without touching the variable.

README: acknowledge Steven Toth's sponsorship

kinect_fetch_fw: mention that p7zip-full >= 9.20 is needed

With earlier versions the firmware cannot be extracted from the .msi
file.

README: mention reloading udev rules

After the firmware has been downloaded and the udev rules installed,
udevd must be told to reload the rules to actually handle the Kinect
audio device.

Add ChangeLog for v0.2

kinect_fetch_fw: tell where we are getting the firmware from

README: tell where we are getting the actual firmware from

README: fix a typo and add some clarifications

kinect_fetch_fw: make the script less verbose when invoking 7z

kinect_fetch_fw: download the latest KinectSDK-v1.0-beta2-x86.msi

kinect_fetch_fw: mention wget in the internal documentation

kinect_upload_fw: specify libraries after objects in the linking command

When some options, like -Wl,--as-needed, are passed to the compiler (and
then to the liker) the order of linking options becomes important:
libraries must be specified after the objects in the linking command.

The implicit rule used was more or less:
  kinect_upload_fw: kinect_upload_fw.o
      $(CC) $(LDFLAGS) $^ $(LOADLIBES) $(LDLIBS) -o $@

with LDFLAGS expanded before $^ (the objects); use LDLIBS to specify the
libraries instead, which is expanded after $^.

More details in
http://ao2.it/it/blog/2011/11/27/dont-mix-ldflags-and-ldlibs

Add info about building kinect_upload_fw for MS Windows

Update .gitignore

Add endian and endian.h, add any *.o file and even *.exe ones as we are
going to add instructions about how to build kinect_upload_fw on MS
Windows too.

kinect_upload_fw: fix reading the firmware file on Windows

In MS Windows fread() behaves differently than on UNIX systems when
reading binary files if we do not specify "b" in the mode when opening
the file.

Quoting FOPEN(3) man page:

 ... the 'b' is ignored on all POSIX conforming systems, including
 Linux. (Other systems may treat text files and binary files
 differently, and adding the 'b' may be a good idea if you do I/O to a
 binary file and expect that your program may be ported to non-UNIX
 environments.)

kinect_upload_fw: fix a mingw32 compilation error

When compiling with i586-mingw32msvci-g++ We get these errors:

kinect_upload_fw.c: In function ‘int main(int, char**)’:
kinect_upload_fw.c:236: error: jump to label ‘cleanup’
kinect_upload_fw.c:179: error:   from here
kinect_upload_fw.c:185: error:   crosses initialization of ‘uint32_t addr’
kinect_upload_fw.c:238: error: jump to label ‘fail_libusb_open’
kinect_upload_fw.c:155: error:   from here
kinect_upload_fw.c:185: error:   crosses initialization of ‘uint32_t addr’

Declaring and initializing a variable in the same statement after a goto
is allowed in C but not in C++; look at C++ specification Section 6.7
Paragraph 3.
(http://www.kuzbass.ru:8086/docs/isocpp/stmt.html#stmt.dcl)

Work around that by splitting 'addr' declaration and initialization.

kinect_upload_fw: fix generating endian.h before compiling kinect_upload_fw

Generate endian.h before compiling kinect_upload_fw, this is how it
should have been done from the start.

Until now the system-wide endian.h was being picked up instead, making
the whole compile-time-endian-detection mechanism useless; now we are
actually using it.

kinect_upload_fw: disable some compiler flags

Disable some compiler flags to be more compatible with older setups:

  - vanilla libusb-1.0.8 makes compilation fail with -pedantic-errors

  - gcc versions older than 4.6 do not have -Wunused-but-set-variable

Add ChangeLog for v0.1

kinect_upload_fw: fix a couple of minor warnings from 'sparse'

Sparse is a Semantic Parser for C, it gives these warnings on
kinect_upload_fw.c:

kinect_upload_fw.c:42:14: warning: symbol 'seq' was not declared. Should it be static?
kinect_upload_fw.c:149:26: warning: Using plain integer as NULL pointer

kinect_upload_fw: support architectures that are not little-endian

Add an endian.c program which will be used at compile time to generate
an endian.h file with the information about the endianness of the
architecture. This way we do not depend on any particular build system
to retrieve this information (libfreenect knows the endianness with the
help of Cmake, for instance).

This is inspired from the rdesktop project[1] and looks more portable
than relying on the system endian.h as its use is relatively new and not
standardized yet, even though there are proposals in that direction[2].

Finally fn_le32() implementation is ripped off from libfreenect.

[1] http://www.rdesktop.org/archive/2001/msg00722.html
[2] http://austingroupbugs.net/view.php?id=162

kinect_fetch_fw: add a mechanism to check the integrity of the downloaded file

kinect_fetch_fw: print error messages on stderr

kinect_upload_fw: really fix -Wformat warnings about sizeof()

Use "%zu" when printing the result of a sizeof(), this way the integer
conversion is done correctly taking into account the particular
architecture.

On a PPC64 (PlayStation 3) we were getting:

kinect_upload_fw.c: In function ‘get_reply’:
kinect_upload_fw.c:99:3: warning: format ‘%lu’ expects argument of type ‘long unsigned int’, but argument 4 has type ‘unsigned int’ [-Wformat]
kinect_upload_fw.c: In function ‘main’:
kinect_upload_fw.c:169:3: warning: format ‘%lu’ expects argument of type ‘long unsigned int’, but argument 4 has type ‘unsigned int’ [-Wformat]
kinect_upload_fw.c:194:4: warning: format ‘%lu’ expects argument of type ‘long unsigned int’, but argument 4 has type ‘unsigned int’ [-Wformat]
kinect_upload_fw.c:220:3: warning: format ‘%lu’ expects argument of type ‘long unsigned int’, but argument 4 has type ‘unsigned int’ [-Wformat]

kinect_upload_fw: fix issues shown by valgrind --leak-check=full --show-reachable=yes

Fix a "possibly lost" issue due to a missing call to libusb_exit() when
exiting after libusb_open_device_with_vid_pid() fails.

Fix a "still reachable" issue due to a missing fclose().

kinect_upload_fw: cosmetic changes

  - Spaces after contitionals
  - Spaces after commas
  - Some newlines to increase readability
  - Print a error message to stderr

kinect_upload_fw: print more meaningful error message on failure

kinect_fetch_fw: return value from $() does not need to be quoted

kinect_fetch_fw: make FW_DESTDIR an absolute path

This allows passing relative paths as arguments and be sure they don't
end up being relative to the temporary directory.

Also remove the slash after DESTDIR to avoid double slash.

Change description of kinect_fetch_fw

Add more info in the README file

kinect_upload_fw: fix a -Wstrict-aliasing warning

kinect_upload_fw.c:87:2: warning: dereferencing type-punned pointer will break strict-aliasing rules [-Wstrict-aliasing]

Use a union when there is the need to use the same memory for variables
of incompatible types (especially if they have different storage size).

kinect_upload_fw: fix assigning a string literal to a 'char *'

kinect_upload_fw.c:118:19: error: initialization discards ‘const’ qualifier from pointer target type

A string literals can be seen as "const char *" or as array of chars,
I like the second interpretation better.

kinect_upload_fw: fix -Wsign-compare and -Wpointer-sign

kinect_upload_fw.c:99:25: warning: comparison between signed and unsigned integer expressions [-Wsign-compare]
kinect_upload_fw.c:188:4: error: pointer targets in passing argument 3 of ‘libusb_bulk_transfer’ differ in signedness [-Wpointer-sign]

kinect_upload_fw: fix -Wformat warnings

kinect_upload_fw.c:92:3: warning: format ‘%d’ expects argument of type ‘int’, but argument 4 has type ‘long unsigned int’ [-Wformat]
kinect_upload_fw.c:157:3: warning: format ‘%d’ expects argument of type ‘int’, but argument 4 has type ‘long unsigned int’ [-Wformat]
kinect_upload_fw.c:182:4: warning: format ‘%d’ expects argument of type ‘int’, but argument 4 has type ‘long unsigned int’ [-Wformat]
kinect_upload_fw.c:208:3: warning: format ‘%d’ expects argument of type ‘int’, but argument 4 has type ‘long unsigned int’ [-Wformat]

kinect_upload_fw: fix -Wmissing-prototypes warning

kinect_upload_fw.c:60:6: warning: no previous prototype for ‘dump_bl_cmd’ [-Wmissing-prototypes]
kinect_upload_fw.c:67:5: warning: no previous prototype for ‘get_first_reply’ [-Wmissing-prototypes]
kinect_upload_fw.c:86:5: warning: no previous prototype for ‘get_reply’ [-Wmissing-prototypes]

GCC emits "missing-prototypes" argument for _public_ functions without a
prototype, making them static is the right fix here.

kinect_upload_fw: fix -Wold-style-definition warnings

kinect_upload_fw.c:67:5: warning: old-style function definition [-Wold-style-definition]
kinect_upload_fw.c:86:5: warning: old-style function definition [-Wold-style-definition]

kinect_upload_fw: fix spacing in Makefile, use simple expansion to set bindir

kinect_upload_fw: enable more warnings in Makefile

kinect_upload_fw: remove some trailing spaces

Makefile: Add a rule to generate a GNU style Changelog

Lintian, the Debian package checker issues a warning when the upstream
does not provide a Changelog, now we can easily generate one for tagged
release using "make changelog".

Add a .gitignore file

Initial import of the other pieces of knect_audio_setup

Initial import of kinect_upload_fw

kinect_upload_fw is a program to upload the Usb Audio Class firmware to
the Microsoft Kinect sensor device. Before the firmware is uploaded the
device shows up as a generic usb device with a bulk endpoint, after the
firmware upload a reenumeration takes place and a Usb Audio Class device
becomes available.