storage.c

软件无线电的平台

/***************************************************************************
 *    storage.c  -  Framework for storage of received symbols
 *                           -------------------
 *   begin                :  2004
 *   authors              :  ineiti
 *   emails               :  [e-mail]
 ***************************************************************************/

/***************************************************************************
 *                                Changes
 *                                -------
 * date - name - description
 * 2004 - ineiti - start
 *
 **************************************************************************/

/***************************************************************************
 *                                                                         *
 *   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.                                   *
 *                                                                         *
 ***************************************************************************/


/**
 * It just retrieves one big hunck of memory
 */

#include "spc.h"
#include "antenna.h"


#define DBG_LVL 2


// ADD_HERE, int, double, char[128], void*
// BEFORE each declaration, write a short description.
// ON THE SAME LINE as the declaration, write the default value
// Example:
// {
//   // size of the input in bytes
//   int size; // 2560
// }
typedef struct {
  // How many blocks in one slot
  int size_slot; // 128
  // How many slots in one frame
  int slots_frame; // 16
  // Enable continous sampling
  int continous; // 0
}
config_t;

// ADD_HERE, int, double, char[128], void*
// for the rest, the same definition as the confit_t is valid.
typedef struct {
  // The storage block
  block_t storage;
  // The length in symbols
  int samples;
}
stats_t;

// ADD HERE anything you want!
typedef struct {
  int size_slot;
  int slots_frame;
  int size_frame;
  int run;
  int ant_index;
  int slots_rcvd;
  QUAD_SYMBOL_ICS_AD *block;
  int continous;
}
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

  config->size_slot = 128;
  config->slots_frame = 4;
  config->continous = 0;
  private->run = 0;
  private->slots_rcvd = 0;
  private->block = 0;
  stats->storage.type = SIG_QUAD_SYMBOL_ICS_AD;

  // Initialise one channel
  private->ant_index = swr_ant_init( context->id );
  swr_ant_set_flags( private->ant_index, ANTENNA_ONLY_RX  
		     | ANTENNA_IS_COMPLEX );
  // Reception
#ifdef KERNEL_SPACE
  swr_ant_ch_tx_enable( private->ant_index, 0 );
#endif

  // 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;
  swr_sdb_get_config_struct( context->id, (void**)&config );

  // Put you code here
  // ADD HERE

  // 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 );

  // Put you code here
  // ADD HERE

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


/*
 * Every time modules from the outside change the value of a configuration parameter,
 * this function is called.
 */

// If set to one, storage will use directly bigphys-allocations
// Memory_sys: 0 - swr_malloc, 1 - bigphys, 2 - none (physmem)
#define MEMORY_SYS 1
int spc_reconfig( swr_sdb_t *context ) {
  // Definition of variables - don't touch
  config_t *config;
  stats_t *stats;
  uint samples, size_b;
  
  swr_sdb_get_config_struct( context->id, (void**)&config );
  swr_sdb_get_stats_struct( context->id, (void**)&stats );

  if ( private->block ){
#if MEMORY_SYS == 2
    PR_DBG( 4, "Good luck...\n" );
#elif MEMORY_SYS == 1
    PR_DBG( 2, "Freeing bigphys-pages at %p\n", private->block );
    bigphysarea_free_pages( (void*)private->block );
#else
    swr_free( private->block );
#endif
    private->block = 0;
  }
  private->continous = config->continous;

  if ( private->size_slot != config->size_slot ||
       private->slots_frame != config->slots_frame ){
    private->size_slot = config->size_slot;
    private->slots_frame = config->slots_frame;
    private->size_frame = config->slots_frame * config->size_slot;
    PR_DBG( 1, "Re-configuring sizes: %i * %i = %i\n",
	    config->slots_frame, config->size_slot,
	    private->size_frame );
    samples = private->size_frame * DAQ_DMA_BLOCK_SIZE_QI_SAMPLES;
    // There are 4 samples in one QUAD_SYMBOL_ICS_AD
    size_b = sizeof( QUAD_SYMBOL_ICS_AD ) / 4 * samples;
#if MEMORY_SYS == 2
    PR_DBG( 4, "Writing physical address\n" );
    private->block = (void*)0x4000000U;
#elif MEMORY_SYS == 1
    {
      int pages = ( size_b + PAGE_SIZE - 1 ) / PAGE_SIZE;
      PR_DBG( 3, "Allocating %i pages with Big-phys\n", pages );
      private->block = ( QUAD_SYMBOL_ICS_AD*) 
        bigphysarea_alloc_pages( pages, 1, GFP_KERNEL );
    }
#else
    private->block = ( QUAD_SYMBOL_ICS_AD*)swr_malloc ( size_b );
#endif
    PR_DBG( 2, "Size of the requested storage buffer %i\n", size_b );
    PR_DBG( 3, "Address of requested buffer: %p\n", private->block );
    // Each QUAD_SYMBOL_ICS_AD contains 4 samples of a given channel
    stats->storage.size = samples / 4;
    stats->storage.data = private->block;
    stats->samples = samples;
  }
  
  // set up the antenna
  swr_ant_set_slot_len( private->ant_index, private->size_slot );
  swr_ant_set_frame_params( private->ant_index, private->block, 0 );

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


/*
 * This is the function that implements the `main method' of the class
 * Every class has got just ONE method/working-mode.
 */
int spc_pdata( swr_sdb_t *context ) {
  // Definition of variables - don't touch
  stats_t *stats;

  if ( !private->run ){
    private->run = 1;
    private->slots_rcvd = 0;
    // Let's start it
    swr_ant_start( private->size_frame );
  } else {
    PR_DBG( 0, "Is already running\n" );
  }

  swr_sdb_get_stats_struct( context->id, (void**)&stats );
  // Put your code here
  // ADD HERE
  swr_sdb_free_stats_struct( context->id, (void**)&stats );
  return(0);
}

/**
 * User messages
 */
int spc_custom_msg( swr_sdb_t *context, swr_usr_msg_t *data, swr_msgq ret ) {

  if ( !data ){
    PR_DBG( 0, "Empty message???\n" );
    return -1;
  }
  if ( !strcmp( data->id, "ANT" ) ){
    private->slots_rcvd++;
    if ( !( private->slots_rcvd % 100 ) ){
      PR_DBG( 2, "Received slots %i\n", private->slots_rcvd );
    }

    if ( private->slots_rcvd >= private->slots_frame ){
      int i;
      PR_DBG( 3, "Ended transfer of one frame\n" );
      for ( i=0; i<8; i++ ){
	PR_DBG( 5, "Block[%2i] = (%i,%i)\n", i,
		private->block[i].ch[0][0].real, 
		private->block[i].ch[0][0].imag );
      }
      private->slots_rcvd -= private->slots_frame;
      if ( !private->continous ){
	swr_ant_stop();
	private->run = 0;
	PR_DBG( 0, "*** Acquisition done ***\n" );
      }
    }
    swr_free( data->data );
  }
  return 0;
}

/*
 * This is the `destructor'.
 */
int spc_finalize( swr_sdb_t *context ) {
  if ( private->run ){
    swr_ant_stop();
  }
  if ( private->block ){
#if MEMORY_SYS == 1
    bigphysarea_free_pages( (void*)private->block );
#elif MEMORY_SYS == 0
    swr_free( private->block );
#endif
  }
  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( 0, 0, 3, 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,DOUBLE_COMPLEX,STRING128,POINTER}( "name" );
   * UM_STATS_{INT,DOUBLE,DOUBLE_COMPLEX,STRING128,POINTER,BLOCK,IMAGE}( "name" );
   */
  UM_CONFIG_INT( "size_slot" );
  UM_CONFIG_INT( "slots_frame" );
  UM_CONFIG_INT( "continous" );
  UM_STATS_BLOCK( "storage" );
  UM_STATS_INT( "samples" );
  /**
   * 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,DOUBLE_{,COMPLEX}}, 0 );
   * UM_OUTPUT( SIG_{U8,SYMBOL_{S16,COMPLEX,MMX},SAMPLE_S12,S32,DOUBLE_{,COMPLEX}}, 0 );
   */

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

  // And register the module in the SPM. Change the name!
  cdb_id = swr_cdb_register_spc( &desc, "storage" );
  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 );