]>
Commit | Line | Data |
---|---|---|
a2353f60 UH |
1 | ------------------------------------------------------------------------------- |
2 | HACKING | |
3 | ------------------------------------------------------------------------------- | |
4 | ||
5 | Coding style | |
6 | ------------ | |
7 | ||
8 | This project is programmed using the Linux kernel coding style, see | |
9 | http://lxr.linux.no/linux/Documentation/CodingStyle for details. | |
10 | ||
11 | Please use the same style for any code contributions, thanks! | |
12 | ||
13 | ||
14 | Contributions | |
15 | ------------- | |
16 | ||
4a94c27d UH |
17 | - In order to contribute you should ideally clone the git repository and |
18 | let us know (preferably via IRC, or via the mailing list) from where to | |
19 | pull/review your changes. You can use github.com, or any other public git | |
20 | hosting site. | |
21 | ||
22 | - Alternatively, patches can be sent to the development mailinglist at | |
a2353f60 UH |
23 | sigrok-devel@lists.sourceforge.net (please subscribe to the list first). |
24 | ||
25 | https://lists.sourceforge.net/lists/listinfo/sigrok-devel | |
26 | ||
a2353f60 | 27 | |
2bba3dd3 UH |
28 | Adding a new hardware driver |
29 | ---------------------------- | |
30 | ||
31 | The simple, scripted way (recommended): | |
32 | --------------------------------------- | |
33 | ||
34 | Use the 'new-driver' script from the sigrok-util repo: | |
35 | ||
36 | $ git clone git://sigrok.org/sigrok-util | |
37 | $ cd sigrok-util/source | |
38 | $ ./new-driver "Tondaj SL-814" | |
39 | ||
40 | The example above generates a patch file against the current libsigrok | |
41 | development git tree which adds a simple "stub" driver for your device | |
42 | (the Tondaj SL-814 sound level meter in this case). | |
43 | ||
44 | You can apply it like this: | |
45 | ||
46 | $ cd libsigrok | |
47 | $ git am 0001-tondaj-sl-814-Initial-driver-skeleton.patch | |
48 | ||
487c23fc | 49 | You can now edit the files in src/hardware/tondaj-sl-814 as needed |
ef1020f9 UH |
50 | and implement your driver based on the skeleton files there. That means your |
51 | patch submission later will consist of at least two patches: the initial one | |
52 | adding the skeleton driver, and one or more additional patches that actually | |
53 | implement the respective driver code. | |
2bba3dd3 UH |
54 | |
55 | ||
56 | The manual way: | |
57 | --------------- | |
58 | ||
59 | This is a rough overview of what you need to do in order to add a new driver | |
60 | (using the Tondaj SL-814 device as example). It's basically what the | |
61 | 'new-driver' script (see above) does for you: | |
62 | ||
487c23fc UH |
63 | - Makefile.am: Add HW_TONDAJ_SL_814 and add to libsigrok_la_SOURCES. |
64 | - configure.ac: Add a DRIVER() and DRIVER2() call. | |
65 | - src/drivers.c: Add a tondaj_sl_814_driver_info entry in two places. | |
66 | - src/hardware/tondaj-sl-814/ directory: Add api.c, protocol.c, protocol.h. | |
2bba3dd3 UH |
67 | |
68 | See existing drivers or the 'new-driver' output for the details. | |
69 | ||
70 | ||
a2353f60 UH |
71 | Random notes |
72 | ------------ | |
73 | ||
ef1020f9 UH |
74 | - Don't do variable declarations in compound statements, only at the |
75 | beginning of a function. | |
76 | ||
77 | - Generally avoid assigning values to variables at declaration time, | |
78 | especially so for complex and/or run-time dependent values. | |
79 | ||
c7e45562 | 80 | - Consistently use g_*malloc() / g_*malloc0(). Do not use standard |
a2353f60 UH |
81 | malloc()/calloc() if it can be avoided (sometimes other libs such |
82 | as libftdi can return malloc()'d memory, for example). | |
83 | ||
84 | - Always properly match allocations with the proper *free() functions. If | |
c7e45562 | 85 | glib's g_*malloc()/g_*malloc0() was used, use g_free() to free the |
a2353f60 UH |
86 | memory. Otherwise use standard free(). Never use the wrong function! |
87 | ||
c7e45562 UH |
88 | - We assume that "small" memory allocations (< 1MB) will always succeed. |
89 | Thus, it's fine to use g_malloc() or g_malloc0() for allocations of | |
90 | simple/small structs and such (instead of using g_try_malloc()), and | |
91 | there's no need to check the return value. | |
92 | ||
93 | Do use g_try_malloc() or g_try_malloc0() for large (>= 1MB) allocations | |
94 | and check the return value. | |
a2353f60 | 95 | |
8ed26250 | 96 | - You should never print any messages (neither to stdout nor stderr nor |
a2353f60 UH |
97 | elsewhere) "manually" via e.g. printf() or g_log() or similar functions. |
98 | Only sr_err()/sr_warn()/sr_info()/sr_dbg()/sr_spew() should be used. | |
99 | ||
100 | - Use glib's gboolean / TRUE / FALSE for boolean types consistently. | |
101 | Do not use <stdbool.h> and its true / false, and do not invent private | |
102 | definitions for this either. | |
103 | ||
104 | - Consistently use the same naming convention for #include guards in headers: | |
105 | <PROJECTNAME>_<PATH_TO_FILE>_<FILE> | |
106 | This ensures that all #include guards are always unique and consistent. | |
487c23fc | 107 | Example: LIBSIGROK_HARDWARE_MIC_985XX_PROTOCOL_H |
a2353f60 UH |
108 | |
109 | - Consistently use the same naming convention for API functions: | |
110 | <libprefix>_<groupname>_<action>(). | |
111 | ||
112 | Examples: | |
113 | sr_log_loglevel_set(), sr_log_loglevel_get(), sr_log_handler_set(), | |
114 | sr_log_handler_set_default(), and so on. | |
115 | Or: | |
116 | sr_session_new(), sr_session_destroy(), sr_session_load(), and so on. | |
117 | ||
118 | Getter/setter function names should usually end with "_get" or "_set". | |
119 | Functions creating new "objects" should end with "_new". | |
120 | Functions destroying "objects" should end with "_destroy". | |
121 | Functions adding or removing items (e.g. from lists) should end with | |
122 | either "_add" or "_remove". | |
123 | Functions operating on all items from a list (not on only one of them), | |
124 | should end with "_all", e.g. "_remove_all", "_get_all", and so on. | |
125 | Use "_remove_all" in favor of "_clear" for consistency. | |
126 | ||
f18297a5 UH |
127 | - All enums should generally use an explicit start number of 10000. |
128 | If there are multiple "categories" in the enum entries, each category | |
129 | should be 10000 entries apart from the next one. The start of categories | |
130 | are thus 10000, 20000, 30000, and so on. | |
131 | ||
132 | Adding items to an enum MUST always append to a "category", never add | |
133 | items in the middle of a category. The order of items MUST NOT be changed. | |
134 | Any of the above would break the ABI. | |
135 | ||
136 | The enum item 0 is special and is used as terminator in some lists, thus | |
137 | enums should not use this for "valid" entries (and start at 10000 instead). | |
138 | ||
b4bd7088 UH |
139 | |
140 | Doxygen | |
141 | ------- | |
142 | ||
a2353f60 UH |
143 | - In Doxygen comments, put an empty line between the block of @param lines |
144 | and the final @return line. The @param lines themselves (if there is more | |
145 | than one) are not separated by empty lines. | |
146 | ||
b4bd7088 UH |
147 | - Mark private functions (SR_PRIV) with /** @private */, so that Doxygen |
148 | doesn't include them in the output. Functions that are "static" anyway | |
149 | don't need to be marked like this. | |
150 | ||
151 | - Mark private variables/#defines with /** @cond PRIVATE */ and | |
152 | /** @endcond */, so that Doxygen doesn't include them in the output. | |
153 | Variables that are "static" don't need to be marked like this. | |
154 | ||
9fb5f2df | 155 | - Mark all public API functions (SR_API) with a @since tag which indicates |
ef1020f9 UH |
156 | in which release the respective function was added (e.g. "@since 0.1.0"). |
157 | ||
158 | If the function has existed before, but its API changed later, the @since | |
159 | tag should mention only the release when the API last changed. | |
160 | ||
161 | Example: The sr_foo() call was added in 0.1.0, but the API changed in | |
162 | the later 0.2.0 release. The docs should read "@since 0.2.0" in that case. | |
9fb5f2df UH |
163 | |
164 | Non-public functions (static ones, and those marked SR_PRIV) don't need | |
165 | to have @since markers. | |
166 | ||
167 | The @since tag should be the last one, i.e. it should come after @param, | |
168 | @return, @see, and so on. | |
169 | ||
a2353f60 | 170 | |
79bb0e97 UH |
171 | Testsuite |
172 | --------- | |
173 | ||
174 | You can run the libsigrok testsuite using: | |
175 | ||
176 | $ make check | |
177 | ||
178 | ||
a2353f60 UH |
179 | Release engineering |
180 | ------------------- | |
181 | ||
182 | See | |
183 | ||
184 | http://sigrok.org/wiki/Developers/Release_process | |
185 | ||
186 | for a list of items that need to be done when releasing a new tarball. | |
187 |