BLAHAJ
/
libsigrok
10
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

HACKING: Minor updates.

This commit is contained in:
Uwe Hermann 2014-11-11 23:52:53 +01:00
parent ed6b4c4747
commit 487c23fc99
1 changed files with 6 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
HACKING
View File

@ -45,7 +45,7 @@ You can apply it like this:
$ cd libsigrok $ cd libsigrok
$ git am 0001-tondaj-sl-814-Initial-driver-skeleton.patch $ git am 0001-tondaj-sl-814-Initial-driver-skeleton.patch
You can now edit the files in the hardware/tondaj-sl-814 directory as needed You can now edit the files in src/hardware/tondaj-sl-814 as needed
and implement your driver based on the skeleton files there. That means your and implement your driver based on the skeleton files there. That means your
patch submission later will consist of at least two patches: the initial one patch submission later will consist of at least two patches: the initial one
adding the skeleton driver, and one or more additional patches that actually adding the skeleton driver, and one or more additional patches that actually
@ -59,15 +59,10 @@ This is a rough overview of what you need to do in order to add a new driver
(using the Tondaj SL-814 device as example). It's basically what the (using the Tondaj SL-814 device as example). It's basically what the
'new-driver' script (see above) does for you: 'new-driver' script (see above) does for you:
- configure.ac: - Makefile.am: Add HW_TONDAJ_SL_814 and add to libsigrok_la_SOURCES.
- Add an --enable-tondaj-sl-814 option. - configure.ac: Add a DRIVER() and DRIVER2() call.
- Add "hardware/tondaj-sl-814/Makefile" to the AC_CONFIG_FILES list. - src/drivers.c: Add a tondaj_sl_814_driver_info entry in two places.
- Add and entry for the device in the "Enabled hardware drivers" list - src/hardware/tondaj-sl-814/ directory: Add api.c, protocol.c, protocol.h.
at the bottom of the file.
- hardware/Makefile.am: Add "tondaj-sl-814" to the SUBDIRS variable.
- hwdriver.c: Add a tondaj_sl_814_driver_info entry in two places.
- hardware/tondaj-sl-814/ directory: Add the following files:
Makefile.am, api.c, protocol.c, protocol.h
See existing drivers or the 'new-driver' output for the details. See existing drivers or the 'new-driver' output for the details.
@ -105,7 +100,7 @@ Random notes
- Consistently use the same naming convention for #include guards in headers: - Consistently use the same naming convention for #include guards in headers:
<PROJECTNAME>_<PATH_TO_FILE>_<FILE> <PROJECTNAME>_<PATH_TO_FILE>_<FILE>
This ensures that all #include guards are always unique and consistent. This ensures that all #include guards are always unique and consistent.
Examples: LIBSIGROK_LIBSIGROK_H, LIBSIGROK_HARDWARE_MIC_985XX_PROTOCOL_H Example: LIBSIGROK_HARDWARE_MIC_985XX_PROTOCOL_H
- Consistently use the same naming convention for API functions: - Consistently use the same naming convention for API functions:
<libprefix>_<groupname>_<action>(). <libprefix>_<groupname>_<action>().