1 -------------------------------------------------------------------------------
3 -------------------------------------------------------------------------------
8 This project is programmed using the Linux kernel coding style, see
9 http://lxr.linux.no/linux/Documentation/CodingStyle for details.
11 Please use the same style for any code contributions, thanks!
17 - Patches should be sent to the development mailinglist at
18 sigrok-devel@lists.sourceforge.net (please subscribe to the list first).
20 https://lists.sourceforge.net/lists/listinfo/sigrok-devel
22 - Alternatively, you can also clone the git repository and let us know
23 from where to pull/review your changes. You can use gitorious.org,
24 github.com, or any other public git hosting site.
27 Adding a new hardware driver
28 ----------------------------
30 The simple, scripted way (recommended):
31 ---------------------------------------
33 Use the 'new-driver' script from the sigrok-util repo:
35 $ git clone git://sigrok.org/sigrok-util
36 $ cd sigrok-util/source
37 $ ./new-driver "Tondaj SL-814"
39 The example above generates a patch file against the current libsigrok
40 development git tree which adds a simple "stub" driver for your device
41 (the Tondaj SL-814 sound level meter in this case).
43 You can apply it like this:
46 $ git am 0001-tondaj-sl-814-Initial-driver-skeleton.patch
48 You can now edit the files in src/hardware/tondaj-sl-814 as needed
49 and implement your driver based on the skeleton files there. That means your
50 patch submission later will consist of at least two patches: the initial one
51 adding the skeleton driver, and one or more additional patches that actually
52 implement the respective driver code.
58 This is a rough overview of what you need to do in order to add a new driver
59 (using the Tondaj SL-814 device as example). It's basically what the
60 'new-driver' script (see above) does for you:
62 - Makefile.am: Add HW_TONDAJ_SL_814 and add to libsigrok_la_SOURCES.
63 - configure.ac: Add a DRIVER() and DRIVER2() call.
64 - src/drivers.c: Add a tondaj_sl_814_driver_info entry in two places.
65 - src/hardware/tondaj-sl-814/ directory: Add api.c, protocol.c, protocol.h.
67 See existing drivers or the 'new-driver' output for the details.
73 - Don't do variable declarations in compound statements, only at the
74 beginning of a function.
76 - Generally avoid assigning values to variables at declaration time,
77 especially so for complex and/or run-time dependent values.
79 - Consistently use g_try_malloc() / g_try_malloc0(). Do not use standard
80 malloc()/calloc() if it can be avoided (sometimes other libs such
81 as libftdi can return malloc()'d memory, for example).
83 - Always properly match allocations with the proper *free() functions. If
84 glib's g_try_malloc()/g_try_malloc0() was used, use g_free() to free the
85 memory. Otherwise use standard free(). Never use the wrong function!
87 - Never use g_malloc() or g_malloc0(). These functions do not return NULL
88 if not enough memory is available but rather lead to an exit() or segfault
89 instead. This behaviour is not acceptable for libraries.
90 Use g_try_malloc()/g_try_malloc0() instead and check the return value.
92 - You should never print any messages (neither to stdout nor stderr nor
93 elsewhere) "manually" via e.g. printf() or g_log() or similar functions.
94 Only sr_err()/sr_warn()/sr_info()/sr_dbg()/sr_spew() should be used.
96 - Use glib's gboolean / TRUE / FALSE for boolean types consistently.
97 Do not use <stdbool.h> and its true / false, and do not invent private
98 definitions for this either.
100 - Consistently use the same naming convention for #include guards in headers:
101 <PROJECTNAME>_<PATH_TO_FILE>_<FILE>
102 This ensures that all #include guards are always unique and consistent.
103 Example: LIBSIGROK_HARDWARE_MIC_985XX_PROTOCOL_H
105 - Consistently use the same naming convention for API functions:
106 <libprefix>_<groupname>_<action>().
109 sr_log_loglevel_set(), sr_log_loglevel_get(), sr_log_handler_set(),
110 sr_log_handler_set_default(), and so on.
112 sr_session_new(), sr_session_destroy(), sr_session_load(), and so on.
114 Getter/setter function names should usually end with "_get" or "_set".
115 Functions creating new "objects" should end with "_new".
116 Functions destroying "objects" should end with "_destroy".
117 Functions adding or removing items (e.g. from lists) should end with
118 either "_add" or "_remove".
119 Functions operating on all items from a list (not on only one of them),
120 should end with "_all", e.g. "_remove_all", "_get_all", and so on.
121 Use "_remove_all" in favor of "_clear" for consistency.
123 - All enums should generally use an explicit start number of 10000.
124 If there are multiple "categories" in the enum entries, each category
125 should be 10000 entries apart from the next one. The start of categories
126 are thus 10000, 20000, 30000, and so on.
128 Adding items to an enum MUST always append to a "category", never add
129 items in the middle of a category. The order of items MUST NOT be changed.
130 Any of the above would break the ABI.
132 The enum item 0 is special and is used as terminator in some lists, thus
133 enums should not use this for "valid" entries (and start at 10000 instead).
139 - In Doxygen comments, put an empty line between the block of @param lines
140 and the final @return line. The @param lines themselves (if there is more
141 than one) are not separated by empty lines.
143 - Mark private functions (SR_PRIV) with /** @private */, so that Doxygen
144 doesn't include them in the output. Functions that are "static" anyway
145 don't need to be marked like this.
147 - Mark private variables/#defines with /** @cond PRIVATE */ and
148 /** @endcond */, so that Doxygen doesn't include them in the output.
149 Variables that are "static" don't need to be marked like this.
151 - Mark all public API functions (SR_API) with a @since tag which indicates
152 in which release the respective function was added (e.g. "@since 0.1.0").
154 If the function has existed before, but its API changed later, the @since
155 tag should mention only the release when the API last changed.
157 Example: The sr_foo() call was added in 0.1.0, but the API changed in
158 the later 0.2.0 release. The docs should read "@since 0.2.0" in that case.
160 Non-public functions (static ones, and those marked SR_PRIV) don't need
161 to have @since markers.
163 The @since tag should be the last one, i.e. it should come after @param,
164 @return, @see, and so on.
170 You can run the libsigrok testsuite using:
180 http://sigrok.org/wiki/Developers/Release_process
182 for a list of items that need to be done when releasing a new tarball.