Ignore:
Timestamp:
2008-09-24T07:56:00Z (16 years ago)
Author:
Jiri Svoboda <jirik.svoboda@…>
Branches:
lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export
Children:
45454e9b
Parents:
0dd0f71f
Message:

Document functions in udebug_ipc.c

File:
1 edited

Legend:

Unmodified
Added
Removed

  • kernel/generic/src/udebug/udebug_ipc.c

    r0dd0f71f r3926f30  
    6060}
    6161
     62/** Process a BEGIN call.
     63 *
     64 * Initiates a debugging session for the current task. The reply
     65 * to this call may or may not be sent before this function returns.
     66 *
     67 * @param call  The call structure.
     68 */
    6269static void udebug_receive_begin(call_t *call)
    6370{
    … …  
    7178        }
    7279
     80        /*
     81         * If the initialization of the debugging session has finished,
     82         * send a reply.
     83         */
    7384        if (rc != 0) {
    7485                IPC_SET_RETVAL(call->data, 0);
    … …  
    7788}
    7889
     90/** Process an END call.
     91 *
     92 * Terminates the debugging session for the current task.
     93 * @param call  The call structure.
     94 */
    7995static void udebug_receive_end(call_t *call)
    8096{
    … …  
    87103}
    88104
     105/** Process a SET_EVMASK call.
     106 *
     107 * Sets an event mask for the current debugging session.
     108 * @param call  The call structure.
     109 */
    89110static void udebug_receive_set_evmask(call_t *call)
    90111{
    … …  
    100121
    101122
     123/** Process a GO call.
     124 *
     125 * Resumes execution of the specified thread.
     126 * @param call  The call structure.
     127 */
    102128static void udebug_receive_go(call_t *call)
    103129{
    … …  
    115141}
    116142
     143/** Process a STOP call.
     144 *
     145 * Suspends execution of the specified thread.
     146 * @param call  The call structure.
     147 */
    117148static void udebug_receive_stop(call_t *call)
    118149{
    … …  
    127158}
    128159
     160/** Process a THREAD_READ call.
     161 *
     162 * Reads the list of hashes of the (userspace) threads in the current task.
     163 * @param call  The call structure.
     164 */
    129165static void udebug_receive_thread_read(call_t *call)
    130166{
    … …  
    177213}
    178214
     215/** Process an ARGS_READ call.
     216 *
     217 * Reads the argument of a current syscall event (SYSCALL_B or SYSCALL_E).
     218 * @param call  The call structure.
     219 */
    179220static void udebug_receive_args_read(call_t *call)
    180221{
    … …  
    210251}
    211252
     253/** Process an MEM_READ call.
     254 *
     255 * Reads memory of the current (debugged) task.
     256 * @param call  The call structure.
     257 */
    212258static void udebug_receive_mem_read(call_t *call)
    213259{
    … …  
    240286}
    241287
    242 /**
    243  * Handle a debug call received on the kernel answerbox.
    244  *
    245  * This is called by the kbox servicing thread.
     288/** Handle a debug call received on the kernel answerbox.
     289 *
     290 * This is called by the kbox servicing thread. Verifies that the sender
     291 * is indeed the debugger and calls the appropriate processing function.
    246292 */
    247293void udebug_call_receive(call_t *call)
Note: See TracChangeset for help on using the changeset viewer.