Application notes code quality

All manufacturers of microcontrollers publish application notes. Some of these application notes are of course nothing more than gussied up advertising drivel. However, many of these application notes contain useful information that can cut days, and sometimes weeks off a project. Having read hundreds of these application notes over the 25 years I’ve been doing this, I’ve come to the conclusion that whereas the application notes usually get the algorithms correct, the same can’t be said for the code. Too often the code is sloppy, with bugs that are apparent merely by code inspection. May be it’s just me, but whenever I see a sloppy piece of code, it makes me wonder about the underlying quality of the IC design.

I think this is unfortunate, since the manufacturer’s could do much to improve things in the industry by setting a great example. To this end, I think they should:

  1. Adopt a set of coding standards that all their code adheres to.
  2. Have the code reviewed, such that egregious bugs are caught.
  3. Make the code Lint free
  4. If they are aiming the product at the automotive industry, ensure it is MISRA C compliant.

The advantages to the IC manufacturer are legion:

  1. They look good (never a bad thing)
  2. All their application note code has the same “look and feel”. This encourages engineers to use their application notes, and hence their products.
  3. The code in the application note is usable “as is”, speeding time to market and generally giving the perception that their product is easy to use.
  4. Less experienced engineers are taught how to do things correctly – which presumably leads to higher quality products- which presumably translates into more sales.

I guess the thing that I find maddening about this, is that the manufacturers probably spend weeks or months developing the application note, and then let themselves down by presenting their solution in such a poor way. When I talk to the marketing folks for the CPU manufacturers, I make a point of bringing some of the more egregious errors to their attention. Perhaps if all of us did this, we could get a bit of a sea change in the industry.

1 thought on “Application notes code quality

Leave a Reply

Your email address will not be published. Required fields are marked *