summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorschodet2010-02-11 12:05:35 +0000
committerschodet2010-02-11 12:05:35 +0000
commitb9f184566d88c94ee79c01a1842310fb691d8cc4 (patch)
treecb2d7da15676af00e99c0d86e2e9a7c7c5bce0b5
parent2aefabc1bb24d6fddbb31b99f60602959d6f2461 (diff)
cesar/hal/phy/maximus: remove duplicated and outdated comments
git-svn-id: svn+ssh://pessac/svn/cesar/trunk@6694 017c9cb6-072f-447c-8318-d5b54f68fe89
-rw-r--r--cesar/hal/phy/maximus/src/maximus_pbdma.c46
-rw-r--r--cesar/hal/phy/maximus/src/maximus_phy_access.c62
-rw-r--r--cesar/hal/phy/maximus/src/maximus_phy_ctrl.c160
-rw-r--r--cesar/hal/phy/maximus/src/maximus_tmdma.c20
4 files changed, 0 insertions, 288 deletions
diff --git a/cesar/hal/phy/maximus/src/maximus_pbdma.c b/cesar/hal/phy/maximus/src/maximus_pbdma.c
index 5550e1cb8e..93c538d178 100644
--- a/cesar/hal/phy/maximus/src/maximus_pbdma.c
+++ b/cesar/hal/phy/maximus/src/maximus_pbdma.c
@@ -17,22 +17,6 @@
#include <errno.h>
-/**
- * Start a PB transfer.
- * \param ctx phy context
- * \param bypass_aes do not encrypt or decrypt using AES
- * \param nek AES network encryption key
- * \param nb_total total number of PB
- * \param nb_ready number of ready descriptors
- * \param nb_pb_it number of the PB after which an interrupt is triggered
- * \param first_pb first PB descriptor
- * \param first_chandata first transfer descriptor
- * \param now start right now
- * set errno to:
- * - EINVAL if ctx or first_pb are null, or if arguments are out-of-range or incoherent
- *
- * The transfer will start when the reception or the transmission starts.
- */
void
phy_pbdma_start (phy_t *ctx, bool bypass_aes, const u32 nek[4], uint nb_total,
uint nb_ready, uint nb_pb_it, phy_pb_t *first_pb,
@@ -84,14 +68,6 @@ phy_pbdma_start (phy_t *ctx, bool bypass_aes, const u32 nek[4], uint nb_total,
}
-/**
- * Update PB transfer counters.
- * \param ctx phy context
- * \param nb_ready number of ready descriptors
- * \param nb_pb_it number of the PB after which an interrupt is triggered
- * set errno to:
- * - EINVAL if ctx is null, or if arguments are incoherent
- */
void
phy_pbdma_update (phy_t *ctx, uint nb_ready, uint nb_pb_it)
{
@@ -117,13 +93,6 @@ phy_pbdma_update (phy_t *ctx, uint nb_ready, uint nb_pb_it)
}
-/**
- * Retrieve last used PB descriptor.
- * \param ctx phy context
- * \return last used PB descriptor
- * set errno to:
- * - EINVAL if ctx is null
- */
phy_pb_t *
phy_pbdma_get_tail (phy_t *ctx)
{
@@ -146,16 +115,6 @@ phy_pbdma_get_tail (phy_t *ctx)
}
-/**
- * Start a channel data transfer.
- * \param ctx phy context
- * \param first_chandata first transfer descriptor
- * set errno to:
- * - EINVAL if ctx or first_chandata are null, or if first_chandata->type equals 0
- *
- * If a PB transfer is set up, this transfer will only start after PB transfer
- * completion.
- */
void
phy_pbdma_start_chandata (phy_t *ctx, phy_chandata_t *first_chandata)
{
@@ -181,11 +140,6 @@ phy_pbdma_start_chandata (phy_t *ctx, phy_chandata_t *first_chandata)
}
-/**
- * Return the address of the CRC bitmap registers.
- * \param ctx phy context
- * \return address of the first of the eight CRC bitmap registers
- */
volatile const u32 *
phy_pbdma_get_crc_bitmap (phy_t *ctx)
{
diff --git a/cesar/hal/phy/maximus/src/maximus_phy_access.c b/cesar/hal/phy/maximus/src/maximus_phy_access.c
index b080d7b33a..4114399f0e 100644
--- a/cesar/hal/phy/maximus/src/maximus_phy_access.c
+++ b/cesar/hal/phy/maximus/src/maximus_phy_access.c
@@ -680,18 +680,6 @@ void maximus_phy_access_slot_count_reset (phy_t *ctx)
}
-/**
- * Start the backoff procedure.
- * \param ctx phy context
- * \param date PRP start date
- * \param cap channel access priority
- * set errno to:
- * - EINVAL if ctx is null
- * if 'netclock_schedule()' fails, it sets errno
- *
- * Reset the backoff procedure hardware to start a new backoff procedure at
- * the given date with the given priority.
- */
void
phy_access_backoff_start (phy_t *ctx, u32 date, uint cap)
{
@@ -746,15 +734,6 @@ phy_access_backoff_start (phy_t *ctx, u32 date, uint cap)
}
-/**
- * Change the cap to a new one.
- * \param ctx phy context
- * \param cap the new channel access priority
- * set errno to:
- * - EINVAL if ctx is null
- *
- * Update the hardware priority.
- */
void
phy_access_backoff_update (phy_t *ctx, uint cap)
{
@@ -800,13 +779,6 @@ phy_access_backoff_update (phy_t *ctx, uint cap)
}
-/**
- * Return the number of slot counted.
- * \param ctx phy context
- * \return slot_count
- * return 0 if it fails with errno =
- * - EINVAL if ctx is null
- */
uint
phy_access_backoff_slot_count (phy_t *ctx)
{
@@ -833,13 +805,6 @@ phy_access_backoff_slot_count (phy_t *ctx)
}
-/**
- * Return true if the PRP is won.
- * \param ctx phy context
- * \return true if CAP_sent == CAP_medium && CAP_mpdu >= CAP_medium
- * return 'false' if it fails with errno =
- * - EINVAL if ctx is null
- */
bool
phy_access_backoff_prp_won (phy_t *ctx)
{
@@ -866,16 +831,6 @@ phy_access_backoff_prp_won (phy_t *ctx)
}
-/**
- * Program the access timer to the given date.
- * \param ctx phy context
- * \param date timer expiration date
- * set errno to:
- * - EINVAL if ctx is null
- * if 'netclock_schedule()' fails, it sets errno
- *
- * ACCESS interrupt is disabled on preamble reception but not on PRP loss.
- */
void
phy_access_timer_program (phy_t *ctx, u32 date)
{
@@ -912,16 +867,6 @@ phy_access_timer_program (phy_t *ctx, u32 date)
}
-/**
- * Update the access timer date without restarting it if it was canceled.
- * \param ctx phy context
- * \param date timer expiration date
- * set errno to:
- * - EINVAL if ctx is null
- * if 'netclock_schedule()' fails, it sets errno
- *
- * This is useful if the access timer was canceled by hardware.
- */
void
phy_access_timer_update (phy_t *ctx, u32 date)
{
@@ -960,13 +905,6 @@ phy_access_timer_update (phy_t *ctx, u32 date)
}
-/**
- * Cancel the access timer.
- * \param ctx phy context
- * set errno to:
- * - EINVAL if ctx is null
- * if 'netclock_unschedule()' fails, it sets errno
- */
void
phy_access_timer_cancel (phy_t *ctx)
{
diff --git a/cesar/hal/phy/maximus/src/maximus_phy_ctrl.c b/cesar/hal/phy/maximus/src/maximus_phy_ctrl.c
index 9bde0efa47..ae1333cfe1 100644
--- a/cesar/hal/phy/maximus/src/maximus_phy_ctrl.c
+++ b/cesar/hal/phy/maximus/src/maximus_phy_ctrl.c
@@ -1874,19 +1874,6 @@ tick_t maximus_phy_schedule_tick (u32 date)
}
-/**
- * Initialise the HAL Phy.
- * \param user_data User data passed to any callback
- * \param rx_fc_cb RX FC event callback
- * \param access_cb ACCESS event callback
- * \param access_conf_cb ACCESS CONFIRM event callback
- * \param pbdma_cb PB DMA callback
- * \param tx_false_alarm_cb TX FALSE ALARM callback
- * \param deferred_cb DSR callback
- * \return the newly created context
- * set errno to:
- * - EINVAL if arguments are null
- */
phy_t *
phy_init (void *user_data, phy_rx_fc_cb_t rx_fc_cb, phy_access_cb_t access_cb,
phy_access_conf_cb_t access_conf_cb, phy_pbdma_cb_t pbdma_cb,
@@ -2012,12 +1999,6 @@ phy_init (void *user_data, phy_rx_fc_cb_t rx_fc_cb, phy_access_cb_t access_cb,
}
-/**
- * Reset the hardware to a known sane state.
- * \param ctx phy context
- * set errno to:
- * - EINVAL if ctx is null
- */
void
phy_reset (phy_t *ctx)
{
@@ -2132,12 +2113,6 @@ phy_reset (phy_t *ctx)
}
-/**
- * Reset and uninitialise the HAL Phy.
- * \param ctx phy context
- * set errno to:
- * - EINVAL if ctx is null
- */
void
phy_uninit (phy_t *ctx)
{
@@ -2188,13 +2163,6 @@ phy_uninit (phy_t *ctx)
}
-/**
- * Get current date.
- * \param ctx phy context
- * \return current phy date
- * set errno to:
- * - EINVAL if ctx is null
- */
u32
phy_date (phy_t *ctx)
{
@@ -2216,10 +2184,6 @@ phy_date (phy_t *ctx)
}
-/**
- * Get station seed.
- * \return station seed
- */
u32
phy_seed (void)
{
@@ -2227,13 +2191,6 @@ phy_seed (void)
}
-/**
- * Retrieve uncorrected current date.
- * \param ctx phy context
- * \return current uncorrected date
- * set errno to:
- * - EINVAL if ctx is null
- */
u32
phy_sysdate (phy_t *ctx)
{
@@ -2256,13 +2213,6 @@ phy_sysdate (phy_t *ctx)
}
-/**
- * Set the clock correction.
- * \param ctx phy context
- * \param numerator clock correction
- * set errno to:
- * - EINVAL if ctx is null
- */
void
phy_clock_set_numerator (phy_t *ctx, uint numerator)
{
@@ -2281,13 +2231,6 @@ phy_clock_set_numerator (phy_t *ctx, uint numerator)
}
-/**
- * Get date of last zero-cross.
- * \param ctx phy context
- * \return last zero-cross date
- * set errno to:
- * - EINVAL if ctx is null
- */
u32
phy_clock_get_zero_cross_captured_date (phy_t *ctx)
{
@@ -2309,13 +2252,6 @@ phy_clock_get_zero_cross_captured_date (phy_t *ctx)
}
-/**
- * Retrieve uncorrected date of last zero-cross.
- * \param ctx phy context
- * \return last zero-cross uncorrected date
- * set errno to:
- * - EINVAL if ctx is null
- */
u32
phy_clock_get_zero_cross_captured_sysdate (phy_t *ctx)
{
@@ -2338,14 +2274,6 @@ phy_clock_get_zero_cross_captured_sysdate (phy_t *ctx)
}
-/**
- * Start Homeplug 1.0 frame control encoding.
- * \param ctx phy context
- * \param date hardware date when the transmission should begin
- * \param fc_10 Homeplug 1.0 frame control
- * set errno to:
- * - EINVAL if ctx is null
- */
void
phy_tx_fc10 (phy_t *ctx, u32 date, u32 fc_10)
{
@@ -2497,14 +2425,6 @@ phy_tx_param_short (phy_t *ctx, phy_fc_mode_t fc_mode)
}
-/**
- * Set TX parameters for SOUND transmission.
- * \param ctx phy context
- * \param fc_mode frame control mode
- * \param nb_pb number of SOUND PB
- * \param mod_fecrate_pb_size combined modulation type, TCC rate, PB size
- * \param gil guard interval for third symbol and following symbols
- */
void
phy_tx_param_sound (phy_t *ctx, phy_fc_mode_t fc_mode, uint nb_pb,
u32 mod_fecrate_pb_size, phy_gil_t gil)
@@ -2566,17 +2486,6 @@ phy_tx_param_sound (phy_t *ctx, phy_fc_mode_t fc_mode, uint nb_pb,
}
-/**
- * Schedule a TX start.
- * \param ctx phy context
- * \param date hardware date when the transmission should begin
- * \param want_conf request an ACCESS CONF interrupt
- * \param stop_tx_on_prp_lost abort TX if PRP was lost
- * \param fc_av frame control
- * set errno to:
- * - EINVAL if ctx is null
- * if 'netclock_schedule()' fails, it sets errno
- */
void
phy_tx_frame (phy_t *ctx, u32 date, bool want_conf, bool stop_tx_on_prp_lost,
const u32 fc_av[4])
@@ -2652,15 +2561,6 @@ phy_tx_cancel (phy_t *ctx)
}
-/**
- * Set RX parameters.
- * \param ctx phy context
- * \param fc_mode frame control mode
- * set errno to:
- * - EINVAL if ctx is null, or if fc_mode is out-of-range
- *
- * The new mode is used immediately.
- */
void
phy_rx_param (phy_t *ctx, phy_fc_mode_t fc_mode)
{
@@ -2683,17 +2583,6 @@ phy_rx_param (phy_t *ctx, phy_fc_mode_t fc_mode)
}
-/**
- * Activate or deactivate preamble detection.
- * \param ctx phy context
- * \param date activation date
- * \param flag true to activate
- * set errno to:
- * - EINVAL if ctx is null
- * if 'netclock_schedule()' fails, it sets errno
- *
- * A pending interrupt is not cancelled.
- */
void
phy_rx_activate (phy_t *ctx, bool now, u32 date, bool pre_detection)
{
@@ -2927,13 +2816,6 @@ phy_rx_prepare_short (phy_t *ctx)
}
-/**
- * Set parameter for SOUND payload reception.
- * \param ctx phy context
- * \param mod_fecrate_pb_size combined modulation type, TCC rate, PB size
- * \param gil guard interval for third symbol and following symbols
- * \param symbol_nb number of expected symbols
- */
void
phy_rx_prepare_sound (phy_t *ctx, uint nb_pb, u32 mod_fecrate_pb_size,
phy_gil_t gil, uint symbol_nb)
@@ -3021,13 +2903,6 @@ phy_rx_prepare_sound (phy_t *ctx, uint nb_pb, u32 mod_fecrate_pb_size,
}
-/**
- * Retrieve Homeplug 1.0 frame control.
- * \param ctx phy context
- * \return received Homeplug 1.0 frame control or (u32)-1 on CRC error
- * return 0 if it fails with errno =
- * - EINVAL if ctx is null
- */
u32
phy_rx_fc10 (phy_t *ctx)
{
@@ -3049,11 +2924,6 @@ phy_rx_fc10 (phy_t *ctx)
}
-/**
- * Retrieve uncorrected date of last start of preamble.
- * \param ctx phy context
- * \return last start of preamble uncorrected date
- */
u32
phy_rx_sysdate (phy_t *ctx)
{
@@ -3075,14 +2945,6 @@ phy_rx_sysdate (phy_t *ctx)
}
-/**
- * Initialise extra timer callback.
- * \param ctx phy context
- * \param extra_timer_user_data user data passed to the callback
- * \param extra_timer_cb extra timer callback
- * set errno to:
- * - EINVAL if ctx or extra_timer_cb are null
- */
void
phy_extra_timer_init (phy_t *ctx, void *extra_timer_user_data,
phy_extra_timer_cb_t extra_timer_cb)
@@ -3104,14 +2966,6 @@ phy_extra_timer_init (phy_t *ctx, void *extra_timer_user_data,
}
-/**
- * Program the extra timer to the given date.
- * \param ctx phy context
- * \param date timer expiration date
- * set errno to:
- * - EINVAL if ctx is null
- * if 'netclock_schedule()' fails, it sets errno
- */
void
phy_extra_timer_program (phy_t *ctx, u32 date)
{
@@ -3146,13 +3000,6 @@ phy_extra_timer_program (phy_t *ctx, u32 date)
}
-/**
- * Cancel the extra timer.
- * \param ctx phy context
- * set errno to:
- * - EINVAL if ctx is null
- * if 'netclock_unschedule()' fails, it sets errno
- */
void
phy_extra_timer_cancel (phy_t *ctx)
{
@@ -3188,13 +3035,6 @@ phy_extra_timer_cancel (phy_t *ctx)
}
-/**
- * Initialise zero-cross callback.
- * \param ctx phy context
- * \param zero_cross_cb zero-cross callback
- * set errno to:
- * - EINVAL if ctx or zero_cross_cb are null
- */
void
phy_zero_cross_init (phy_t *ctx, phy_zero_cross_cb_t zero_cross_cb)
{
diff --git a/cesar/hal/phy/maximus/src/maximus_tmdma.c b/cesar/hal/phy/maximus/src/maximus_tmdma.c
index 39439d8966..590dfab10e 100644
--- a/cesar/hal/phy/maximus/src/maximus_tmdma.c
+++ b/cesar/hal/phy/maximus/src/maximus_tmdma.c
@@ -17,17 +17,6 @@
#include "mac/common/defs.h" // for 'MAC_PB520_BYTES'
#include <errno.h>
-/**
- * Set the tone mask and its related parameters.
- * \param ctx phy context
- * \param tonemask tonemask block descriptor
- * \param carrier_nb number of active carriers in the given tone mask
- * set errno to:
- * - EINVAL if ctx or tonemask are null
- *
- * This also set ROBO modes parameters, HP1.0 mask and other tone mask related
- * registers.
- */
void
phy_set_tonemask (phy_t *ctx, u32 *tonemask, uint carrier_nb)
{
@@ -64,15 +53,6 @@ phy_set_tonemask (phy_t *ctx, u32 *tonemask, uint carrier_nb)
}
-/**
- * Transfer tone map to hardware using the TM DMA.
- * \param ctx phy context
- * \param tonemap tonemap blocks first descriptor
- * set errno to:
- * - EINVAL if ctx or tonemap are null, or if arguments are out-of-range or incorrect
- *
- * The tonemap uses two blocks.
- */
void
phy_set_tonemap (phy_t *ctx, blk_t *tonemap)
{