Page 224 - The Art of Designing Embedded Systems
P. 224

A Firmware Standards Manual  21 1


                         *  argl               :  description
                         *  arg2               :  description
                         *  Created by         :  author’s name
                         *  Date created       :  date
                         *  Description        :  detailed description
                         *  Notes              :  restrictions, odd modes
                         ..................................................

                         The template for assembly modules is:



                           Module name:

                            Copyright 1997 Company as an unpublished work.
                           All Rights Reserved.

                            The information contained herein is confidential
                            property of Company. The use, copying, transfer
                            disclosure of such information is prohibited
                            except by express written agreement with Company.

                            First written on xxxxx by xxxx.


                            Module Description:
                            (fill in a detailed description of the module
                            here).

                          ..................................................
                         ; Include section
                         ; Add all ‘includes” here
                          ..................................................


                         The template includes a section defining the general layout of func-
                    tions, as follows:
                          ..................................................

                         ; Routine name        :  foobar
                         ; returns             :  return value(s) description
                         ; argl                :  description of arguments
                         ; arg2                :  description
   219   220   221   222   223   224   225   226   227   228   229