HACKING

   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
  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
  23    sigrok-devel@lists.sourceforge.net (please subscribe to the list first).
  24
  25    https://lists.sourceforge.net/lists/listinfo/sigrok-devel
  26
  27
  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
  49 You can now edit the files in src/hardware/tondaj-sl-814 as needed
  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.
  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
  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.
  67
  68 See existing drivers or the 'new-driver' output for the details.
  69
  70
  71 Random notes
  72 ------------
  73
  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
  80  - Consistently use g_*malloc() / g_*malloc0(). Do not use standard
  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
  85    glib's g_*malloc()/g_*malloc0() was used, use g_free() to free the
  86    memory. Otherwise use standard free(). Never use the wrong function!
  87
  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.
  95
  96  - You should never print any messages (neither to stdout nor stderr nor
  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.
 107    Example: LIBSIGROK_HARDWARE_MIC_985XX_PROTOCOL_H
 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
 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
 139
 140 Doxygen
 141 -------
 142
 143  - Use the @ notation for all Doxygen comments (e.g. @param, not \param).
 144
 145  - Do not use the @brief tag, it's unnecessary as we use JAVADOC_AUTOBRIEF.
 146
 147  - Generally use the following item order in Doxygen comments:
 148     - Brief function description (1 line), followed by an empty line.
 149     - Optionally, a longer function description (and another empty line).
 150     - The list of parameter descriptions (@param).
 151     - The return value description (@return or @retval).
 152     - An optional @since tag (only for public SR_API functions).
 153     - An optional @private tag (for private SR_PRIV functions).
 154
 155  - In @param lines, the name of the parameter is followed by a space and
 156    then a sentence describing the parameter (starts with a capital letter,
 157    ends with a full stop).
 158
 159  - In Doxygen comments, put an empty line between the block of @param lines
 160    and the final @return line. The @param lines themselves (if there is more
 161    than one) are not separated by empty lines.
 162
 163  - Mark private functions (SR_PRIV) with /** @private */, so that Doxygen
 164    doesn't include them in the output. Functions that are "static" anyway
 165    don't need to be marked like this.
 166
 167  - Mark private variables/#defines with /** @cond PRIVATE */ and
 168    /** @endcond */, so that Doxygen doesn't include them in the output.
 169    Variables that are "static" don't need to be marked like this.
 170
 171  - Mark all public API functions (SR_API) with a @since tag which indicates
 172    in which release the respective function was added (e.g. "@since 0.1.0").
 173
 174    If the function has existed before, but its API changed later, the @since
 175    tag should mention only the release when the API last changed.
 176
 177    Example: The sr_foo() call was added in 0.1.0, but the API changed in
 178    the later 0.2.0 release. The docs should read "@since 0.2.0" in that case.
 179
 180    Non-public functions (static ones, and those marked SR_PRIV) don't need
 181    to have @since markers.
 182
 183    The @since tag should be the last one, i.e. it should come after @param,
 184    @return, @see, and so on.
 185
 186  - Examples:
 187
 188 /**
 189  * Tell a hardware driver to scan for devices.
 190  *
 191  * In addition to the detection, the devices that are found are also
 192  * initialized automatically. On some devices, this involves a firmware upload,
 193  * or other such measures.
 194  *
 195  * The order in which the system is scanned for devices is not specified. The
 196  * caller should not assume or rely on any specific order.
 197  *
 198  * Before calling sr_driver_scan(), the user must have previously initialized
 199  * the driver by calling sr_driver_init().
 200  *
 201  * @param[in] driver The driver that should scan. Must be a pointer to one of
 202  *                   the entries returned by sr_driver_list(). Must not be NULL.
 203  * @param[in] options List of 'struct sr_hwopt' options to pass to the driver's
 204  *                    scanner. Can be NULL/empty.
 205  *
 206  * @return A GSList * of 'struct sr_dev_inst', or NULL if no devices were
 207  *         found (or errors were encountered). This list must be freed by the
 208  *         caller using g_slist_free(), but without freeing the data pointed
 209  *         to in the list.
 210  *
 211  * @since 0.2.0
 212  */
 213
 214 /**
 215  * Query value of a configuration key at the given driver or device instance.
 216  *
 217  * @param[in] driver The sr_dev_driver struct to query. Must not be NULL.
 218  * @param[in] sdi (optional) If the key is specific to a device, this must
 219  *            contain a pointer to the struct sr_dev_inst to be checked.
 220  *            Otherwise it must be NULL. If sdi is != NULL, sdi->priv must
 221  *            also be != NULL.
 222  * @param[in,out] data Pointer to a GVariant where the value will be stored.
 223  *             Must not be NULL. The caller is given ownership of the GVariant
 224  *             and must thus decrease the refcount after use. However if
 225  *             this function returns an error code, the field should be
 226  *             considered unused, and should not be unreferenced.
 227  *
 228  * @retval SR_OK Success.
 229  * @retval SR_ERR Error.
 230  * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be
 231  *         interpreted as an error by the caller; merely as an indication
 232  *         that it's not applicable.
 233  *
 234  * @since 0.3.0
 235  * @private
 236  */
 237
 238
 239 Testsuite
 240 ---------
 241
 242 You can run the libsigrok testsuite using:
 243
 244  $ make check
 245
 246
 247 Release engineering
 248 -------------------
 249
 250 See
 251
 252  http://sigrok.org/wiki/Developers/Release_process
 253
 254 for a list of items that need to be done when releasing a new tarball.
 255