energy.c

软件无线电的平台

/***************************************************************************
 *    energy.c  - Calculates the energy of a slot.
 *                           -------------------
 *   begin                :  02/10/30
 *   authors              :  Linus Gasser
 *   emails               :  [e-mail]
 ***************************************************************************/

/***************************************************************************
 *                                Changes
 *                                -------
 * date - name - description
 * 02/10/30 - ineiti - begin
 * 04/03/06 - ineiti - adjusted description
 *
 **************************************************************************/

/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/


/**
 *  Sums up the square of the input-signal. It doesn't change the samples, so
 *  they are just passed along.
 */

#include "spc.h"
#define DBG_LVL 0


typedef struct {}
config_t;

typedef struct {
  // The total energy of this slot
  int energy;
  // A copy of the slot
  block_t slot;
}
stats_t;

typedef struct {}
private_t;


/*
 * The initialisation function, or constructor, 
 * is called the first time this module is instantiated.
 */

int spc_init( swr_sdb_t *context ) {
  // Begin system-definitions {
  config_t *config;
  stats_t *stats;
  MOD_INC_USE_COUNT;
  if ( sizeof( private_t ) > 0 )
    context->private_data = swr_malloc( sizeof( private_t ) );
  swr_sdb_get_config_struct( context->id, (void**)&config );
  swr_sdb_get_stats_struct( context->id, (void**)&stats );
  // } End of system-definitions

  stats->energy = 0;
  stats->slot.data = 0;
  stats->slot.size = 0;
  stats->slot.type = SIG_SAMPLE_S12;
  port_in(0).flags |= SWR_PORT_PASSED_THROUGH;
  port_out(0).flags |= SWR_PORT_PASSED_THROUGH;

  // Begin system-definitions
  swr_sdb_free_stats_struct( context->id, (void**)&stats );
  swr_sdb_free_config_struct( context->id, (void**)&config );
  return 0;
  // End system-definitions
}


/*
 * To configure the inputs
 * this is called when the output-sizes change.
 */
int spc_configure_inputs( swr_sdb_t *context ) {
  // Definition of variables - don't touch
  config_t *config;

  PR_DBG( 4, "%i: Entering config in\n", context->id );
  swr_sdb_get_config_struct( context->id, (void**)&config );

  port_in(0).size = port_out(0).size;
  port_in(0).data = port_out(0).data;

  // Definition - don't touch
  swr_sdb_free_config_struct( context->id, (void**)&config );
  return 0;
}


/*
 * To configure the outputs
 * this is called when the input-sizes change
 */
int spc_configure_outputs( swr_sdb_t *context ) {
  // Definition of variables - don't touch
  config_t *config;

  swr_sdb_get_config_struct( context->id, (void**)&config );

  port_out(0).size = port_in(0).size;
  port_out(0).data = port_in(0).data;
  PR_DBG( 4, "%i: Entering config out with %p %p\n",
          context->id, port_in(0).data, context );

  // Definition - don't touch
  swr_sdb_free_config_struct( context->id, (void**)&config );
  return 0;
}


/*
 * This is the function that impements the `main method' of the class
 * Every class has got just ONE method/working-mode.
 */
int spc_pdata( swr_sdb_t *context ) {
  int tot = 0, i;
  SAMPLE_S12 *data, *data_out;
  // Definition of variables - don't touch
  stats_t *stats;

  PR_DBG( 4, "Entering\n" );
  data = buffer_in(0);
  for ( i=0; i < size_in(0); i++ ) {
    tot += abs( data[ i ] );
  }

  swr_sdb_get_stats_struct( context->id, (void**)&stats );
  stats->energy = tot;
  stats->slot.data = data;
  //  stats->slot.size = port_in(0).size;
  stats->slot.size = 128;
  swr_sdb_free_stats_struct( context->id, (void**)&stats );
  data_out = buffer_out(0);
  if ( data != data_out ) {
    PR_DBG( 0, "Error, %p and %p should be the same %p\n",
            data, data_out, context );
  }
  PR_DBG( 4, "Exiting\n" );
  return 0;
}

/*
 * This is the `destructor'.
 */
int spc_finalize( swr_sdb_t *context ) {
  if ( sizeof( private_t ) > 0 )
    swr_free( private );
  MOD_DEC_USE_COUNT;
  return 0;
}


/*
 * This function is called upon "insmod" and is used to register the
 * different parts of the module to the SPM.
 */
swr_spc_id_t cdb_id;
int spc_module_init(void) {
  swr_spc_desc_t *desc;

  /**
   * Get a description-part from SPM
   * Give the following parameters:
   * Input-ports, output-ports, config-params, stat-params
   */
  desc = swr_spc_get_new_desc( 1, 1, 0, 2 );
  if ( !desc ) {
    PR_DBG( 0, "Can't initialise the module. This is BAD!\n" );
    return -1;
  }

  /**
   * Define the different parts of config and stats. You have to define
   * them in the same order as they appear in the structures. The names
   * can be freely chosen.
   *
   * UM_CONFIG_{INT,DOUBLE,STRING128}( "name" );
   * UM_STATS_{INT,DOUBLE,STRING128}( "name" );
   */
  UM_STATS_INT( "energy" );
  UM_STATS_BLOCK( "slot" );
  /**
   * The in- and outputs have also to be defined in the right order. First
   * port first. The additional flag is not used yet, but it will...
   *
   * UM_INPUT( SIG_{U8,SYMBOL_{S16,COMPLEX,MMX},SAMPLE_S12,S32}, 0 );
   * UM_OUTPUT( SIG_{U8,SYMBOL_{S16,COMPLEX,MMX},SAMPLE_S12,S32}, 0 );
   */
  UM_INPUT( SIG_SAMPLE_S12, 0 );
  UM_OUTPUT( SIG_SAMPLE_S12, 0 );

  // Initialise the callback-functions. Delete the ones you don't use
  desc->fn_init              = spc_init;
  desc->fn_process_data      = spc_pdata;
  desc->fn_configure_inputs  = spc_configure_inputs;
  desc->fn_configure_outputs = spc_configure_outputs;
  desc->fn_finalize          = spc_finalize;

  // And register the module in the SPM. Change the name!
  cdb_id = swr_cdb_register_spc( &desc, "energy" );
  if ( cdb_id == SWR_SPM_INVALID_ID ) {
    swr_spc_free_desc( desc );
    PR_DBG( 0, "Couldn't register the module!\n" );
    return 1;
  }
  PR_DBG( 4, "Ready\n" );
  return 0;
}


/*
 * This is called upon rmmod
 */
void spc_module_exit( void ) {
  PR_DBG( 4, "Freeing id: %i\n", cdb_id );
  if ( swr_cdb_unregister_spc( cdb_id ) < 0 ) {
    PR_DBG( 0, "Still in use somewhere\n" );
  }
}


module_init( spc_module_init );
module_exit( spc_module_exit );