Subversion Repositories HelenOS

Rev

Rev 4350 | Rev 4714 | Go to most recent revision | Blame | Compare with Previous | Last modification | View Log | Download | RSS feed

  1. /*
  2.  * Copyright (c) 2009 Lukas Mejdrech
  3.  * All rights reserved.
  4.  *
  5.  * Redistribution and use in source and binary forms, with or without
  6.  * modification, are permitted provided that the following conditions
  7.  * are met:
  8.  *
  9.  * - Redistributions of source code must retain the above copyright
  10.  *   notice, this list of conditions and the following disclaimer.
  11.  * - Redistributions in binary form must reproduce the above copyright
  12.  *   notice, this list of conditions and the following disclaimer in the
  13.  *   documentation and/or other materials provided with the distribution.
  14.  * - The name of the author may not be used to endorse or promote products
  15.  *   derived from this software without specific prior written permission.
  16.  *
  17.  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18.  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20.  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21.  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22.  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23.  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24.  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25.  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26.  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27.  */
  28.  
  29. /** @addtogroup net
  30.  *  @{
  31.  */
  32.  
  33. /** @file
  34.  *  Generic module skeleton implementation.
  35.  */
  36.  
  37. #include <async.h>
  38. #include <stdio.h>
  39. #include <task.h>
  40.  
  41. #include <ipc/ipc.h>
  42.  
  43. #include "err.h"
  44.  
  45. /** External message processing function.
  46.  *  Should process the messages.
  47.  *  The function has to be defined in each module.
  48.  *  @param callid The message identifier. Input parameter.
  49.  *  @param call The message parameters. Input parameter.
  50.  *  @param answer The message answer parameters. Output parameter.
  51.  *  @param answer_count The last parameter for the actual answer in the answer parameter. Output parameter.
  52.  *  @returns EOK on success.
  53.  *  @returns ENOTSUP if the message is not known.
  54.  *  @returns Other error codes as defined for each specific module message function.
  55.  */
  56. extern int  module_message( ipc_callid_t callid, ipc_call_t * call, ipc_call_t * answer, int * answer_count );
  57.  
  58. /** External function to print the module name.
  59.  *  Should print the module name.
  60.  *  The function has to be defined in each module.
  61.  */
  62. extern void module_print_name( void );
  63.  
  64. /** External module startup function.
  65.  *  Should start and initialize the module and register the given client connection function.
  66.  *  The function has to be defined in each module.
  67.  *  @param client_connection The client connection functio to be registered. Input parameter.
  68.  */
  69. extern int  module_start( async_client_conn_t client_connection );
  70.  
  71. /** Default thread for new connections.
  72.  *  @param iid The initial message identifier. Input parameter.
  73.  *  @param icall The initial message call structure. Input parameter.
  74.  */
  75. void    client_connection( ipc_callid_t iid, ipc_call_t * icall );
  76.  
  77. /** Starts the module.
  78.  *  @param argc The count of the command line arguments. Ignored parameter.
  79.  *  @param argv The command line parameters. Ignored parameter.
  80.  *  @returns EOK on success.
  81.  *  @returns Other error codes as defined for each specific module start function.
  82.  */
  83. int main( int argc, char * argv[] );
  84.  
  85. void client_connection( ipc_callid_t iid, ipc_call_t * icall ){
  86.     ipc_callid_t    callid;
  87.     ipc_call_t  call;
  88.     ipc_call_t  answer;
  89.     int     count;
  90.     int     res;
  91.  
  92.     /*
  93.      * Accept the connection
  94.      *  - Answer the first IPC_M_CONNECT_ME_TO call.
  95.      */
  96.     ipc_answer_0( iid, EOK );
  97.  
  98.     while( true ){
  99.         // refresh data
  100.         count = 0;
  101.         IPC_SET_RETVAL( answer, 0 );
  102.         // just to be precize
  103.         IPC_SET_METHOD( answer, 0 );
  104.         IPC_SET_ARG1( answer, 0 );
  105.         IPC_SET_ARG2( answer, 0 );
  106.         IPC_SET_ARG3( answer, 0 );
  107.         IPC_SET_ARG4( answer, 0 );
  108.         IPC_SET_ARG5( answer, 0 );
  109.  
  110.         callid = async_get_call( & call );
  111.         res = module_message( callid, & call, & answer, & count );
  112.  
  113.         switch( count ){
  114.             case 0:     ipc_answer_0( callid, res );
  115.                     continue;
  116.             case 1:     ipc_answer_1( callid, res, IPC_GET_ARG1( answer ));
  117.                     continue;
  118.             case 2:     ipc_answer_2( callid, res, IPC_GET_ARG1( answer ), IPC_GET_ARG2( answer ));
  119.                     continue;
  120.             case 3:     ipc_answer_3( callid, res, IPC_GET_ARG1( answer ), IPC_GET_ARG2( answer ), IPC_GET_ARG3( answer ));
  121.                     continue;
  122.             case 4:     ipc_answer_4( callid, res, IPC_GET_ARG1( answer ), IPC_GET_ARG2( answer ), IPC_GET_ARG3( answer ), IPC_GET_ARG4( answer ));
  123.                     continue;
  124.             default:    ipc_answer_5( callid, res, IPC_GET_ARG1( answer ), IPC_GET_ARG2( answer ), IPC_GET_ARG3( answer ), IPC_GET_ARG4( answer ), IPC_GET_ARG5( answer ));
  125.                     continue;
  126.         }
  127.     }
  128. }
  129.  
  130. int main( int argc, char * argv[] ){
  131.     ERROR_DECLARE;
  132.  
  133.     printf("Task %d - ", task_get_id());
  134.     module_print_name();
  135.     printf( "\n" );
  136.     if( ERROR_OCCURRED( module_start( client_connection ))){
  137.         printf( " - ERROR %i\n", ERROR_CODE );
  138.         return ERROR_CODE;
  139.     }
  140.     return EOK;
  141. }
  142.  
  143. /** @}
  144.  */
  145.