HACKING

   1 -------------------------------------------------------------------------------
   2 HACKING
   3 -------------------------------------------------------------------------------
   4
   5 Coding style
   6 ------------
   7
   8 This project is programmed using the Linux kernel coding style:
   9
  10   https://www.kernel.org/doc/html/latest/process/coding-style.html
  11
  12 Please use the same style for any code contributions, thanks!
  13
  14 The Python decoders should follow the usual Python conventions and use
  15 Python idioms as far as it makes sense. The coding style should mostly follow
  16 the Python PEP-8, which includes the convention of 4 spaces for indentation:
  17
  18   http://www.python.org/dev/peps/pep-0008/
  19
  20 Exceptions:
  21
  22  - All strings should use single quotes ('foo' instead of "foo").
  23
  24  - No double-newlines between methods (or anywhere else).
  25
  26
  27 Contributions
  28 -------------
  29
  30  - In order to contribute you should ideally clone the git repository and
  31    let us know (preferably via IRC, or via the mailing list) from where to
  32    pull/review your changes. You can use github.com, or any other public git
  33    hosting site.
  34
  35  - Alternatively, patches can be sent to the development mailinglist at
  36    sigrok-devel@lists.sourceforge.net (please subscribe to the list first).
  37
  38    https://lists.sourceforge.net/lists/listinfo/sigrok-devel
  39
  40
  41 Random notes
  42 ------------
  43
  44  - Don't do variable declarations in compound statements, only at the
  45    beginning of a function.
  46
  47  - Generally avoid assigning values to variables at declaration time,
  48    especially so for complex and/or run-time dependent values.
  49
  50  - Consistently use g_*malloc() / g_*malloc0(). Do not use standard
  51    malloc()/calloc() if it can be avoided (sometimes other libs such
  52    as libftdi can return malloc()'d memory, for example).
  53
  54  - Always properly match allocations with the proper *free() functions. If
  55    glib's g_*malloc()/g_*malloc0() was used, use g_free() to free the
  56    memory. Otherwise use standard free(). Never use the wrong function!
  57
  58  - We assume that "small" memory allocations (< 1MB) will always succeed.
  59    Thus, it's fine to use g_malloc() or g_malloc0() for allocations of
  60    simple/small structs and such (instead of using g_try_malloc()), and
  61    there's no need to check the return value.
  62
  63    Do use g_try_malloc() or g_try_malloc0() for large (>= 1MB) allocations
  64    and check the return value.
  65
  66  - You should never print any messages (neither to stdout nor stderr nor
  67    elsewhere) "manually" via e.g. printf() or g_log() or similar functions.
  68    Only srd_err()/srd_warn()/srd_info()/srd_dbg()/srd_spew() should be used.
  69
  70  - Use glib's gboolean / TRUE / FALSE for boolean types consistently.
  71    Do not use <stdbool.h> and its true / false, and do not invent private
  72    definitions for this either.
  73
  74  - Consistently use the same naming convention for #include guards in headers:
  75    <PROJECTNAME>_<PATH_TO_FILE>_<FILE>
  76    This ensures that all #include guards are always unique and consistent.
  77    Example: LIBSIGROKDECODE_LIBSIGROKDECODE_INTERNAL_H
  78
  79  - Consistently use the same naming convention for API functions:
  80    <libprefix>_<groupname>_<action>().
  81
  82    Examples:
  83      srd_log_loglevel_set(), srd_log_loglevel_get(), srd_log_handler_set(),
  84      srd_log_handler_set_default(), and so on.
  85
  86    Getter/setter function names should usually end with "_get" or "_set".
  87    Functions creating new "objects" should end with "_new".
  88    Functions destroying "objects" should end with "_destroy".
  89    Functions adding or removing items (e.g. from lists) should end with
  90    either "_add" or "_remove".
  91    Functions operating on all items from a list (not on only one of them),
  92    should end with "_all", e.g. "_remove_all", "_get_all", and so on.
  93    Use "_remove_all" in favor of "_clear" for consistency.
  94
  95  - All enums should generally use an explicit start number of 10000.
  96    If there are multiple "categories" in the enum entries, each category
  97    should be 10000 entries apart from the next one. The start of categories
  98    are thus 10000, 20000, 30000, and so on.
  99
 100    Adding items to an enum MUST always append to a "category", never add
 101    items in the middle of a category. The order of items MUST NOT be changed.
 102    Any of the above would break the ABI.
 103
 104    The enum item 0 is special and is used as terminator in some lists, thus
 105    enums should not use this for "valid" entries (and start at 10000 instead).
 106
 107
 108 Doxygen
 109 -------
 110
 111  - In Doxygen comments, put an empty line between the block of @param lines
 112    and the final @return line. The @param lines themselves (if there is more
 113    than one) are not separated by empty lines.
 114
 115  - Mark private functions (SRD_PRIV) with /** @private */, so that Doxygen
 116    doesn't include them in the output. Functions that are "static" anyway
 117    don't need to be marked like this.
 118
 119  - Mark private variables/#defines with /** @cond PRIVATE */ and
 120    /** @endcond */, so that Doxygen doesn't include them in the output.
 121    Variables that are "static" don't need to be marked like this.
 122
 123  - Mark all public API functions (SRD_API) with a @since tag which indicates
 124    in which release the respective function was added (e.g. "@since 0.1.0").
 125
 126    If the function has existed before, but its API changed later, the @since
 127    tag should mention only the release when the API last changed.
 128
 129    Example: The srd_foo() call was added in 0.1.0, but the API changed in
 130    the later 0.2.0 release. The docs should read "@since 0.2.0" in that case.
 131
 132    Non-public functions (static ones, and those marked SRD_PRIV) don't need
 133    to have @since markers.
 134
 135    The @since tag should be the last one, i.e. it should come after @param,
 136    @return, @see, and so on.
 137
 138
 139 Protocol decoder guidelines
 140 ---------------------------
 141
 142  - The 'desc' metadata field for a protocol decoder, which contains a
 143    short, one-line description of the protocol/bus, should be at most 55
 144    characters long, and end with a full stop. This short description can be
 145    displayed on the command-line using "sigrok-cli -V -l 3", or in various
 146    different places in GUIs.
 147
 148  - Longer, multi-line descriptions should be placed in the protocol
 149    decoder's __init__.py file as docstring. It can be viewed (for a specific
 150    protocol decoder, e.g., UART) via "sigrok-cli -P uart --show", or in various
 151    other places in GUIs.
 152
 153  - Input IDs, output IDs, tags, channel IDs, option IDs, annotation class IDs,
 154    annotation row IDs, and binary class IDs each must be unique.
 155
 156  - Annotation class IDs must not overlap with annotation row IDs.
 157    For example, you cannot have an annotation row named "foo" if you already
 158    have an annotation class named "foo". This avoids confusion for users
 159    and simplifies e.g. command-line usage of decoders.
 160
 161  - Annotation class IDs should generally be singular, annotation row IDs
 162    should generally be plural. Example: UART annotation classes could be
 163    named "stop-bit" or "parity-bit" (singular), the annotation row containing
 164    these annotation classes could be named "bits" (plural).
 165
 166  - Generally use strings for states (of the PD state machine), not integers.
 167    This avoids having to keep a list of state definitions at the top of file.
 168    The performance overhead for this is negligible in practice.
 169
 170    Recommended:
 171      self.state = 'IDLE'
 172      self.state = 'GET STOP BIT'
 173    Not recommended:
 174      self.state = IDLE
 175      self.state = GET_STOP_BIT
 176      (where IDLE = 0 and GET_STOP_BIT = 1, for example)
 177
 178  - Generally use strings for commands/IDs in generated protocol packets.
 179    This avoids having to know magic numbers of the PD in higher-level PDs.
 180    The performance overhead for this is negligible in practice.
 181
 182    Recommended:
 183      self.put(x, y, p, ['STOPBIT', 0, 0])
 184      self.put(x, y, p, ['ADDRESS READ', 0x51])
 185    Not recommended:
 186      self.put(x, y, p, [STOPBIT, 0, 0])
 187      self.put(x, y, p, [ADDRESS_READ, 0x51])
 188      (with STOPBIT = 3 and ADDRESS_READ = 7, for example)
 189
 190  - Use ALL-CAPS names for PD states and protocol packet commands/ID.
 191    Words should be separated by spaces (not underscores or the like).
 192
 193    Recommended:
 194      'FIND ADDRESS', 'GET TEMPERATURE', 'START'
 195    Not recommended:
 196      'FIND_ADDRESS', 'Get Temperature', 'start'
 197
 198  - Protocol decoder tags:
 199
 200    - Every decoder must have a "tags" list (>= 1 items, alphabetically sorted).
 201
 202    - All tag names start with a capital letter. Subsequent words of the name
 203      are not capitalized, e.g. "Retro computing", "Debug/trace".
 204
 205    - All tag names should use singular form ("Sensor", not "Sensors").
 206
 207    Common tags:
 208
 209    - Analog/digital: Decoders related A/D conversion, e.g. ADCs and DACs.
 210    - Audio: Decoders related to audio protocols, e.g. I²S, S/PDIF.
 211    - Automotive: Decoders related to automotive protocols, e.g. CAN, FlexRay.
 212    - Clock/timing: Decoders related to time keeping, timing, and clocks/RTCs.
 213    - Debug/trace: Decoders related to microcontroller/CPU debugging, tracing,
 214      programming/flashing protocols, e.g. SWD, JTAG, AVR ISP, ARM ETMv3.
 215    - Display: Decoders related to display technologies, e.g. DVI, HDMI,
 216      TFT, OLED, LCD, HD44780, EDID, and various LED protocols.
 217    - Embedded/industrial: Decoders related to protocols used in embedded
 218      systems, industrial systems, or automation (e.g. SPI, Modbus, Profibus).
 219    - Encoding: Decoders related to generic encoding / line coding systems,
 220      e.g. Manchester, Miller, Gray code, OOK, and similar.
 221    - IC: Decoders for specific (families of) ICs (i.e. not IC-independent,
 222      generic protocols like UART, SPI, CAN, or USB).
 223    - IR: Decoders related to infrared (e.g. remote control) protocols.
 224    - Lighting: Decoders related to lighting technologies, e.g. DALI, DMX512.
 225    - Memory: Decoders related to memories (e.g. NOR/NAND flash, EEPROM,
 226      SDRAM, SRAM, various other volatile or non-volatile memories).
 227    - Networking: Decoders related to (wired) networking technologies.
 228    - PC: Decoders related to protocols used in personal computers (desktop,
 229      workstation, laptop, server). This is not meant to be restricted to
 230      "IBM PC" or "x86/Intel", Apple/Commodore/Atari/SPARC etc. are fine too.
 231    - RFID: Decoders related to RFID protocols, e.g. EM4100, T55xx.
 232    - Retro computing: Decoders related to retro computing, e.g. MCS-48, Z80.
 233    - Security/crypto: Decoders related to security or cryptography.
 234    - Sensor: Decoders for sensors or all kinds, e.g. temperature or humidity.
 235    - Util: Random utility/helper decoders.
 236    - Wireless/RF: Decoders related to various wireless/RF technologies, e.g.
 237      Bluetooth, BLE, Wifi, or 2.4GHz/433MHz custom protocols.
 238
 239
 240 Testsuite
 241 ---------
 242
 243 You can run the libsigrokdecode testsuite using:
 244
 245  $ make check
 246
 247
 248 Protocol decoder test framework
 249 -------------------------------
 250
 251 Please see the sigrok-test repository for a protocol decoder test suite that
 252 checks the decoded data of various PDs against known-good reference data.
 253
 254
 255 Release engineering
 256 -------------------
 257
 258 See
 259
 260  http://sigrok.org/wiki/Developers/Release_process
 261
 262 for a list of items that need to be done when releasing a new tarball.
 263