Subversion Repositories HelenOS

Rev

Rev 4577 | 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. /** @name External module functions.
  46.  *  This functions have to be implemented in every module.
  47.  */
  48. /*@{*/
  49.  
  50. /** External message processing function.
  51.  *  Should process the messages.
  52.  *  The function has to be defined in each module.
  53.  *  @param callid The message identifier. Input parameter.
  54.  *  @param call The message parameters. Input parameter.
  55.  *  @param answer The message answer parameters. Output parameter.
  56.  *  @param answer_count The last parameter for the actual answer in the answer parameter. Output parameter.
  57.  *  @returns EOK on success.
  58.  *  @returns ENOTSUP if the message is not known.
  59.  *  @returns Other error codes as defined for each specific module message function.
  60.  */
  61. extern int  module_message( ipc_callid_t callid, ipc_call_t * call, ipc_call_t * answer, int * answer_count );
  62.  
  63. /** External function to print the module name.
  64.  *  Should print the module name.
  65.  *  The function has to be defined in each module.
  66.  */
  67. extern void module_print_name( void );
  68.  
  69. /** External module startup function.
  70.  *  Should start and initialize the module and register the given client connection function.
  71.  *  The function has to be defined in each module.
  72.  *  @param client_connection The client connection function to be registered. Input parameter.
  73.  */
  74. extern int  module_start( async_client_conn_t client_connection );
  75.  
  76. /*@}*/
  77.  
  78. /** Default thread for new connections.
  79.  *  @param iid The initial message identifier. Input parameter.
  80.  *  @param icall The initial message call structure. Input parameter.
  81.  */
  82. void    client_connection( ipc_callid_t iid, ipc_call_t * icall );
  83.  
  84. /** Starts the module.
  85.  *  @param argc The count of the command line arguments. Ignored parameter.
  86.  *  @param argv The command line parameters. Ignored parameter.
  87.  *  @returns EOK on success.
  88.  *  @returns Other error codes as defined for each specific module start function.
  89.  */
  90. int main( int argc, char * argv[] );
  91.  
  92. void client_connection( ipc_callid_t iid, ipc_call_t * icall ){
  93.     ipc_callid_t    callid;
  94.     ipc_call_t  call;
  95.     ipc_call_t  answer;
  96.     int     count;
  97.     int     res;
  98.  
  99.     /*
  100.      * Accept the connection
  101.      *  - Answer the first IPC_M_CONNECT_ME_TO call.
  102.      */
  103.     ipc_answer_0( iid, EOK );
  104.  
  105.     while( true ){
  106.         // refresh data
  107.         count = 0;
  108.         IPC_SET_RETVAL( answer, 0 );
  109.         // just to be precize
  110.         IPC_SET_METHOD( answer, 0 );
  111.         IPC_SET_ARG1( answer, 0 );
  112.         IPC_SET_ARG2( answer, 0 );
  113.         IPC_SET_ARG3( answer, 0 );
  114.         IPC_SET_ARG4( answer, 0 );
  115.         IPC_SET_ARG5( answer, 0 );
  116.  
  117.         callid = async_get_call( & call );
  118.         res = module_message( callid, & call, & answer, & count );
  119.  
  120.         switch( count ){
  121.             case 0:     ipc_answer_0( callid, res );
  122.                     continue;
  123.             case 1:     ipc_answer_1( callid, res, IPC_GET_ARG1( answer ));
  124.                     continue;
  125.             case 2:     ipc_answer_2( callid, res, IPC_GET_ARG1( answer ), IPC_GET_ARG2( answer ));
  126.                     continue;
  127.             case 3:     ipc_answer_3( callid, res, IPC_GET_ARG1( answer ), IPC_GET_ARG2( answer ), IPC_GET_ARG3( answer ));
  128.                     continue;
  129.             case 4:     ipc_answer_4( callid, res, IPC_GET_ARG1( answer ), IPC_GET_ARG2( answer ), IPC_GET_ARG3( answer ), IPC_GET_ARG4( answer ));
  130.                     continue;
  131.             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 ));
  132.                     continue;
  133.         }
  134.     }
  135. }
  136.  
  137. int main( int argc, char * argv[] ){
  138.     ERROR_DECLARE;
  139.  
  140.     printf("Task %d - ", task_get_id());
  141.     module_print_name();
  142.     printf( "\n" );
  143.     if( ERROR_OCCURRED( module_start( client_connection ))){
  144.         printf( " - ERROR %i\n", ERROR_CODE );
  145.         return ERROR_CODE;
  146.     }
  147.     return EOK;
  148. }
  149.  
  150. /** @}
  151.  */
  152.