Changeset be67118 in mainline


Ignore:
Timestamp:
2012-07-21T13:44:49Z (12 years ago)
Author:
Martin Decky <martin@…>
Branches:
lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export
Children:
fb7e545e
Parents:
6de2d766
Message:

improve documentation

File:
1 edited

Legend:

Unmodified
Added
Removed

  • abi/include/ddi/irq.h

    r6de2d766 rbe67118  
    4242
    4343typedef enum {
    44         /** Read 1 byte from the I/O space. */
     44        /** Read 1 byte from the I/O space.
     45         *
     46         * *addr(8) -> scratch[dstarg]
     47         */
    4548        CMD_PIO_READ_8 = 1,
    46         /** Read 2 bytes from the I/O space. */
     49       
     50        /** Read 2 bytes from the I/O space.
     51         *
     52         * *addr(16) -> scratch[dstarg]
     53         */
    4754        CMD_PIO_READ_16,
    48         /** Read 4 bytes from the I/O space. */
     55       
     56        /** Read 4 bytes from the I/O space.
     57         *
     58         * *addr(32) -> scratch[dstarg]
     59         */
    4960        CMD_PIO_READ_32,
    5061       
    51         /** Write 1 byte to the I/O space. */
     62        /** Write 1 byte to the I/O space.
     63         *
     64         * value(8) -> *addr
     65         */
    5266        CMD_PIO_WRITE_8,
    53         /** Write 2 bytes to the I/O space. */
     67       
     68        /** Write 2 bytes to the I/O space.
     69         *
     70         * value(16) -> *addr
     71         */
    5472        CMD_PIO_WRITE_16,
    55         /** Write 4 bytes to the I/O space. */
     73       
     74        /** Write 4 bytes to the I/O space.
     75         *
     76         * value(32) -> *addr
     77         */
    5678        CMD_PIO_WRITE_32,
    5779       
    58         /**
    59          * Write 1 byte from the source argument
    60          * to the I/O space.
     80        /** Write 1 byte to the I/O space.
     81         *
     82         * scratch[srcarg](8) -> *addr
    6183         */
    6284        CMD_PIO_WRITE_A_8,
    63         /**
    64          * Write 2 bytes from the source argument
    65          * to the I/O space.
     85       
     86        /** Write 2 bytes to the I/O space.
     87         *
     88         * scratch[srcarg](16) -> *addr
    6689         */
    6790        CMD_PIO_WRITE_A_16,
    68         /**
    69          * Write 4 bytes from the source argument
    70          * to the I/O space.
     91       
     92        /** Write 4 bytes to the I/O space.
     93         *
     94         * scratch[srcarg](32) -> *addr
    7195         */
    7296        CMD_PIO_WRITE_A_32,
    … …  
    78102        CMD_BTEST,
    79103       
    80         /**
    81          * Predicate the execution of the following
    82          * N commands by the boolean value of the source
    83          * argument.
     104        /** Predicate the execution of the following commands.
     105         *
     106         * if (scratch[srcarg] == 0)
     107         *  (skip the following 'value' commands)
    84108         */
    85109        CMD_PREDICATE,
Note: See TracChangeset for help on using the changeset viewer.