doc: replace @return by Return:
Sphinx expects Return: and not @return to indicate a return value.
find . -name '*.c' -exec \
sed -i 's/^\(\s\)\*\(\s*\)@return\(\s\)/\1*\2Return:\3/' {} \;
find . -name '*.h' -exec \
sed -i 's/^\(\s\)\*\(\s*\)@return\(\s\)/\1*\2Return:\3/' {} \;
Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
This commit is contained in:
Heinrich Schuchardt
parent
6a685753ce
commit
185f812c41
@ -37,7 +37,7 @@ static inline struct s5p_timer *s5p_get_base_timer(void)
|
||||
* This operates at 1MHz and counts downwards. It will wrap about every
|
||||
* hour (2^32 microseconds).
|
||||
*
|
||||
* @return current value of timer
|
||||
* Return: current value of timer
|
||||
*/
|
||||
static unsigned long timer_get_us_down(void)
|
||||
{
|
||||
|
||||
@ -217,14 +217,14 @@ struct ast2500_scu {
|
||||
* ast_get_clk() - get a pointer to Clock Driver
|
||||
*
|
||||
* @devp, OUT - pointer to Clock Driver
|
||||
* @return zero on success, error code (< 0) otherwise.
|
||||
* Return: zero on success, error code (< 0) otherwise.
|
||||
*/
|
||||
int ast_get_clk(struct udevice **devp);
|
||||
|
||||
/**
|
||||
* ast_get_scu() - get a pointer to SCU registers
|
||||
*
|
||||
* @return pointer to struct ast2500_scu on success, ERR_PTR otherwise
|
||||
* Return: pointer to struct ast2500_scu on success, ERR_PTR otherwise
|
||||
*/
|
||||
void *ast_get_scu(void);
|
||||
|
||||
|
||||
@ -84,7 +84,7 @@ struct ast_wdt {
|
||||
* gets Reset Mode value from it.
|
||||
*
|
||||
* @flags: flags parameter passed into wdt_reset or wdt_start
|
||||
* @return Reset Mode value
|
||||
* Return: Reset Mode value
|
||||
*/
|
||||
u32 ast_reset_mode_from_flags(ulong flags);
|
||||
|
||||
@ -93,7 +93,7 @@ u32 ast_reset_mode_from_flags(ulong flags);
|
||||
* gets Reset Mask value from it. Reset Mask is only supported on ast2500
|
||||
*
|
||||
* @flags: flags parameter passed into wdt_reset or wdt_start
|
||||
* @return Reset Mask value
|
||||
* Return: Reset Mask value
|
||||
*/
|
||||
u32 ast_reset_mask_from_flags(ulong flags);
|
||||
|
||||
|
||||
@ -74,7 +74,7 @@ struct hi6220_pinmux1_regs {
|
||||
* pull-up/down and drive strength.
|
||||
*
|
||||
* @param peripheral peripheral to be configured
|
||||
* @return 0 if ok, -1 on error (e.g. unsupported peripheral)
|
||||
* Return: 0 if ok, -1 on error (e.g. unsupported peripheral)
|
||||
*/
|
||||
int hi6220_pinmux_config(int peripheral);
|
||||
|
||||
|
||||
@ -129,7 +129,7 @@ struct sysreset_reg {
|
||||
*
|
||||
* @input_rate: Input clock rate in Hz
|
||||
* @output_rate: Output clock rate in Hz
|
||||
* @return divisor register value to use
|
||||
* Return: divisor register value to use
|
||||
*/
|
||||
static inline u32 clk_get_divisor(ulong input_rate, uint output_rate)
|
||||
{
|
||||
@ -144,14 +144,14 @@ static inline u32 clk_get_divisor(ulong input_rate, uint output_rate)
|
||||
/**
|
||||
* rockchip_get_cru() - get a pointer to the clock/reset unit registers
|
||||
*
|
||||
* @return pointer to registers, or -ve error on error
|
||||
* Return: pointer to registers, or -ve error on error
|
||||
*/
|
||||
void *rockchip_get_cru(void);
|
||||
|
||||
/**
|
||||
* rockchip_get_pmucru() - get a pointer to the clock/reset unit registers
|
||||
*
|
||||
* @return pointer to registers, or -ve error on error
|
||||
* Return: pointer to registers, or -ve error on error
|
||||
*/
|
||||
void *rockchip_get_pmucru(void);
|
||||
|
||||
@ -168,7 +168,7 @@ int rockchip_get_clk(struct udevice **devp);
|
||||
* @pdev: clock udevice
|
||||
* @reg_offset: the first offset in cru for softreset registers
|
||||
* @reg_number: the reg numbers of softreset registers
|
||||
* @return 0 success, or error value
|
||||
* Return: 0 success, or error value
|
||||
*/
|
||||
int rockchip_reset_bind(struct udevice *pdev, u32 reg_offset, u32 reg_number);
|
||||
|
||||
|
||||
@ -42,21 +42,21 @@ extern void _start(void);
|
||||
/**
|
||||
* Works out the SOC/SKU type used for clocks settings
|
||||
*
|
||||
* @return SOC type - see TEGRA_SOC...
|
||||
* Return: SOC type - see TEGRA_SOC...
|
||||
*/
|
||||
int tegra_get_chip_sku(void);
|
||||
|
||||
/**
|
||||
* Returns the pure SOC (chip ID) from the HIDREV register
|
||||
*
|
||||
* @return SOC ID - see CHIPID_TEGRAxx...
|
||||
* Return: SOC ID - see CHIPID_TEGRAxx...
|
||||
*/
|
||||
int tegra_get_chip(void);
|
||||
|
||||
/**
|
||||
* Returns the SKU ID from the sku_info register
|
||||
*
|
||||
* @return SKU ID - see SKU_ID_Txx...
|
||||
* Return: SKU ID - see SKU_ID_Txx...
|
||||
*/
|
||||
int tegra_get_sku_info(void);
|
||||
|
||||
|
||||
@ -70,7 +70,7 @@ unsigned long clock_start_pll(enum clock_id id, u32 divm, u32 divn,
|
||||
* @param pllout pll output id
|
||||
* @param rate desired output rate
|
||||
*
|
||||
* @return 0 if ok, -1 on error (invalid clock id or no suitable divider)
|
||||
* Return: 0 if ok, -1 on error (invalid clock id or no suitable divider)
|
||||
*/
|
||||
int clock_set_pllout(enum clock_id clkid, enum pll_out_id pllout,
|
||||
unsigned rate);
|
||||
@ -193,7 +193,7 @@ void clock_ll_set_source_divisor(enum periph_id periph_id, unsigned source,
|
||||
* specific knowledge of system-level clock tree structure.
|
||||
*
|
||||
* @param periph_id peripheral to query
|
||||
* @return clock ID of the peripheral's current parent clock
|
||||
* Return: clock ID of the peripheral's current parent clock
|
||||
*/
|
||||
enum clock_id clock_get_periph_parent(enum periph_id periph_id);
|
||||
|
||||
@ -204,7 +204,7 @@ enum clock_id clock_get_periph_parent(enum periph_id periph_id);
|
||||
* @param periph_id peripheral to start
|
||||
* @param parent PLL id of required parent clock
|
||||
* @param rate Required clock rate in Hz
|
||||
* @return rate selected in Hz, or -1U if something went wrong
|
||||
* Return: rate selected in Hz, or -1U if something went wrong
|
||||
*/
|
||||
unsigned clock_start_periph_pll(enum periph_id periph_id,
|
||||
enum clock_id parent, unsigned rate);
|
||||
@ -217,7 +217,7 @@ unsigned clock_start_periph_pll(enum periph_id periph_id,
|
||||
* @param periph_id peripheral to start
|
||||
* @param parent PLL id of parent clock (used to calculate rate, you
|
||||
* must know this!)
|
||||
* @return clock rate of peripheral in Hz
|
||||
* Return: clock rate of peripheral in Hz
|
||||
*/
|
||||
unsigned long clock_get_periph_rate(enum periph_id periph_id,
|
||||
enum clock_id parent);
|
||||
@ -233,7 +233,7 @@ unsigned long clock_get_periph_rate(enum periph_id periph_id,
|
||||
* @param rate Required clock rate in Hz
|
||||
* @param extra_div value for the second-stage divisor (NULL if one is
|
||||
not available)
|
||||
* @return rate selected in Hz, or -1U if something went wrong
|
||||
* Return: rate selected in Hz, or -1U if something went wrong
|
||||
*/
|
||||
unsigned clock_adjust_periph_pll_div(enum periph_id periph_id,
|
||||
enum clock_id parent, unsigned rate, int *extra_div);
|
||||
@ -242,7 +242,7 @@ unsigned clock_adjust_periph_pll_div(enum periph_id periph_id,
|
||||
* Returns the clock rate of a specified clock, in Hz.
|
||||
*
|
||||
* @param parent PLL id of clock to check
|
||||
* @return rate of clock in Hz
|
||||
* Return: rate of clock in Hz
|
||||
*/
|
||||
unsigned clock_get_rate(enum clock_id clkid);
|
||||
|
||||
@ -265,21 +265,21 @@ void clock_ll_start_uart(enum periph_id periph_id);
|
||||
*
|
||||
* @param blob FDT blob to use
|
||||
* @param node Node to look at
|
||||
* @return peripheral ID, or PERIPH_ID_NONE if none
|
||||
* Return: peripheral ID, or PERIPH_ID_NONE if none
|
||||
*/
|
||||
int clock_decode_periph_id(struct udevice *dev);
|
||||
|
||||
/**
|
||||
* Checks if the oscillator bypass is enabled (XOBP bit)
|
||||
*
|
||||
* @return 1 if bypass is enabled, 0 if not
|
||||
* Return: 1 if bypass is enabled, 0 if not
|
||||
*/
|
||||
int clock_get_osc_bypass(void);
|
||||
|
||||
/*
|
||||
* Checks that clocks are valid and prints a warning if not
|
||||
*
|
||||
* @return 0 if ok, -1 on error
|
||||
* Return: 0 if ok, -1 on error
|
||||
*/
|
||||
int clock_verify(void);
|
||||
|
||||
@ -310,7 +310,7 @@ struct clk_pll_simple *clock_get_simple_pll(enum clock_id clkid);
|
||||
* @param mux_bits Set to number of bits in mux register
|
||||
* @param divider_bits Set to the relevant MASK_BITS_* value
|
||||
* @param type Set to the SoC-specific clock type
|
||||
* @return 0 on success, -1 on error
|
||||
* Return: 0 on success, -1 on error
|
||||
*/
|
||||
int get_periph_clock_info(enum periph_id periph_id, int *mux_bits,
|
||||
int *divider_bits, int *type);
|
||||
@ -324,7 +324,7 @@ int get_periph_clock_info(enum periph_id periph_id, int *mux_bits,
|
||||
*
|
||||
* @param periph_id peripheral to query
|
||||
* @param source raw clock source mux value
|
||||
* @return the CLOCK_ID_* value @source represents
|
||||
* Return: the CLOCK_ID_* value @source represents
|
||||
*/
|
||||
enum clock_id get_periph_clock_id(enum periph_id periph_id, int source);
|
||||
|
||||
@ -338,7 +338,7 @@ enum clock_id get_periph_clock_id(enum periph_id periph_id, int source);
|
||||
* @param source PLL id of required parent clock
|
||||
* @param mux_bits Set to number of bits in mux register: 2 or 4
|
||||
* @param divider_bits Set to number of divider bits (8 or 16)
|
||||
* @return mux value (0-4, or -1 if not found)
|
||||
* Return: mux value (0-4, or -1 if not found)
|
||||
*/
|
||||
int get_periph_clock_source(enum periph_id periph_id,
|
||||
enum clock_id parent, int *mux_bits, int *divider_bits);
|
||||
@ -349,7 +349,7 @@ int get_periph_clock_source(enum periph_id periph_id,
|
||||
* provided.
|
||||
*
|
||||
* @param clk_id Clock ID according to tegra30 device tree binding
|
||||
* @return peripheral ID, or PERIPH_ID_NONE if the clock ID is invalid
|
||||
* Return: peripheral ID, or PERIPH_ID_NONE if the clock ID is invalid
|
||||
*/
|
||||
enum periph_id clk_id_to_periph_id(int clk_id);
|
||||
|
||||
@ -367,7 +367,7 @@ enum periph_id clk_id_to_periph_id(int clk_id);
|
||||
* @param m PLL input divider(DIVN)
|
||||
* @param p post divider(DIVP)
|
||||
* @param cpcon base PLL charge pump(CPCON)
|
||||
* @return 0 if ok, -1 on error (the requested PLL is incorrect and cannot
|
||||
* Return: 0 if ok, -1 on error (the requested PLL is incorrect and cannot
|
||||
* be overridden), 1 if PLL is already correct
|
||||
*/
|
||||
int clock_set_rate(enum clock_id clkid, u32 n, u32 m, u32 p, u32 cpcon);
|
||||
@ -416,7 +416,7 @@ extern struct periph_clk_init periph_clk_init_table[];
|
||||
* Enable output clock for external peripherals
|
||||
*
|
||||
* @param clk_id Clock ID to output (1, 2 or 3)
|
||||
* @return 0 if OK. -ve on error
|
||||
* Return: 0 if OK. -ve on error
|
||||
*/
|
||||
int clock_external_output(int clk_id);
|
||||
|
||||
|
||||
@ -21,7 +21,7 @@
|
||||
*
|
||||
* @param id Peripheral id
|
||||
* @param config Configuration to use (FUNCMUX_...), 0 for default
|
||||
* @return 0 if ok, -1 on error (e.g. incorrect id or config)
|
||||
* Return: 0 if ok, -1 on error (e.g. incorrect id or config)
|
||||
*/
|
||||
int funcmux_select(enum periph_id id, int config);
|
||||
|
||||
|
||||
@ -88,7 +88,7 @@ struct tegra_ivc {
|
||||
* @ivc The IVC channel.
|
||||
* @frame Pointer to be filled with the address of the frame to receive.
|
||||
*
|
||||
* @return 0 if a frame is available, else a negative error code.
|
||||
* Return: 0 if a frame is available, else a negative error code.
|
||||
*/
|
||||
int tegra_ivc_read_get_next_frame(struct tegra_ivc *ivc, void **frame);
|
||||
|
||||
@ -102,7 +102,7 @@ int tegra_ivc_read_get_next_frame(struct tegra_ivc *ivc, void **frame);
|
||||
*
|
||||
* @ivc The IVC channel.
|
||||
*
|
||||
* @return 0 if OK, else a negative error code.
|
||||
* Return: 0 if OK, else a negative error code.
|
||||
*/
|
||||
int tegra_ivc_read_advance(struct tegra_ivc *ivc);
|
||||
|
||||
@ -116,7 +116,7 @@ int tegra_ivc_read_advance(struct tegra_ivc *ivc);
|
||||
* @ivc The IVC channel.
|
||||
* @frame Pointer to be filled with the address of the frame to fill.
|
||||
*
|
||||
* @return 0 if a frame is available, else a negative error code.
|
||||
* Return: 0 if a frame is available, else a negative error code.
|
||||
*/
|
||||
int tegra_ivc_write_get_next_frame(struct tegra_ivc *ivc, void **frame);
|
||||
|
||||
@ -130,7 +130,7 @@ int tegra_ivc_write_get_next_frame(struct tegra_ivc *ivc, void **frame);
|
||||
*
|
||||
* @ivc The IVC channel.
|
||||
*
|
||||
* @return 0 if OK, else a negative error code.
|
||||
* Return: 0 if OK, else a negative error code.
|
||||
*/
|
||||
int tegra_ivc_write_advance(struct tegra_ivc *ivc);
|
||||
|
||||
@ -141,7 +141,7 @@ int tegra_ivc_write_advance(struct tegra_ivc *ivc);
|
||||
*
|
||||
* @ivc The IVC channel.
|
||||
*
|
||||
* @return 0 if the channel is ready for communication, or -EAGAIN if a
|
||||
* Return: 0 if the channel is ready for communication, or -EAGAIN if a
|
||||
* channel reset is in progress.
|
||||
*/
|
||||
int tegra_ivc_channel_notified(struct tegra_ivc *ivc);
|
||||
@ -167,7 +167,7 @@ void tegra_ivc_channel_reset(struct tegra_ivc *ivc);
|
||||
* @nframes Number of frames in each shared memory buffer.
|
||||
* @frame_size Size of each frame.
|
||||
*
|
||||
* @return 0 if OK, else a negative error code.
|
||||
* Return: 0 if OK, else a negative error code.
|
||||
*/
|
||||
int tegra_ivc_init(struct tegra_ivc *ivc, ulong rx_base, ulong tx_base,
|
||||
uint32_t nframes, uint32_t frame_size,
|
||||
|
||||
@ -12,7 +12,7 @@ void invalidate_dcache(void);
|
||||
/**
|
||||
* tegra_board_id() - Get the board iD
|
||||
*
|
||||
* @return a board ID, or -ve on error
|
||||
* Return: a board ID, or -ve on error
|
||||
*/
|
||||
int tegra_board_id(void);
|
||||
|
||||
@ -20,14 +20,14 @@ int tegra_board_id(void);
|
||||
* tegra_lcd_pmic_init() - Set up the PMIC for a board
|
||||
*
|
||||
* @board_id: Board ID which may be used to select LCD type
|
||||
* @return 0 if OK, -ve on error
|
||||
* Return: 0 if OK, -ve on error
|
||||
*/
|
||||
int tegra_lcd_pmic_init(int board_id);
|
||||
|
||||
/**
|
||||
* nvidia_board_init() - perform any board-specific init
|
||||
*
|
||||
* @return 0 if OK, -ve on error
|
||||
* Return: 0 if OK, -ve on error
|
||||
*/
|
||||
int nvidia_board_init(void);
|
||||
|
||||
|
||||
@ -150,7 +150,7 @@ struct i2c_ctlr {
|
||||
/**
|
||||
* Returns the bus number of the DVC controller
|
||||
*
|
||||
* @return number of bus, or -1 if there is no DVC active
|
||||
* Return: number of bus, or -1 if there is no DVC active
|
||||
*/
|
||||
int tegra_i2c_get_dvc_bus(struct udevice **busp);
|
||||
|
||||
|
||||
@ -121,7 +121,7 @@ union scratch3_reg {
|
||||
/**
|
||||
* Save warmboot memory settings for a later resume
|
||||
*
|
||||
* @return 0 if ok, -1 on error
|
||||
* Return: 0 if ok, -1 on error
|
||||
*/
|
||||
int warmboot_save_sdram_params(void);
|
||||
|
||||
|
||||
@ -16,14 +16,14 @@
|
||||
*
|
||||
* @param blob Device tree blob
|
||||
* @param default_lcd_base Default address of LCD frame buffer
|
||||
* @return 0 if ok, -1 on error (unsupported bits per pixel)
|
||||
* Return: 0 if ok, -1 on error (unsupported bits per pixel)
|
||||
*/
|
||||
int tegra_display_probe(const void *blob, void *default_lcd_base);
|
||||
|
||||
/**
|
||||
* Return the current display configuration
|
||||
*
|
||||
* @return pointer to display configuration, or NULL if there is no valid
|
||||
* Return: pointer to display configuration, or NULL if there is no valid
|
||||
* config
|
||||
*/
|
||||
struct fdt_disp_config *tegra_display_get_config(void);
|
||||
|
||||
@ -81,7 +81,7 @@ struct emc_ctlr {
|
||||
*
|
||||
* @param blob Device tree blob
|
||||
* @param rate Clock speed of memory controller in Hz (=2x memory bus rate)
|
||||
* @return 0 if ok, else -ve error code (look in emc.c to decode it)
|
||||
* Return: 0 if ok, else -ve error code (look in emc.c to decode it)
|
||||
*/
|
||||
int tegra_set_emc(const void *blob, unsigned rate);
|
||||
|
||||
@ -89,7 +89,7 @@ int tegra_set_emc(const void *blob, unsigned rate);
|
||||
* Get a pointer to the EMC controller from the device tree.
|
||||
*
|
||||
* @param blob Device tree blob
|
||||
* @return pointer to EMC controller
|
||||
* Return: pointer to EMC controller
|
||||
*/
|
||||
struct emc_ctlr *emc_get_controller(const void *blob);
|
||||
|
||||
|
||||
@ -43,7 +43,7 @@ extern const struct gpio_bank *const omap_gpio_bank;
|
||||
* Check if gpio is valid.
|
||||
*
|
||||
* @param gpio GPIO number
|
||||
* @return 1 if ok, 0 on error
|
||||
* Return: 1 if ok, 0 on error
|
||||
*/
|
||||
int gpio_is_valid(int gpio);
|
||||
#endif
|
||||
|
||||
@ -10,7 +10,7 @@
|
||||
* bcm2835_power_on_module() - power on an SoC module
|
||||
*
|
||||
* @module: ID of module to power on (BCM2835_MBOX_POWER_DEVID_...)
|
||||
* @return 0 if OK, -EIO on error
|
||||
* Return: 0 if OK, -EIO on error
|
||||
*/
|
||||
int bcm2835_power_on_module(u32 module);
|
||||
|
||||
@ -18,7 +18,7 @@ int bcm2835_power_on_module(u32 module);
|
||||
* bcm2835_get_mmc_clock() - get the frequency of the MMC clock
|
||||
*
|
||||
* @clock_id: ID of clock to get frequency for
|
||||
* @return clock frequency, or -ve on error
|
||||
* Return: clock frequency, or -ve on error
|
||||
*/
|
||||
int bcm2835_get_mmc_clock(u32 clock_id);
|
||||
|
||||
@ -27,7 +27,7 @@ int bcm2835_get_mmc_clock(u32 clock_id);
|
||||
*
|
||||
* @widthp: Returns the width in pixels
|
||||
* @heightp: Returns the height in pixels
|
||||
* @return 0 if OK, -ve on error
|
||||
* Return: 0 if OK, -ve on error
|
||||
*/
|
||||
int bcm2835_get_video_size(int *widthp, int *heightp);
|
||||
|
||||
@ -42,7 +42,7 @@ int bcm2835_get_video_size(int *widthp, int *heightp);
|
||||
* @fb_basep: Returns base address of frame buffer
|
||||
* @fb_sizep: Returns size of frame buffer
|
||||
* @pitchp: Returns number of bytes in each frame buffer line
|
||||
* @return 0 if OK, -ve on error
|
||||
* Return: 0 if OK, -ve on error
|
||||
*/
|
||||
int bcm2835_set_video_params(int *widthp, int *heightp, int depth_bpp,
|
||||
int pixel_order, int alpha_mode, ulong *fb_basep,
|
||||
@ -51,7 +51,7 @@ int bcm2835_set_video_params(int *widthp, int *heightp, int depth_bpp,
|
||||
/**
|
||||
* bcm2711_load_vl805_firmware() - get vl805's firmware loaded
|
||||
*
|
||||
* @return 0 if OK, -EIO on error
|
||||
* Return: 0 if OK, -EIO on error
|
||||
*/
|
||||
int bcm2711_notify_vl805_reset(void);
|
||||
|
||||
|
||||
@ -1403,7 +1403,7 @@ int exynos5_set_i2s_clk_prescaler(unsigned int src_frq,
|
||||
* @param target_freq Desired clock frequency in Hz
|
||||
* @param best_fine_scalar Pointer to store the fine stage divisor
|
||||
*
|
||||
* @return best_main_scalar Main scalar for desired frequency or -1 if none
|
||||
* Return: best_main_scalar Main scalar for desired frequency or -1 if none
|
||||
* found
|
||||
*/
|
||||
static int clock_calc_best_scalar(unsigned int main_scaler_bits,
|
||||
|
||||
@ -141,7 +141,7 @@ struct mem_timings {
|
||||
*
|
||||
* This function can be called from SPL or the main U-Boot.
|
||||
*
|
||||
* @return pointer to the memory timings that we should use
|
||||
* Return: pointer to the memory timings that we should use
|
||||
*/
|
||||
struct mem_timings *clock_get_mem_timings(void);
|
||||
|
||||
|
||||
@ -40,7 +40,7 @@ void system_clock_init(void);
|
||||
/*
|
||||
* Init subsystems according to the reset status
|
||||
*
|
||||
* @return 0 for a normal boot, non-zero for a resume
|
||||
* Return: 0 for a normal boot, non-zero for a resume
|
||||
*/
|
||||
int do_lowlevel_init(void);
|
||||
|
||||
|
||||
@ -253,7 +253,7 @@ static const unsigned int test_pattern[] = {
|
||||
* @param ch DMC channel number
|
||||
* @param byte_lane which DQS byte offset,
|
||||
* possible values are 0,1,2,3
|
||||
* @return TRUE if memory was good, FALSE if not.
|
||||
* Return: TRUE if memory was good, FALSE if not.
|
||||
*/
|
||||
static bool dmc_valid_window_test_vector(int ch, int byte_lane)
|
||||
{
|
||||
@ -323,7 +323,7 @@ static void dmc_set_read_offset_value(struct exynos5420_phy_control *phy_ctrl,
|
||||
* representations of 0.
|
||||
*
|
||||
* @param b The byte to convert in two's complement.
|
||||
* @return The 7-bit value + sign bit.
|
||||
* Return: The 7-bit value + sign bit.
|
||||
*/
|
||||
|
||||
unsigned char make_signed_byte(signed char b)
|
||||
|
||||
@ -898,7 +898,7 @@ enum {
|
||||
*
|
||||
* @param mem Memory timings for this memory type.
|
||||
* @param reset Reset DDR PHY during initialization.
|
||||
* @return 0 if ok, SETUP_ERR_... if there is a problem
|
||||
* Return: 0 if ok, SETUP_ERR_... if there is a problem
|
||||
*/
|
||||
int ddr3_mem_ctrl_init(struct mem_timings *mem, int reset);
|
||||
|
||||
@ -913,7 +913,7 @@ void lpddr3_mem_ctrl_init(void);
|
||||
* @param phy1_con16 Register address for dmc_phy1->phy_con16
|
||||
* @param phy0_con17 Register address for dmc_phy0->phy_con17
|
||||
* @param phy1_con17 Register address for dmc_phy1->phy_con17
|
||||
* @return 0 if ok, -1 on error
|
||||
* Return: 0 if ok, -1 on error
|
||||
*/
|
||||
int dmc_config_zq(struct mem_timings *mem, uint32_t *phy0_con16,
|
||||
uint32_t *phy1_con16, uint32_t *phy0_con17,
|
||||
|
||||
@ -55,7 +55,7 @@ int set_spi_clk(int periph_id, unsigned int rate);
|
||||
*
|
||||
* @param peripheral Peripheral id
|
||||
*
|
||||
* @return frequency of the peripheral clk
|
||||
* Return: frequency of the peripheral clk
|
||||
*/
|
||||
unsigned long clock_get_periph_rate(int peripheral);
|
||||
|
||||
|
||||
@ -37,7 +37,7 @@ enum {
|
||||
*
|
||||
* @param peripheral peripheral to be configured
|
||||
* @param flags configure flags
|
||||
* @return 0 if ok, -1 on error (e.g. unsupported peripheral)
|
||||
* Return: 0 if ok, -1 on error (e.g. unsupported peripheral)
|
||||
*/
|
||||
int exynos_pinmux_config(int peripheral, int flags);
|
||||
|
||||
@ -46,7 +46,7 @@ int exynos_pinmux_config(int peripheral, int flags);
|
||||
*
|
||||
* @param blob Device tree blob
|
||||
* @param node FDT I2C node to find
|
||||
* @return peripheral id if ok, PERIPH_ID_NONE on error
|
||||
* Return: peripheral id if ok, PERIPH_ID_NONE on error
|
||||
*/
|
||||
int pinmux_decode_periph_id(const void *blob, int node);
|
||||
#endif
|
||||
|
||||
@ -62,7 +62,7 @@ struct spl_machine_param {
|
||||
* Validate signature and return a pointer to the parameter table. If the
|
||||
* signature is invalid, call panic() and never return.
|
||||
*
|
||||
* @return pointer to the parameter table if signature matched or never return.
|
||||
* Return: pointer to the parameter table if signature matched or never return.
|
||||
*/
|
||||
struct spl_machine_param *spl_get_machine_params(void);
|
||||
|
||||
|
||||
@ -38,7 +38,7 @@ enum edge {
|
||||
*
|
||||
* @param ddrmr_regs - memory controller registers
|
||||
*
|
||||
* @return 0 on success, otherwise error code
|
||||
* Return: 0 on success, otherwise error code
|
||||
*/
|
||||
int ddrmc_calibration(struct ddrmr_regs *ddrmr);
|
||||
|
||||
|
||||
@ -34,7 +34,7 @@ enum {
|
||||
*
|
||||
* @param peripheral peripheral to be configured
|
||||
* @param flags configure flags
|
||||
* @return 0 if ok, -1 on error (e.g. unsupported peripheral)
|
||||
* Return: 0 if ok, -1 on error (e.g. unsupported peripheral)
|
||||
*/
|
||||
int exynos_pinmux_config(int peripheral, int flags);
|
||||
|
||||
@ -43,7 +43,7 @@ int exynos_pinmux_config(int peripheral, int flags);
|
||||
*
|
||||
* @param blob Device tree blob
|
||||
* @param node FDT I2C node to find
|
||||
* @return peripheral id if ok, PERIPH_ID_NONE on error
|
||||
* Return: peripheral id if ok, PERIPH_ID_NONE on error
|
||||
*/
|
||||
int pinmux_decode_periph_id(const void *blob, int node);
|
||||
#endif
|
||||
|
||||
@ -366,7 +366,7 @@ static u8 stm32prog_start(struct stm32prog_data *data, u32 address)
|
||||
* get_address() - Get address if it is valid
|
||||
*
|
||||
* @tmp_xor: Current xor value to update
|
||||
* @return The address area
|
||||
* Return: The address area
|
||||
*/
|
||||
static u32 get_address(u8 *tmp_xor)
|
||||
{
|
||||
@ -791,7 +791,7 @@ error:
|
||||
* stm32prog_serial_loop() - USART bootloader Loop routine
|
||||
*
|
||||
* @data: Current command context
|
||||
* @return true if reset is needed after loop
|
||||
* Return: true if reset is needed after loop
|
||||
*/
|
||||
bool stm32prog_serial_loop(struct stm32prog_data *data)
|
||||
{
|
||||
|
||||
@ -243,7 +243,7 @@ void clock_ll_set_source(enum periph_id periph_id, unsigned source)
|
||||
* @param divider_bits number of divider bits (8 or 16)
|
||||
* @param parent_rate clock rate of parent clock in Hz
|
||||
* @param rate required clock rate for this clock
|
||||
* @return divider which should be used
|
||||
* Return: divider which should be used
|
||||
*/
|
||||
static int clk_get_divider(unsigned divider_bits, unsigned long parent_rate,
|
||||
unsigned long rate)
|
||||
@ -297,7 +297,7 @@ int clock_set_pllout(enum clock_id clkid, enum pll_out_id pllout, unsigned rate)
|
||||
*
|
||||
* @param parent_rate clock rate of parent clock in Hz
|
||||
* @param divider which should be used in 7.1 format
|
||||
* @return effective clock rate of peripheral
|
||||
* Return: effective clock rate of peripheral
|
||||
*/
|
||||
static unsigned long get_rate_from_divider(unsigned long parent_rate,
|
||||
int divider)
|
||||
@ -365,7 +365,7 @@ unsigned long clock_get_periph_rate(enum periph_id periph_id,
|
||||
* @param rate required clock rate for this clock
|
||||
* @param extra_div value for the second-stage divisor (not set if this
|
||||
* function returns -1.
|
||||
* @return divider which should be used, or -1 if nothing is valid
|
||||
* Return: divider which should be used, or -1 if nothing is valid
|
||||
*
|
||||
*/
|
||||
static int find_best_divider(unsigned divider_bits, unsigned long parent_rate,
|
||||
@ -403,7 +403,7 @@ static int find_best_divider(unsigned divider_bits, unsigned long parent_rate,
|
||||
* @param source Source number (0-3 or 0-7)
|
||||
* @param mux_bits Number of mux bits (2 or 4)
|
||||
* @param divider Required divider in 7.1 or 15.1 format
|
||||
* @return 0 if ok, -1 on error (requesting a parent clock which is not valid
|
||||
* Return: 0 if ok, -1 on error (requesting a parent clock which is not valid
|
||||
* for this peripheral)
|
||||
*/
|
||||
static int adjust_periph_pll(enum periph_id periph_id, int source,
|
||||
@ -586,7 +586,7 @@ unsigned clock_get_rate(enum clock_id clkid)
|
||||
* @param m PLL input divider(DIVN)
|
||||
* @param p post divider(DIVP)
|
||||
* @param cpcon base PLL charge pump(CPCON)
|
||||
* @return 0 if ok, -1 on error (the requested PLL is incorrect and cannot
|
||||
* Return: 0 if ok, -1 on error (the requested PLL is incorrect and cannot
|
||||
* be overridden), 1 if PLL is already correct
|
||||
*/
|
||||
int clock_set_rate(enum clock_id clkid, u32 n, u32 m, u32 p, u32 cpcon)
|
||||
|
||||
@ -553,7 +553,7 @@ enum clock_id get_periph_clock_id(enum periph_id periph_id, int source)
|
||||
* @param source PLL id of required parent clock
|
||||
* @param mux_bits Set to number of bits in mux register: 2 or 4
|
||||
* @param divider_bits Set to number of divider bits (8 or 16)
|
||||
* @return mux value (0-4, or -1 if not found)
|
||||
* Return: mux value (0-4, or -1 if not found)
|
||||
*/
|
||||
int get_periph_clock_source(enum periph_id periph_id,
|
||||
enum clock_id parent, int *mux_bits, int *divider_bits)
|
||||
@ -623,7 +623,7 @@ void reset_set_enable(enum periph_id periph_id, int enable)
|
||||
* provided.
|
||||
*
|
||||
* @param clk_id Clock ID according to tegra114 device tree binding
|
||||
* @return peripheral ID, or PERIPH_ID_NONE if the clock ID is invalid
|
||||
* Return: peripheral ID, or PERIPH_ID_NONE if the clock ID is invalid
|
||||
*/
|
||||
enum periph_id clk_id_to_periph_id(int clk_id)
|
||||
{
|
||||
|
||||
@ -699,7 +699,7 @@ enum clock_id get_periph_clock_id(enum periph_id periph_id, int source)
|
||||
* @param source PLL id of required parent clock
|
||||
* @param mux_bits Set to number of bits in mux register: 2 or 4
|
||||
* @param divider_bits Set to number of divider bits (8 or 16)
|
||||
* @return mux value (0-4, or -1 if not found)
|
||||
* Return: mux value (0-4, or -1 if not found)
|
||||
*/
|
||||
int get_periph_clock_source(enum periph_id periph_id,
|
||||
enum clock_id parent, int *mux_bits, int *divider_bits)
|
||||
@ -773,7 +773,7 @@ void reset_set_enable(enum periph_id periph_id, int enable)
|
||||
* provided.
|
||||
*
|
||||
* @param clk_id Clock ID according to tegra124 device tree binding
|
||||
* @return peripheral ID, or PERIPH_ID_NONE if the clock ID is invalid
|
||||
* Return: peripheral ID, or PERIPH_ID_NONE if the clock ID is invalid
|
||||
*/
|
||||
enum periph_id clk_id_to_periph_id(int clk_id)
|
||||
{
|
||||
@ -899,7 +899,7 @@ void clock_early_init(void)
|
||||
* Check a register that we set up to see if clock_early_init() has already
|
||||
* been called.
|
||||
*
|
||||
* @return true if clock_early_init() was called, false if not
|
||||
* Return: true if clock_early_init() was called, false if not
|
||||
*/
|
||||
bool clock_early_init_done(void)
|
||||
{
|
||||
|
||||
@ -476,7 +476,7 @@ enum clock_id get_periph_clock_id(enum periph_id periph_id, int source)
|
||||
* @param source PLL id of required parent clock
|
||||
* @param mux_bits Set to number of bits in mux register: 2 or 4
|
||||
* @param divider_bits Set to number of divider bits (8 or 16)
|
||||
* @return mux value (0-4, or -1 if not found)
|
||||
* Return: mux value (0-4, or -1 if not found)
|
||||
*/
|
||||
int get_periph_clock_source(enum periph_id periph_id,
|
||||
enum clock_id parent, int *mux_bits, int *divider_bits)
|
||||
@ -548,7 +548,7 @@ void reset_set_enable(enum periph_id periph_id, int enable)
|
||||
* provided.
|
||||
*
|
||||
* @param clk_id Clock ID according to tegra20 device tree binding
|
||||
* @return peripheral ID, or PERIPH_ID_NONE if the clock ID is invalid
|
||||
* Return: peripheral ID, or PERIPH_ID_NONE if the clock ID is invalid
|
||||
*/
|
||||
enum periph_id clk_id_to_periph_id(int clk_id)
|
||||
{
|
||||
|
||||
@ -113,7 +113,7 @@ enum {
|
||||
* @param blob Device tree blob
|
||||
* @param node EMC node (nvidia,tegra20-emc compatible string)
|
||||
* @param ram_code RAM code to select (0-3, or -1 if unknown)
|
||||
* @return 0 if ok, otherwise a -ve ERR_ code (see enum above)
|
||||
* Return: 0 if ok, otherwise a -ve ERR_ code (see enum above)
|
||||
*/
|
||||
static int find_emc_tables(const void *blob, int node, int ram_code)
|
||||
{
|
||||
@ -167,7 +167,7 @@ static int find_emc_tables(const void *blob, int node, int ram_code)
|
||||
* @param tablep Returns pointer to table to program into EMC. There are
|
||||
* TEGRA_EMC_NUM_REGS entries, destined for offsets as per the
|
||||
* emc_reg_addr array.
|
||||
* @return 0 if ok, otherwise a -ve error code which will allow someone to
|
||||
* Return: 0 if ok, otherwise a -ve error code which will allow someone to
|
||||
* figure out roughly what went wrong by looking at this code.
|
||||
*/
|
||||
static int decode_emc(const void *blob, unsigned rate, struct emc_ctlr **emcp,
|
||||
|
||||
@ -791,7 +791,7 @@ enum clock_id get_periph_clock_id(enum periph_id periph_id, int source)
|
||||
* @param source PLL id of required parent clock
|
||||
* @param mux_bits Set to number of bits in mux register: 2 or 4
|
||||
* @param divider_bits Set to number of divider bits (8 or 16)
|
||||
* @return mux value (0-4, or -1 if not found)
|
||||
* Return: mux value (0-4, or -1 if not found)
|
||||
*/
|
||||
int get_periph_clock_source(enum periph_id periph_id,
|
||||
enum clock_id parent, int *mux_bits, int *divider_bits)
|
||||
@ -871,7 +871,7 @@ void reset_set_enable(enum periph_id periph_id, int enable)
|
||||
* provided.
|
||||
*
|
||||
* @param clk_id Clock ID according to tegra210 device tree binding
|
||||
* @return peripheral ID, or PERIPH_ID_NONE if the clock ID is invalid
|
||||
* Return: peripheral ID, or PERIPH_ID_NONE if the clock ID is invalid
|
||||
*/
|
||||
enum periph_id clk_id_to_periph_id(int clk_id)
|
||||
{
|
||||
|
||||
@ -533,7 +533,7 @@ enum clock_id get_periph_clock_id(enum periph_id periph_id, int source)
|
||||
* @param source PLL id of required parent clock
|
||||
* @param mux_bits Set to number of bits in mux register: 2 or 4
|
||||
* @param divider_bits Set to number of divider bits (8 or 16)
|
||||
* @return mux value (0-4, or -1 if not found)
|
||||
* Return: mux value (0-4, or -1 if not found)
|
||||
*/
|
||||
int get_periph_clock_source(enum periph_id periph_id,
|
||||
enum clock_id parent, int *mux_bits, int *divider_bits)
|
||||
@ -603,7 +603,7 @@ void reset_set_enable(enum periph_id periph_id, int enable)
|
||||
* provided.
|
||||
*
|
||||
* @param clk_id Clock ID according to tegra30 device tree binding
|
||||
* @return peripheral ID, or PERIPH_ID_NONE if the clock ID is invalid
|
||||
* Return: peripheral ID, or PERIPH_ID_NONE if the clock ID is invalid
|
||||
*/
|
||||
enum periph_id clk_id_to_periph_id(int clk_id)
|
||||
{
|
||||
|
||||
@ -30,7 +30,7 @@ struct irq_action {
|
||||
* @param irq IRQ number
|
||||
* @param hdlr Interrupt handler rutine
|
||||
* @param arg Pointer to argument which is passed to int. handler rutine
|
||||
* @return 0 if registration pass, 1 if unregistration pass,
|
||||
* Return: 0 if registration pass, 1 if unregistration pass,
|
||||
* or an error code < 0 otherwise
|
||||
*/
|
||||
int install_interrupt_handler(int irq, interrupt_handler_t *hdlr,
|
||||
|
||||
@ -154,7 +154,7 @@ static struct cvmx_bootinfo cvmx_bootinfo_array[CVMX_MIPS_MAX_CORES];
|
||||
* 16 dwords.
|
||||
* @param num_words Number of data dwords (up to 32)
|
||||
*
|
||||
* @return 0 for success, -1 on error
|
||||
* Return: 0 for success, -1 on error
|
||||
*/
|
||||
static int octeon_set_moveable_region(u32 base, int region_num,
|
||||
bool enable, const u64 *data,
|
||||
@ -219,7 +219,7 @@ static int octeon_set_moveable_region(u32 base, int region_num,
|
||||
* @param[in] str string to parse
|
||||
* @param base 0 for auto, otherwise 8, 10 or 16 for the number base
|
||||
*
|
||||
* @return number of values read.
|
||||
* Return: number of values read.
|
||||
*/
|
||||
static int octeon_parse_nodes(u64 values[CVMX_MAX_NODES],
|
||||
const char *str, int base)
|
||||
@ -246,7 +246,7 @@ static int octeon_parse_nodes(u64 values[CVMX_MAX_NODES],
|
||||
* @param cmd command type
|
||||
* @param[out] boot_args parsed values
|
||||
*
|
||||
* @return number of arguments parsed
|
||||
* Return: number of arguments parsed
|
||||
*/
|
||||
int octeon_parse_bootopts(int argc, char *const argv[],
|
||||
enum octeon_boot_cmd_type cmd,
|
||||
|
||||
@ -89,7 +89,7 @@ int mach_cpu_init(void)
|
||||
/**
|
||||
* Returns number of cores
|
||||
*
|
||||
* @return number of CPU cores for the specified node
|
||||
* Return: number of CPU cores for the specified node
|
||||
*/
|
||||
static int cavm_octeon_num_cores(void)
|
||||
{
|
||||
|
||||
@ -107,7 +107,7 @@ static u64 cvmx_bootmem_desc_addr;
|
||||
* accessed.
|
||||
* @param size Size of the structure member.
|
||||
*
|
||||
* @return Value of the structure member promoted into a u64.
|
||||
* Return: Value of the structure member promoted into a u64.
|
||||
*/
|
||||
static inline u64 __cvmx_bootmem_desc_get(u64 base, int offset,
|
||||
int size)
|
||||
@ -153,7 +153,7 @@ static inline void __cvmx_bootmem_desc_set(u64 base, int offset, int size,
|
||||
/**
|
||||
* This function returns the address of the bootmem descriptor lock.
|
||||
*
|
||||
* @return 64-bit address in KSEG0 of the bootmem descriptor block
|
||||
* Return: 64-bit address in KSEG0 of the bootmem descriptor block
|
||||
*/
|
||||
static inline u64 __cvmx_bootmem_get_lock_addr(void)
|
||||
{
|
||||
@ -275,7 +275,7 @@ static u64 cvmx_bootmem_phy_get_next(u64 addr)
|
||||
* Exact major version to check against. A zero means
|
||||
* check that the version supports named blocks.
|
||||
*
|
||||
* @return Zero if the version is correct. Negative if the version is
|
||||
* Return: Zero if the version is correct. Negative if the version is
|
||||
* incorrect. Failures also cause a message to be displayed.
|
||||
*/
|
||||
static int __cvmx_bootmem_check_version(int exact_match)
|
||||
@ -525,7 +525,7 @@ int cvmx_bootmem_free_named(const char *name)
|
||||
*
|
||||
* @param name is the block name
|
||||
* @param flags indicates the need to use locking during search
|
||||
* @return pointer to named block descriptor
|
||||
* Return: pointer to named block descriptor
|
||||
*
|
||||
* Note: this function returns a pointer to a static structure,
|
||||
* and is therefore not re-entrant.
|
||||
|
||||
@ -96,7 +96,7 @@ static int convert_ciu_fuse_to_physical_core(int core, int max_cores)
|
||||
* @param num_tads number of tads
|
||||
* @param max_cores maximum number of cores
|
||||
*
|
||||
* @return void
|
||||
* Return: void
|
||||
*/
|
||||
void fill_tad_corecount(u64 coremask, int tad_blown_count[], int num_tads,
|
||||
int max_cores)
|
||||
@ -132,7 +132,7 @@ u64 get_core_pattern(int num_tads, int max_cores)
|
||||
* CIU_FUSE register value. For other models there is no difference.
|
||||
*
|
||||
* @param ciu_fuse_value fuse value from CIU_FUSE register
|
||||
* @return logical coremask of CIU_FUSE value.
|
||||
* Return: logical coremask of CIU_FUSE value.
|
||||
*/
|
||||
u64 get_logical_coremask(u64 ciu_fuse_value)
|
||||
{
|
||||
@ -173,7 +173,7 @@ u64 get_logical_coremask(u64 ciu_fuse_value)
|
||||
* If the fuses are blown and locked, they are the definitive coremask.
|
||||
*
|
||||
* @param pcm pointer to coremask to fill in
|
||||
* @return pointer to coremask
|
||||
* Return: pointer to coremask
|
||||
*/
|
||||
struct cvmx_coremask *octeon_get_available_coremask(struct cvmx_coremask *pcm)
|
||||
{
|
||||
|
||||
@ -206,7 +206,7 @@ uint64_t cvmx_helper_cfg_opt_get(cvmx_helper_cfg_option_t opt)
|
||||
* initialize the queue allocation list. the existing static allocation result
|
||||
* is used as a starting point to ensure backward compatibility.
|
||||
*
|
||||
* @return 0 on success
|
||||
* Return: 0 on success
|
||||
* -1 on failure
|
||||
*/
|
||||
int cvmx_pko_queue_grp_alloc(u64 start, uint64_t end, uint64_t count)
|
||||
@ -333,7 +333,7 @@ int init_cvmx_pko_que_range(void)
|
||||
* @param port the port for which the queues are requested
|
||||
* @param count the number of queues requested
|
||||
*
|
||||
* @return 0 on success
|
||||
* Return: 0 on success
|
||||
* -1 on failure
|
||||
*/
|
||||
static int cvmx_pko_queue_alloc(u64 port, int count)
|
||||
@ -381,7 +381,7 @@ static int cvmx_pko_queue_alloc(u64 port, int count)
|
||||
*
|
||||
* @param port the port for which the queues are returned
|
||||
*
|
||||
* @return 0 on success
|
||||
* Return: 0 on success
|
||||
* -1 on failure
|
||||
*/
|
||||
int cvmx_pko_queue_free(uint64_t port)
|
||||
@ -730,7 +730,7 @@ int cvmx_helper_cfg_ipd2pko_port_num(int ipd_port)
|
||||
* Return the number of queues to be assigned to this pko_port
|
||||
*
|
||||
* @param pko_port
|
||||
* @return the number of queues for this pko_port
|
||||
* Return: the number of queues for this pko_port
|
||||
*
|
||||
*/
|
||||
static int cvmx_helper_cfg_dft_nqueues(int pko_port)
|
||||
@ -815,7 +815,7 @@ static int cvmx_helper_cfg_init_pko_iports_and_queues_using_static_config(void)
|
||||
* @param xiface interface to check
|
||||
* @param index port index in the interface
|
||||
*
|
||||
* @return status of the port present or not.
|
||||
* Return: status of the port present or not.
|
||||
*/
|
||||
int cvmx_helper_is_port_valid(int xiface, int index)
|
||||
{
|
||||
@ -1325,7 +1325,7 @@ void cvmx_helper_set_port_fdt_node_offset(int xiface, int index, int node_offset
|
||||
*
|
||||
* @param xiface node and interface
|
||||
* @param index port index
|
||||
* @return node offset of port or -1 if invalid
|
||||
* Return: node offset of port or -1 if invalid
|
||||
*/
|
||||
int cvmx_helper_get_port_fdt_node_offset(int xiface, int index)
|
||||
{
|
||||
@ -1343,7 +1343,7 @@ int cvmx_helper_get_port_fdt_node_offset(int xiface, int index)
|
||||
* @param[out] xiface xinterface of match
|
||||
* @param[out] index port index of match
|
||||
*
|
||||
* @return 0 if found, -1 if not found
|
||||
* Return: 0 if found, -1 if not found
|
||||
*/
|
||||
int cvmx_helper_cfg_get_xiface_index_by_fdt_node_offset(int of_offset, int *xiface, int *index)
|
||||
{
|
||||
@ -1392,7 +1392,7 @@ void cvmx_helper_set_phy_fdt_node_offset(int xiface, int index, int node_offset)
|
||||
*
|
||||
* @param xiface node and interface
|
||||
* @param index port index
|
||||
* @return node offset of phy or -1 if invalid
|
||||
* Return: node offset of phy or -1 if invalid
|
||||
*/
|
||||
int cvmx_helper_get_phy_fdt_node_offset(int xiface, int index)
|
||||
{
|
||||
@ -1428,7 +1428,7 @@ void cvmx_helper_set_port_autonegotiation(int xiface, int index, bool enable)
|
||||
* @param xiface node and interface
|
||||
* @param index port index
|
||||
*
|
||||
* @return 0 if autonegotiation is disabled, 1 if enabled.
|
||||
* Return: 0 if autonegotiation is disabled, 1 if enabled.
|
||||
*/
|
||||
bool cvmx_helper_get_port_autonegotiation(int xiface, int index)
|
||||
{
|
||||
@ -1463,7 +1463,7 @@ void cvmx_helper_set_port_fec(int xiface, int index, bool enable)
|
||||
* @param xiface node and interface
|
||||
* @param index port index
|
||||
*
|
||||
* @return false if fec is disabled, true if enabled.
|
||||
* Return: false if fec is disabled, true if enabled.
|
||||
*/
|
||||
bool cvmx_helper_get_port_fec(int xiface, int index)
|
||||
{
|
||||
@ -1653,7 +1653,7 @@ void cvmx_helper_set_port_phy_info(int xiface, int index, struct cvmx_phy_info *
|
||||
* @param xiface node and interface
|
||||
* @param index port index
|
||||
*
|
||||
* @return pointer to PHY information data structure or NULL if not set
|
||||
* Return: pointer to PHY information data structure or NULL if not set
|
||||
*/
|
||||
struct cvmx_phy_info *cvmx_helper_get_port_phy_info(int xiface, int index)
|
||||
{
|
||||
@ -1671,7 +1671,7 @@ struct cvmx_phy_info *cvmx_helper_get_port_phy_info(int xiface, int index)
|
||||
* @param xiface node and interface
|
||||
* @param index portindex
|
||||
*
|
||||
* @return pointer to the PHY LED information data structure or NULL if not
|
||||
* Return: pointer to the PHY LED information data structure or NULL if not
|
||||
* present
|
||||
*/
|
||||
struct cvmx_phy_gpio_leds *cvmx_helper_get_port_phy_leds(int xiface, int index)
|
||||
@ -1750,7 +1750,7 @@ void cvmx_helper_cfg_get_rgmii_tx_clk_delay(int xiface, int index, bool *bypass,
|
||||
* @param xiface node and interface
|
||||
* @param index port index
|
||||
*
|
||||
* @return offset in device tree or -1 if error or not defined.
|
||||
* Return: offset in device tree or -1 if error or not defined.
|
||||
*/
|
||||
int cvmx_helper_cfg_get_sfp_fdt_offset(int xiface, int index)
|
||||
{
|
||||
@ -1785,7 +1785,7 @@ void cvmx_helper_cfg_set_sfp_fdt_offset(int xiface, int index, int sfp_of_offset
|
||||
* @param xiface node and interface
|
||||
* @param index port index
|
||||
*
|
||||
* @return pointer to vsc7224 data structure or NULL if not present
|
||||
* Return: pointer to vsc7224 data structure or NULL if not present
|
||||
*/
|
||||
struct cvmx_vsc7224_chan *cvmx_helper_cfg_get_vsc7224_chan_info(int xiface, int index)
|
||||
{
|
||||
@ -1820,7 +1820,7 @@ void cvmx_helper_cfg_set_vsc7224_chan_info(int xiface, int index,
|
||||
* @param xiface node and interface
|
||||
* @param index port index
|
||||
*
|
||||
* @return pointer to avsp5410 data structure or NULL if not present
|
||||
* Return: pointer to avsp5410 data structure or NULL if not present
|
||||
*/
|
||||
struct cvmx_avsp5410 *cvmx_helper_cfg_get_avsp5410_info(int xiface, int index)
|
||||
{
|
||||
@ -1853,7 +1853,7 @@ void cvmx_helper_cfg_set_avsp5410_info(int xiface, int index, struct cvmx_avsp54
|
||||
* @param xiface node and interface
|
||||
* @param index port index
|
||||
*
|
||||
* @return pointer to SFP data structure or NULL if none
|
||||
* Return: pointer to SFP data structure or NULL if none
|
||||
*/
|
||||
struct cvmx_fdt_sfp_info *cvmx_helper_cfg_get_sfp_info(int xiface, int index)
|
||||
{
|
||||
|
||||
@ -54,7 +54,7 @@ struct mux_compat {
|
||||
*
|
||||
* @param size number of bytes to allocate
|
||||
*
|
||||
* @return pointer to allocated memory or NULL if out of memory.
|
||||
* Return: pointer to allocated memory or NULL if out of memory.
|
||||
* Alignment is set to 8-bytes.
|
||||
*/
|
||||
void *__cvmx_fdt_alloc(size_t size)
|
||||
@ -85,7 +85,7 @@ void __cvmx_fdt_free(void *ptr, size_t size)
|
||||
* @param[in,out] lenp Number of phandles, input max number
|
||||
* @param[out] nodes Array of phandle nodes
|
||||
*
|
||||
* @return -ve error code on error or 0 for success
|
||||
* Return: -ve error code on error or 0 for success
|
||||
*/
|
||||
int cvmx_fdt_lookup_phandles(const void *fdt_addr, int node,
|
||||
const char *prop_name, int *lenp,
|
||||
@ -116,7 +116,7 @@ int cvmx_fdt_lookup_phandles(const void *fdt_addr, int node,
|
||||
* @param[in] fdt_addr Address of FDT
|
||||
* @param node FDT node number
|
||||
*
|
||||
* @return CPU node number or error if negative
|
||||
* Return: CPU node number or error if negative
|
||||
*/
|
||||
int cvmx_fdt_get_cpu_node(const void *fdt_addr, int node)
|
||||
{
|
||||
@ -147,7 +147,7 @@ int cvmx_fdt_get_cpu_node(const void *fdt_addr, int node)
|
||||
*
|
||||
* @param[in] fdt_addr Address of FDT
|
||||
*
|
||||
* @return Size of flat device tree in bytes or error if negative.
|
||||
* Return: Size of flat device tree in bytes or error if negative.
|
||||
*/
|
||||
int cvmx_fdt_get_fdt_size(const void *fdt_addr)
|
||||
{
|
||||
@ -167,7 +167,7 @@ int cvmx_fdt_get_fdt_size(const void *fdt_addr)
|
||||
* @param[in] strlist Array of FDT device compatibility strings,
|
||||
* must end with NULL or empty string.
|
||||
*
|
||||
* @return 0 if at least one item matches, 1 if no matches
|
||||
* Return: 0 if at least one item matches, 1 if no matches
|
||||
*/
|
||||
int cvmx_fdt_node_check_compatible_list(const void *fdt_addr, int node, const char *const *strlist)
|
||||
{
|
||||
@ -187,7 +187,7 @@ int cvmx_fdt_node_check_compatible_list(const void *fdt_addr, int node, const ch
|
||||
* @param strlist Array of FDT device compatibility strings, must
|
||||
* end with NULL or empty string.
|
||||
*
|
||||
* @return next matching node or -1 if no more matches.
|
||||
* Return: next matching node or -1 if no more matches.
|
||||
*/
|
||||
int cvmx_fdt_node_offset_by_compatible_list(const void *fdt_addr, int startoffset,
|
||||
const char *const *strlist)
|
||||
@ -221,7 +221,7 @@ void cvmx_sfp_attach_phy(struct cvmx_fdt_sfp_info *sfp, struct cvmx_phy_info *ph
|
||||
* @param sfp Handle to SFP data structure
|
||||
* @param ipd_port Port to assign it to
|
||||
*
|
||||
* @return 0 for success, -1 on error
|
||||
* Return: 0 for success, -1 on error
|
||||
*/
|
||||
int cvmx_sfp_set_ipd_port(struct cvmx_fdt_sfp_info *sfp, int ipd_port)
|
||||
{
|
||||
@ -269,7 +269,7 @@ int cvmx_sfp_set_ipd_port(struct cvmx_fdt_sfp_info *sfp, int ipd_port)
|
||||
* @param of_offset Offset of vsc7224 node
|
||||
* @param[in,out] vsc7224 Data structure to hold the data
|
||||
*
|
||||
* @return 0 for success, -1 on error
|
||||
* Return: 0 for success, -1 on error
|
||||
*/
|
||||
static int cvmx_fdt_parse_vsc7224_channels(const void *fdt_addr, int of_offset,
|
||||
struct cvmx_vsc7224 *vsc7224)
|
||||
@ -437,7 +437,7 @@ static int cvmx_fdt_parse_vsc7224_channels(const void *fdt_addr, int of_offset,
|
||||
*
|
||||
* @param[in] fdt_addr Address of flat device tree
|
||||
*
|
||||
* @return 0 for success, error otherwise
|
||||
* Return: 0 for success, error otherwise
|
||||
*/
|
||||
int __cvmx_fdt_parse_vsc7224(const void *fdt_addr)
|
||||
{
|
||||
@ -530,7 +530,7 @@ int __cvmx_fdt_parse_vsc7224(const void *fdt_addr)
|
||||
*
|
||||
* @param[in] fdt_addr Address of flat device tree
|
||||
*
|
||||
* @return 0 for success, error otherwise
|
||||
* Return: 0 for success, error otherwise
|
||||
*/
|
||||
int __cvmx_fdt_parse_avsp5410(const void *fdt_addr)
|
||||
{
|
||||
@ -665,7 +665,7 @@ int __cvmx_fdt_parse_avsp5410(const void *fdt_addr)
|
||||
* @param of_offset Offset of QSFP node
|
||||
* @param[out] sfp_info Pointer to sfp info to fill in
|
||||
*
|
||||
* @return 0 for success
|
||||
* Return: 0 for success
|
||||
*/
|
||||
static int cvmx_parse_qsfp(const void *fdt_addr, int of_offset, struct cvmx_fdt_sfp_info *sfp_info)
|
||||
{
|
||||
@ -684,7 +684,7 @@ static int cvmx_parse_qsfp(const void *fdt_addr, int of_offset, struct cvmx_fdt_
|
||||
* @param of_offset Offset of SFP node
|
||||
* @param[out] sfp_info Pointer to sfp info to fill in
|
||||
*
|
||||
* @return 0 for success
|
||||
* Return: 0 for success
|
||||
*/
|
||||
static int cvmx_parse_sfp(const void *fdt_addr, int of_offset, struct cvmx_fdt_sfp_info *sfp_info)
|
||||
{
|
||||
@ -702,7 +702,7 @@ static int cvmx_parse_sfp(const void *fdt_addr, int of_offset, struct cvmx_fdt_s
|
||||
* @param of_offset Offset of SFP node
|
||||
* @param[out] sfp_info Pointer to sfp info to fill in
|
||||
*
|
||||
* @return 0 for success, -1 on error
|
||||
* Return: 0 for success, -1 on error
|
||||
*/
|
||||
static int cvmx_parse_sfp_eeprom(const void *fdt_addr, int of_offset,
|
||||
struct cvmx_fdt_sfp_info *sfp_info)
|
||||
@ -741,7 +741,7 @@ static int cvmx_parse_sfp_eeprom(const void *fdt_addr, int of_offset,
|
||||
*
|
||||
* @param[in] fdt_addr Address of flat device tree
|
||||
*
|
||||
* @return pointer to sfp info or NULL if error
|
||||
* Return: pointer to sfp info or NULL if error
|
||||
*/
|
||||
struct cvmx_fdt_sfp_info *cvmx_helper_fdt_parse_sfp_info(const void *fdt_addr, int of_offset)
|
||||
{
|
||||
@ -806,7 +806,7 @@ error_exit:
|
||||
* @param of_offset fdt offset of slice
|
||||
* @param phy_info phy_info data structure
|
||||
*
|
||||
* @return slice number if non-negative, otherwise error
|
||||
* Return: slice number if non-negative, otherwise error
|
||||
*/
|
||||
static int cvmx_fdt_parse_cs4343_slice(const void *fdt_addr, int of_offset,
|
||||
struct cvmx_phy_info *phy_info)
|
||||
@ -905,7 +905,7 @@ static int cvmx_fdt_parse_cs4343_slice(const void *fdt_addr, int of_offset,
|
||||
* @param of_offset offset of slice or phy in device tree
|
||||
* @param phy_info phy_info data structure to fill in
|
||||
*
|
||||
* @return 0 for success, -1 on error
|
||||
* Return: 0 for success, -1 on error
|
||||
*/
|
||||
int cvmx_fdt_parse_cs4343(const void *fdt_addr, int of_offset, struct cvmx_phy_info *phy_info)
|
||||
{
|
||||
|
||||
@ -71,7 +71,7 @@ void cvmx_helper_qlm_jtag_init(void)
|
||||
* @param data Data to shift in. Bit 0 enters the chain first, followed by
|
||||
* bit 1, etc.
|
||||
*
|
||||
* @return The low order bits of the JTAG chain that shifted out of the
|
||||
* Return: The low order bits of the JTAG chain that shifted out of the
|
||||
* circle.
|
||||
*/
|
||||
uint32_t cvmx_helper_qlm_jtag_shift(int qlm, int bits, uint32_t data)
|
||||
|
||||
@ -132,7 +132,7 @@ static const struct ipd_port_map ipd_port_map_75xx[CVMX_HELPER_MAX_IFACE] = {
|
||||
*
|
||||
* @param mode Mode to convert
|
||||
*
|
||||
* @return String
|
||||
* Return: String
|
||||
*/
|
||||
const char *cvmx_helper_interface_mode_to_string(cvmx_helper_interface_mode_t mode)
|
||||
{
|
||||
@ -729,7 +729,7 @@ void cvmx_helper_setup_legacy_red(int pass_thresh, int drop_thresh)
|
||||
* @param drop_thresh
|
||||
* All incoming packets will be dropped when there are less
|
||||
* than this many free packet buffers in FPA 0.
|
||||
* @return Zero on success. Negative on failure
|
||||
* Return: Zero on success. Negative on failure
|
||||
*/
|
||||
int cvmx_helper_setup_red(int pass_thresh, int drop_thresh)
|
||||
{
|
||||
@ -749,7 +749,7 @@ int cvmx_helper_setup_red(int pass_thresh, int drop_thresh)
|
||||
* @param xiface Interface to configure
|
||||
* @param num_ports Number of ports on the interface
|
||||
*
|
||||
* @return Zero on success, negative on failure
|
||||
* Return: Zero on success, negative on failure
|
||||
*/
|
||||
int __cvmx_helper_setup_gmx(int xiface, int num_ports)
|
||||
{
|
||||
@ -984,7 +984,7 @@ int cvmx_helper_get_bpid(int interface, int port)
|
||||
*
|
||||
* @param port IPD/PKO port number
|
||||
*
|
||||
* @return none
|
||||
* Return: none
|
||||
*/
|
||||
void cvmx_helper_show_stats(int port)
|
||||
{
|
||||
@ -1013,7 +1013,7 @@ void cvmx_helper_show_stats(int port)
|
||||
*
|
||||
* @param ipd_port IPD/PKO port number
|
||||
*
|
||||
* @return Interface number
|
||||
* Return: Interface number
|
||||
*/
|
||||
int cvmx_helper_get_interface_num(int ipd_port)
|
||||
{
|
||||
@ -1096,7 +1096,7 @@ int cvmx_helper_get_interface_num(int ipd_port)
|
||||
*
|
||||
* @param ipd_port IPD/PKO port number
|
||||
*
|
||||
* @return Interface index number
|
||||
* Return: Interface index number
|
||||
*/
|
||||
int cvmx_helper_get_interface_index_num(int ipd_port)
|
||||
{
|
||||
|
||||
@ -512,7 +512,7 @@ cvmx_helper_link_info_t __cvmx_helper_get_link_info(int xiface, int port)
|
||||
*
|
||||
* @param xiface - interface to check
|
||||
*
|
||||
* @return zero if FCS is not used, otherwise FCS is used.
|
||||
* Return: zero if FCS is not used, otherwise FCS is used.
|
||||
*/
|
||||
int __cvmx_helper_get_has_fcs(int xiface)
|
||||
{
|
||||
@ -562,7 +562,7 @@ void (*cvmx_override_ipd_port_setup)(int ipd_port) = NULL;
|
||||
* but the CNX0XX and CNX1XX are exceptions. These only support
|
||||
* one interface.
|
||||
*
|
||||
* @return Number of interfaces on chip
|
||||
* Return: Number of interfaces on chip
|
||||
*/
|
||||
int cvmx_helper_get_number_of_interfaces(void)
|
||||
{
|
||||
@ -609,7 +609,7 @@ int __cvmx_helper_early_ports_on_interface(int interface)
|
||||
*
|
||||
* @param xiface xiface to get the port count for
|
||||
*
|
||||
* @return Number of ports on interface. Can be Zero.
|
||||
* Return: Number of ports on interface. Can be Zero.
|
||||
*/
|
||||
int cvmx_helper_ports_on_interface(int xiface)
|
||||
{
|
||||
@ -1158,7 +1158,7 @@ static cvmx_helper_interface_mode_t __cvmx_get_mode_octeon2(int interface)
|
||||
*
|
||||
* @param xiface Interface to probe
|
||||
*
|
||||
* @return Mode of the interface. Unknown or unsupported interfaces return
|
||||
* Return: Mode of the interface. Unknown or unsupported interfaces return
|
||||
* DISABLED.
|
||||
*/
|
||||
cvmx_helper_interface_mode_t cvmx_helper_interface_get_mode(int xiface)
|
||||
@ -1239,7 +1239,7 @@ cvmx_helper_interface_mode_t cvmx_helper_interface_get_mode(int xiface)
|
||||
*
|
||||
* @param xiface Interface to enumerate
|
||||
*
|
||||
* @return The number of ports on the interface, negative on failure
|
||||
* Return: The number of ports on the interface, negative on failure
|
||||
*/
|
||||
int cvmx_helper_interface_enumerate(int xiface)
|
||||
{
|
||||
@ -1262,7 +1262,7 @@ int cvmx_helper_interface_enumerate(int xiface)
|
||||
*
|
||||
* @param xiface Interface to probe
|
||||
*
|
||||
* @return Zero on success, negative on failure
|
||||
* Return: Zero on success, negative on failure
|
||||
*/
|
||||
int cvmx_helper_interface_probe(int xiface)
|
||||
{
|
||||
@ -1365,7 +1365,7 @@ int cvmx_helper_interface_probe(int xiface)
|
||||
* @INTERNAL
|
||||
* Setup backpressure.
|
||||
*
|
||||
* @return Zero on success, negative on failure
|
||||
* Return: Zero on success, negative on failure
|
||||
*/
|
||||
static int __cvmx_helper_global_setup_backpressure(int node)
|
||||
{
|
||||
@ -1441,7 +1441,7 @@ static int __cvmx_helper_global_setup_backpressure(int node)
|
||||
/**
|
||||
* @INTERNAL
|
||||
* Verify the per port IPD backpressure is aligned properly.
|
||||
* @return Zero if working, non zero if misaligned
|
||||
* Return: Zero if working, non zero if misaligned
|
||||
*/
|
||||
int __cvmx_helper_backpressure_is_misaligned(void)
|
||||
{
|
||||
@ -1458,7 +1458,7 @@ int __cvmx_helper_backpressure_is_misaligned(void)
|
||||
*
|
||||
* @param xiface Interface to enable
|
||||
*
|
||||
* @return Zero on success, negative on failure
|
||||
* Return: Zero on success, negative on failure
|
||||
*/
|
||||
int __cvmx_helper_packet_hardware_enable(int xiface)
|
||||
{
|
||||
@ -1480,7 +1480,7 @@ int cvmx_helper_ipd_and_packet_input_enable(void)
|
||||
* Called after all internal packet IO paths are setup. This
|
||||
* function enables IPD/PIP and begins packet input and output.
|
||||
*
|
||||
* @return Zero on success, negative on failure
|
||||
* Return: Zero on success, negative on failure
|
||||
*/
|
||||
int cvmx_helper_ipd_and_packet_input_enable_node(int node)
|
||||
{
|
||||
@ -1526,7 +1526,7 @@ int cvmx_helper_ipd_and_packet_input_enable_node(int node)
|
||||
* on CVMX_PKO_QUEUES_PER_PORT_* where each queue is lower
|
||||
* priority than the previous.
|
||||
*
|
||||
* @return Zero on success, non-zero on failure
|
||||
* Return: Zero on success, non-zero on failure
|
||||
*/
|
||||
int cvmx_helper_initialize_packet_io_node(unsigned int node)
|
||||
{
|
||||
@ -1645,7 +1645,7 @@ int cvmx_helper_initialize_packet_io_node(unsigned int node)
|
||||
* on CVMX_PKO_QUEUES_PER_PORT_* where each queue is lower
|
||||
* priority than the previous.
|
||||
*
|
||||
* @return Zero on success, non-zero on failure
|
||||
* Return: Zero on success, non-zero on failure
|
||||
*/
|
||||
int cvmx_helper_initialize_packet_io_global(void)
|
||||
{
|
||||
@ -1657,7 +1657,7 @@ int cvmx_helper_initialize_packet_io_global(void)
|
||||
/**
|
||||
* Does core local initialization for packet io
|
||||
*
|
||||
* @return Zero on success, non-zero on failure
|
||||
* Return: Zero on success, non-zero on failure
|
||||
*/
|
||||
int cvmx_helper_initialize_packet_io_local(void)
|
||||
{
|
||||
@ -1681,7 +1681,7 @@ struct cvmx_buffer_list {
|
||||
* 1 => disable backpressure
|
||||
* 0 => enable backpressure
|
||||
*
|
||||
* @return 0 on success
|
||||
* Return: 0 on success
|
||||
* -1 on error
|
||||
*/
|
||||
int cvmx_gmx_set_backpressure_override(u32 interface, uint32_t port_mask)
|
||||
@ -1710,7 +1710,7 @@ int cvmx_gmx_set_backpressure_override(u32 interface, uint32_t port_mask)
|
||||
* 1 => disable backpressure
|
||||
* 0 => enable backpressure
|
||||
*
|
||||
* @return 0 on success
|
||||
* Return: 0 on success
|
||||
* -1 on error
|
||||
*/
|
||||
int cvmx_agl_set_backpressure_override(u32 interface, uint32_t port_mask)
|
||||
@ -1852,7 +1852,7 @@ int cvmx_helper_shutdown_packet_io_global_cn78xx(int node)
|
||||
* buffers used by the packet IO hardware to the FPA so a function emptying the
|
||||
* FPA after shutdown should find all packet buffers in the FPA.
|
||||
*
|
||||
* @return Zero on success, negative on failure.
|
||||
* Return: Zero on success, negative on failure.
|
||||
*/
|
||||
int cvmx_helper_shutdown_packet_io_global(void)
|
||||
{
|
||||
@ -2158,7 +2158,7 @@ int cvmx_helper_shutdown_packet_io_global(void)
|
||||
/**
|
||||
* Does core local shutdown of packet io
|
||||
*
|
||||
* @return Zero on success, non-zero on failure
|
||||
* Return: Zero on success, non-zero on failure
|
||||
*/
|
||||
int cvmx_helper_shutdown_packet_io_local(void)
|
||||
{
|
||||
@ -2176,7 +2176,7 @@ int cvmx_helper_shutdown_packet_io_local(void)
|
||||
*
|
||||
* @param xipd_port IPD/PKO port to auto configure
|
||||
*
|
||||
* @return Link state after configure
|
||||
* Return: Link state after configure
|
||||
*/
|
||||
cvmx_helper_link_info_t cvmx_helper_link_autoconf(int xipd_port)
|
||||
{
|
||||
@ -2215,7 +2215,7 @@ cvmx_helper_link_info_t cvmx_helper_link_autoconf(int xipd_port)
|
||||
*
|
||||
* @param xipd_port IPD/PKO port to query
|
||||
*
|
||||
* @return Link state
|
||||
* Return: Link state
|
||||
*/
|
||||
cvmx_helper_link_info_t cvmx_helper_link_get(int xipd_port)
|
||||
{
|
||||
@ -2264,7 +2264,7 @@ cvmx_helper_link_info_t cvmx_helper_link_get(int xipd_port)
|
||||
* @param xipd_port IPD/PKO port to configure
|
||||
* @param link_info The new link state
|
||||
*
|
||||
* @return Zero on success, negative on failure
|
||||
* Return: Zero on success, negative on failure
|
||||
*/
|
||||
int cvmx_helper_link_set(int xipd_port, cvmx_helper_link_info_t link_info)
|
||||
{
|
||||
@ -2301,7 +2301,7 @@ int cvmx_helper_link_set(int xipd_port, cvmx_helper_link_info_t link_info)
|
||||
* @param enable_external
|
||||
* Non zero if you want external loopback
|
||||
*
|
||||
* @return Zero on success, negative on failure.
|
||||
* Return: Zero on success, negative on failure.
|
||||
*/
|
||||
int cvmx_helper_configure_loopback(int xipd_port, int enable_internal, int enable_external)
|
||||
{
|
||||
|
||||
@ -84,7 +84,7 @@ static uint32_t __cvmx_pcie_config_read32(int node, int pcie_port, int bus, int
|
||||
*
|
||||
* @param pcie_port PCIe port the IO is for
|
||||
*
|
||||
* @return 64bit Octeon IO base address for read/write
|
||||
* Return: 64bit Octeon IO base address for read/write
|
||||
*/
|
||||
uint64_t cvmx_pcie_get_io_base_address(int pcie_port)
|
||||
{
|
||||
@ -107,7 +107,7 @@ uint64_t cvmx_pcie_get_io_base_address(int pcie_port)
|
||||
*
|
||||
* @param pcie_port PCIe port the IO is for
|
||||
*
|
||||
* @return Size of the IO window
|
||||
* Return: Size of the IO window
|
||||
*/
|
||||
uint64_t cvmx_pcie_get_io_size(int pcie_port)
|
||||
{
|
||||
@ -120,7 +120,7 @@ uint64_t cvmx_pcie_get_io_size(int pcie_port)
|
||||
*
|
||||
* @param pcie_port PCIe port the IO is for
|
||||
*
|
||||
* @return 64bit Octeon IO base address for read/write
|
||||
* Return: 64bit Octeon IO base address for read/write
|
||||
*/
|
||||
uint64_t cvmx_pcie_get_mem_base_address(int pcie_port)
|
||||
{
|
||||
@ -141,7 +141,7 @@ uint64_t cvmx_pcie_get_mem_base_address(int pcie_port)
|
||||
*
|
||||
* @param pcie_port PCIe port the IO is for
|
||||
*
|
||||
* @return Size of the Mem window
|
||||
* Return: Size of the Mem window
|
||||
*/
|
||||
uint64_t cvmx_pcie_get_mem_size(int pcie_port)
|
||||
{
|
||||
@ -154,7 +154,7 @@ uint64_t cvmx_pcie_get_mem_size(int pcie_port)
|
||||
*
|
||||
* @param pcie_port QLM number to return for.
|
||||
*
|
||||
* @return QLM number.
|
||||
* Return: QLM number.
|
||||
*/
|
||||
static int __cvmx_pcie_get_qlm(int node, int pcie_port)
|
||||
{
|
||||
@ -751,7 +751,7 @@ static void __cvmx_pcie_gser_phy_config(int node, int pcie_port, int qlm)
|
||||
* @param node Node to query
|
||||
* @param pcie_port PEM to query
|
||||
*
|
||||
* @return LTSSM state
|
||||
* Return: LTSSM state
|
||||
*/
|
||||
static int __cvmx_pcie_rc_get_ltssm_state(int node, int pcie_port)
|
||||
{
|
||||
@ -794,7 +794,7 @@ static int __cvmx_pcie_rc_get_ltssm_state(int node, int pcie_port)
|
||||
* @param node Node to query
|
||||
* @param pcie_port PEM to query
|
||||
*
|
||||
* @return LTSSM state
|
||||
* Return: LTSSM state
|
||||
*/
|
||||
static const char *cvmx_pcie_get_ltssm_string(int ltssm)
|
||||
{
|
||||
@ -890,7 +890,7 @@ static const char *cvmx_pcie_get_ltssm_string(int ltssm)
|
||||
* @param func PCIe function on the device
|
||||
* @param reg Register to read
|
||||
*
|
||||
* @return Config register value, or all ones on failure
|
||||
* Return: Config register value, or all ones on failure
|
||||
*/
|
||||
static uint32_t cvmx_pcie_config_read32_retry(int node, int pcie_port, int bus, int dev, int func,
|
||||
int reg)
|
||||
@ -928,7 +928,7 @@ static uint32_t cvmx_pcie_config_read32_retry(int node, int pcie_port, int bus,
|
||||
* @param node node
|
||||
* @param pcie_port PCIe port to initialize
|
||||
*
|
||||
* @return Zero on success
|
||||
* Return: Zero on success
|
||||
*/
|
||||
static int __cvmx_pcie_rc_initialize_link_gen2(int node, int pcie_port)
|
||||
{
|
||||
@ -1185,7 +1185,7 @@ static void __cvmx_pcie_sli_config(int node, int pcie_port)
|
||||
*
|
||||
* @param pcie_port PCIe port to initialize
|
||||
*
|
||||
* @return Zero on success
|
||||
* Return: Zero on success
|
||||
*/
|
||||
static int __cvmx_pcie_rc_initialize_gen2(int pcie_port)
|
||||
{
|
||||
@ -1393,7 +1393,7 @@ static int __cvmx_pcie_rc_initialize_gen2(int pcie_port)
|
||||
* @param node node
|
||||
* @param pcie_port PCIe port to initialize
|
||||
*
|
||||
* @return Zero on success
|
||||
* Return: Zero on success
|
||||
*/
|
||||
static int __cvmx_pcie_rc_initialize_link_gen2_v3(int node, int pcie_port)
|
||||
{
|
||||
@ -2008,7 +2008,7 @@ static int __cvmx_pcie_rc_initialize_gen2_v3(int pcie_port)
|
||||
*
|
||||
* @param pcie_port PCIe port to initialize for a node
|
||||
*
|
||||
* @return Zero on success
|
||||
* Return: Zero on success
|
||||
*/
|
||||
int cvmx_pcie_rc_initialize(int pcie_port)
|
||||
{
|
||||
@ -2029,7 +2029,7 @@ int cvmx_pcie_rc_initialize(int pcie_port)
|
||||
*
|
||||
* @param pcie_port PCIe port to shutdown for a node
|
||||
*
|
||||
* @return Zero on success
|
||||
* Return: Zero on success
|
||||
*/
|
||||
int cvmx_pcie_rc_shutdown(int pcie_port)
|
||||
{
|
||||
@ -2076,7 +2076,7 @@ int cvmx_pcie_rc_shutdown(int pcie_port)
|
||||
* @param fn Device sub function
|
||||
* @param reg Register to access
|
||||
*
|
||||
* @return 64bit Octeon IO address
|
||||
* Return: 64bit Octeon IO address
|
||||
*/
|
||||
static uint64_t __cvmx_pcie_build_config_addr(int node, int port, int bus, int dev, int fn, int reg)
|
||||
{
|
||||
@ -2117,7 +2117,7 @@ static uint64_t __cvmx_pcie_build_config_addr(int node, int port, int bus, int d
|
||||
* @param fn Device sub function
|
||||
* @param reg Register to access
|
||||
*
|
||||
* @return Result of the read
|
||||
* Return: Result of the read
|
||||
*/
|
||||
uint8_t cvmx_pcie_config_read8(int pcie_port, int bus, int dev, int fn, int reg)
|
||||
{
|
||||
@ -2141,7 +2141,7 @@ uint8_t cvmx_pcie_config_read8(int pcie_port, int bus, int dev, int fn, int reg)
|
||||
* @param fn Device sub function
|
||||
* @param reg Register to access
|
||||
*
|
||||
* @return Result of the read
|
||||
* Return: Result of the read
|
||||
*/
|
||||
uint16_t cvmx_pcie_config_read16(int pcie_port, int bus, int dev, int fn, int reg)
|
||||
{
|
||||
@ -2183,7 +2183,7 @@ static uint32_t __cvmx_pcie_config_read32(int node, int pcie_port, int bus, int
|
||||
* @param fn Device sub function
|
||||
* @param reg Register to access
|
||||
*
|
||||
* @return Result of the read
|
||||
* Return: Result of the read
|
||||
*/
|
||||
uint32_t cvmx_pcie_config_read32(int pcie_port, int bus, int dev, int fn, int reg)
|
||||
{
|
||||
@ -2264,7 +2264,7 @@ void cvmx_pcie_config_write32(int pcie_port, int bus, int dev, int fn, int reg,
|
||||
* @param pcie_port PCIe port to read from
|
||||
* @param cfg_offset Address to read
|
||||
*
|
||||
* @return Value read
|
||||
* Return: Value read
|
||||
*/
|
||||
uint32_t cvmx_pcie_cfgx_read(int pcie_port, uint32_t cfg_offset)
|
||||
{
|
||||
@ -2313,7 +2313,7 @@ extern int cvmx_pcie_is_host_mode(int pcie_port);
|
||||
*
|
||||
* @param pcie_port PCIe port to initialize for a node
|
||||
*
|
||||
* @return Zero on success
|
||||
* Return: Zero on success
|
||||
*/
|
||||
int cvmx_pcie_ep_initialize(int pcie_port)
|
||||
{
|
||||
@ -2459,7 +2459,7 @@ void cvmx_pcie_wait_for_pending(int pcie_port)
|
||||
*
|
||||
* @param pcie_port PCIe port number (PEM number)
|
||||
*
|
||||
* @return 0 if PCIe port is in target mode, !0 if in host mode.
|
||||
* Return: 0 if PCIe port is in target mode, !0 if in host mode.
|
||||
*/
|
||||
int cvmx_pcie_is_host_mode(int pcie_port)
|
||||
{
|
||||
|
||||
@ -64,7 +64,7 @@ static qlm_jtag_uint32_t *__cvmx_qlm_jtag_xor_ref;
|
||||
/**
|
||||
* Return the number of QLMs supported by the chip
|
||||
*
|
||||
* @return Number of QLMs
|
||||
* Return: Number of QLMs
|
||||
*/
|
||||
int cvmx_qlm_get_num(void)
|
||||
{
|
||||
@ -92,7 +92,7 @@ int cvmx_qlm_get_num(void)
|
||||
*
|
||||
* @param xiface interface to look up
|
||||
*
|
||||
* @return the qlm number based on the xiface
|
||||
* Return: the qlm number based on the xiface
|
||||
*/
|
||||
int cvmx_qlm_interface(int xiface)
|
||||
{
|
||||
@ -130,7 +130,7 @@ int cvmx_qlm_interface(int xiface)
|
||||
* @param xiface interface to look up
|
||||
* @param index index in an interface
|
||||
*
|
||||
* @return the qlm number based on the xiface
|
||||
* Return: the qlm number based on the xiface
|
||||
*/
|
||||
int cvmx_qlm_lmac(int xiface, int index)
|
||||
{
|
||||
@ -281,7 +281,7 @@ int cvmx_qlm_lmac(int xiface, int index)
|
||||
*
|
||||
* @param BGX BGX to search for.
|
||||
*
|
||||
* @return muxes used 0 = DLM5+DLM6, 1 = DLM5, 2 = DLM6.
|
||||
* Return: muxes used 0 = DLM5+DLM6, 1 = DLM5, 2 = DLM6.
|
||||
*/
|
||||
int cvmx_qlm_mux_interface(int bgx)
|
||||
{
|
||||
@ -322,7 +322,7 @@ int cvmx_qlm_mux_interface(int bgx)
|
||||
*
|
||||
* @param qlm QLM to examine
|
||||
*
|
||||
* @return Number of lanes
|
||||
* Return: Number of lanes
|
||||
*/
|
||||
int cvmx_qlm_get_lanes(int qlm)
|
||||
{
|
||||
@ -340,7 +340,7 @@ int cvmx_qlm_get_lanes(int qlm)
|
||||
/**
|
||||
* Get the QLM JTAG fields based on Octeon model on the supported chips.
|
||||
*
|
||||
* @return qlm_jtag_field_t structure
|
||||
* Return: qlm_jtag_field_t structure
|
||||
*/
|
||||
const __cvmx_qlm_jtag_field_t *cvmx_qlm_jtag_get_field(void)
|
||||
{
|
||||
@ -361,7 +361,7 @@ const __cvmx_qlm_jtag_field_t *cvmx_qlm_jtag_get_field(void)
|
||||
* Get the QLM JTAG length by going through qlm_jtag_field for each
|
||||
* Octeon model that is supported
|
||||
*
|
||||
* @return return the length.
|
||||
* Return: return the length.
|
||||
*/
|
||||
int cvmx_qlm_jtag_get_length(void)
|
||||
{
|
||||
@ -394,7 +394,7 @@ void cvmx_qlm_init(void)
|
||||
*
|
||||
* @param name Name to lookup
|
||||
*
|
||||
* @return Field info, or NULL on failure
|
||||
* Return: Field info, or NULL on failure
|
||||
*/
|
||||
static const __cvmx_qlm_jtag_field_t *__cvmx_qlm_lookup_field(const char *name)
|
||||
{
|
||||
@ -417,7 +417,7 @@ static const __cvmx_qlm_jtag_field_t *__cvmx_qlm_lookup_field(const char *name)
|
||||
* @param lane Lane in QLM to get
|
||||
* @param name String name of field
|
||||
*
|
||||
* @return JTAG field value
|
||||
* Return: JTAG field value
|
||||
*/
|
||||
uint64_t cvmx_qlm_jtag_get(int qlm, int lane, const char *name)
|
||||
{
|
||||
@ -620,7 +620,7 @@ void __cvmx_qlm_pcie_cfg_rxd_set_tweak(int qlm, int lane)
|
||||
* @param node node of the QLM
|
||||
* @param qlm QLM to examine
|
||||
*
|
||||
* @return Speed in Mhz
|
||||
* Return: Speed in Mhz
|
||||
*/
|
||||
int cvmx_qlm_get_gbaud_mhz_node(int node, int qlm)
|
||||
{
|
||||
@ -723,7 +723,7 @@ int cvmx_qlm_get_gbaud_mhz_node(int node, int qlm)
|
||||
*
|
||||
* @param qlm QLM to examine
|
||||
*
|
||||
* @return Speed in Mhz
|
||||
* Return: Speed in Mhz
|
||||
*/
|
||||
int cvmx_qlm_get_gbaud_mhz(int qlm)
|
||||
{
|
||||
@ -1021,7 +1021,7 @@ static enum cvmx_qlm_mode __cvmx_qlm_get_mode_cn70xx(int qlm)
|
||||
* 1 - PCIe
|
||||
* 2 - SATA
|
||||
* @param interface interface to use
|
||||
* @return the qlm mode the interface is
|
||||
* Return: the qlm mode the interface is
|
||||
*/
|
||||
enum cvmx_qlm_mode cvmx_qlm_get_dlm_mode(int interface_type, int interface)
|
||||
{
|
||||
@ -1875,7 +1875,7 @@ int cvmx_qlm_measure_clock_cn7xxx(int node, int qlm)
|
||||
* @param node node to measure
|
||||
* @param qlm QLM to measure
|
||||
*
|
||||
* @return Clock rate in Hz
|
||||
* Return: Clock rate in Hz
|
||||
*/
|
||||
int cvmx_qlm_measure_clock_node(int node, int qlm)
|
||||
{
|
||||
@ -1890,7 +1890,7 @@ int cvmx_qlm_measure_clock_node(int node, int qlm)
|
||||
*
|
||||
* @param qlm QLM to measure
|
||||
*
|
||||
* @return Clock rate in Hz
|
||||
* Return: Clock rate in Hz
|
||||
*/
|
||||
int cvmx_qlm_measure_clock(int qlm)
|
||||
{
|
||||
@ -1972,7 +1972,7 @@ int cvmx_qlm_measure_clock(int qlm)
|
||||
* @param qlm QLM to perform RX equalization on
|
||||
* @param lane Lane to use, or -1 for all lanes
|
||||
*
|
||||
* @return Zero on success, negative if any lane failed RX equalization
|
||||
* Return: Zero on success, negative if any lane failed RX equalization
|
||||
*/
|
||||
int __cvmx_qlm_rx_equalization(int node, int qlm, int lane)
|
||||
{
|
||||
|
||||
@ -42,7 +42,7 @@ struct octeon_boot_args {
|
||||
* @param cmd command type
|
||||
* @param[out] boot_args parsed values
|
||||
*
|
||||
* @return number of arguments parsed
|
||||
* Return: number of arguments parsed
|
||||
*/
|
||||
int octeon_parse_bootopts(int argc, char *const argv[],
|
||||
enum octeon_boot_cmd_type cmd,
|
||||
|
||||
@ -128,7 +128,7 @@ int cvmx_bootmem_init(u64 mem_desc_addr);
|
||||
* @param size Size in bytes of block to allocate
|
||||
* @param alignment Alignment required - must be power of 2
|
||||
*
|
||||
* @return pointer to block of memory, NULL on error
|
||||
* Return: pointer to block of memory, NULL on error
|
||||
*/
|
||||
void *cvmx_bootmem_alloc(u64 size, u64 alignment);
|
||||
|
||||
@ -141,7 +141,7 @@ void *cvmx_bootmem_alloc(u64 size, u64 alignment);
|
||||
* @param size Size in bytes of block to allocate
|
||||
* @param alignment Alignment required - must be power of 2
|
||||
*
|
||||
* @return pointer to block of memory, NULL on error
|
||||
* Return: pointer to block of memory, NULL on error
|
||||
*/
|
||||
void *cvmx_bootmem_alloc_node(u64 node, u64 size, u64 alignment);
|
||||
|
||||
@ -156,7 +156,7 @@ void *cvmx_bootmem_alloc_node(u64 node, u64 size, u64 alignment);
|
||||
* @param address Physical address to allocate memory at. If this
|
||||
* memory is not available, the allocation fails.
|
||||
* @param alignment Alignment required - must be power of 2
|
||||
* @return pointer to block of memory, NULL on error
|
||||
* Return: pointer to block of memory, NULL on error
|
||||
*/
|
||||
void *cvmx_bootmem_alloc_address(u64 size, u64 address,
|
||||
u64 alignment);
|
||||
@ -172,7 +172,7 @@ void *cvmx_bootmem_alloc_address(u64 size, u64 address,
|
||||
* @param min_addr defines the minimum address of the range
|
||||
* @param max_addr defines the maximum address of the range
|
||||
* @param alignment Alignment required - must be power of 2
|
||||
* @return pointer to block of memory, NULL on error
|
||||
* Return: pointer to block of memory, NULL on error
|
||||
*/
|
||||
void *cvmx_bootmem_alloc_range(u64 size, u64 alignment,
|
||||
u64 min_addr, u64 max_addr);
|
||||
@ -187,7 +187,7 @@ void *cvmx_bootmem_alloc_range(u64 size, u64 alignment,
|
||||
* @param alignment Alignment required - must be power of 2
|
||||
* @param name name of block - must be less than CVMX_BOOTMEM_NAME_LEN bytes
|
||||
*
|
||||
* @return pointer to block of memory, NULL on error
|
||||
* Return: pointer to block of memory, NULL on error
|
||||
*/
|
||||
void *cvmx_bootmem_alloc_named(u64 size, u64 alignment,
|
||||
const char *name);
|
||||
@ -203,7 +203,7 @@ void *cvmx_bootmem_alloc_named(u64 size, u64 alignment,
|
||||
* @param name name of block - must be less than CVMX_BOOTMEM_NAME_LEN bytes
|
||||
* @param flags Flags to control options for the allocation.
|
||||
*
|
||||
* @return pointer to block of memory, NULL on error
|
||||
* Return: pointer to block of memory, NULL on error
|
||||
*/
|
||||
void *cvmx_bootmem_alloc_named_flags(u64 size, u64 alignment,
|
||||
const char *name, u32 flags);
|
||||
@ -219,7 +219,7 @@ void *cvmx_bootmem_alloc_named_flags(u64 size, u64 alignment,
|
||||
* memory is not available, the allocation fails.
|
||||
* @param name name of block - must be less than CVMX_BOOTMEM_NAME_LEN bytes
|
||||
*
|
||||
* @return pointer to block of memory, NULL on error
|
||||
* Return: pointer to block of memory, NULL on error
|
||||
*/
|
||||
void *cvmx_bootmem_alloc_named_address(u64 size, u64 address,
|
||||
const char *name);
|
||||
@ -238,7 +238,7 @@ void *cvmx_bootmem_alloc_named_address(u64 size, u64 address,
|
||||
* @param align Alignment of memory to be allocated. (must be a power of 2)
|
||||
* @param name name of block - must be less than CVMX_BOOTMEM_NAME_LEN bytes
|
||||
*
|
||||
* @return pointer to block of memory, NULL on error
|
||||
* Return: pointer to block of memory, NULL on error
|
||||
*/
|
||||
void *cvmx_bootmem_alloc_named_range(u64 size, u64 min_addr,
|
||||
u64 max_addr, u64 align,
|
||||
@ -263,7 +263,7 @@ void *cvmx_bootmem_alloc_named_range(u64 size, u64 min_addr,
|
||||
* The initialization function is optional, if omitted the named block
|
||||
* is initialized to all zeros when it is created, i.e. once.
|
||||
*
|
||||
* @return pointer to block of memory, NULL on error
|
||||
* Return: pointer to block of memory, NULL on error
|
||||
*/
|
||||
void *cvmx_bootmem_alloc_named_range_once(u64 size,
|
||||
u64 min_addr,
|
||||
@ -282,7 +282,7 @@ void *cvmx_bootmem_alloc_named_range_once(u64 size,
|
||||
* @param name Name to assign to reserved blocks
|
||||
* @param flags Flags to use when reserving memory
|
||||
*
|
||||
* @return 0 on failure,
|
||||
* Return: 0 on failure,
|
||||
* !0 on success
|
||||
*/
|
||||
int cvmx_bootmem_reserve_memory(u64 start_addr, u64 size,
|
||||
@ -293,7 +293,7 @@ int cvmx_bootmem_reserve_memory(u64 start_addr, u64 size,
|
||||
*
|
||||
* @param name name of block to free
|
||||
*
|
||||
* @return 0 on failure,
|
||||
* Return: 0 on failure,
|
||||
* !0 on success
|
||||
*/
|
||||
int cvmx_bootmem_free_named(const char *name);
|
||||
@ -303,7 +303,7 @@ int cvmx_bootmem_free_named(const char *name);
|
||||
*
|
||||
* @param name name of block to free
|
||||
*
|
||||
* @return pointer to named block descriptor on success
|
||||
* Return: pointer to named block descriptor on success
|
||||
* 0 on failure
|
||||
*/
|
||||
const struct cvmx_bootmem_named_block_desc *
|
||||
@ -317,7 +317,7 @@ cvmx_bootmem_find_named_block(const char *name);
|
||||
* @param min_block_size
|
||||
* Minimum block size to count in total.
|
||||
*
|
||||
* @return Number of bytes available for allocation that meet the
|
||||
* Return: Number of bytes available for allocation that meet the
|
||||
* block size requirement
|
||||
*/
|
||||
u64 cvmx_bootmem_available_mem(u64 min_block_size);
|
||||
@ -350,7 +350,7 @@ void cvmx_bootmem_print_named(void);
|
||||
* CVMX_BOOTMEM_ALIGNMENT_SIZE.)
|
||||
* @param flags Flags to control options for the allocation.
|
||||
*
|
||||
* @return physical address of block allocated, or -1 on failure
|
||||
* Return: physical address of block allocated, or -1 on failure
|
||||
*/
|
||||
s64 cvmx_bootmem_phy_alloc(u64 req_size, u64 address_min, u64 address_max,
|
||||
u64 alignment, u32 flags);
|
||||
@ -379,7 +379,7 @@ s64 cvmx_bootmem_phy_alloc(u64 req_size, u64 address_min, u64 address_max,
|
||||
*
|
||||
* @param flags Flags to control options for the allocation.
|
||||
*
|
||||
* @return physical address of block allocated, or -1 on failure
|
||||
* Return: physical address of block allocated, or -1 on failure
|
||||
*/
|
||||
s64 cvmx_bootmem_phy_named_block_alloc(u64 size, u64 min_addr, u64 max_addr,
|
||||
u64 alignment, const char *name,
|
||||
@ -394,7 +394,7 @@ s64 cvmx_bootmem_phy_named_block_alloc(u64 size, u64 min_addr, u64 max_addr,
|
||||
*
|
||||
* @param flags Flags to control options for the allocation.
|
||||
*
|
||||
* @return Physical address of the memory block descriptor, zero if not
|
||||
* Return: Physical address of the memory block descriptor, zero if not
|
||||
* found. If zero returned when name parameter is NULL, then no
|
||||
* memory block descriptors are available.
|
||||
*/
|
||||
@ -408,7 +408,7 @@ u64 cvmx_bootmem_phy_named_block_find(const char *name, u32 flags);
|
||||
* @param min_block_size
|
||||
* Minimum block size to count in total.
|
||||
*
|
||||
* @return Number of bytes available for allocation that meet the
|
||||
* Return: Number of bytes available for allocation that meet the
|
||||
* block size requirement
|
||||
*/
|
||||
u64 cvmx_bootmem_phy_available_mem(u64 min_block_size);
|
||||
@ -419,7 +419,7 @@ u64 cvmx_bootmem_phy_available_mem(u64 min_block_size);
|
||||
* @param name name of block to free
|
||||
* @param flags flags for passing options
|
||||
*
|
||||
* @return 0 on failure
|
||||
* Return: 0 on failure
|
||||
* 1 on success
|
||||
*/
|
||||
int cvmx_bootmem_phy_named_block_free(const char *name, u32 flags);
|
||||
@ -438,7 +438,7 @@ int cvmx_bootmem_phy_named_block_free(const char *name, u32 flags);
|
||||
* @param size size of block in bytes.
|
||||
* @param flags flags for passing options
|
||||
*
|
||||
* @return 1 on success,
|
||||
* Return: 1 on success,
|
||||
* 0 on failure
|
||||
*/
|
||||
int __cvmx_bootmem_phy_free(u64 phy_addr, u64 size, u32 flags);
|
||||
@ -467,7 +467,7 @@ void cvmx_bootmem_phy_list_print(void);
|
||||
* @param desc_buffer Buffer for the bootmem descriptor. This must be
|
||||
* a 32 bit addressable address.
|
||||
*
|
||||
* @return 1 on success
|
||||
* Return: 1 on success
|
||||
* 0 on failure
|
||||
*/
|
||||
s64 cvmx_bootmem_phy_mem_list_init(u64 mem_size, u32 low_reserved_bytes,
|
||||
@ -487,7 +487,7 @@ s64 cvmx_bootmem_phy_mem_list_init(u64 mem_size, u32 low_reserved_bytes,
|
||||
* @param desc_buffer Buffer for the bootmem descriptor. This must be
|
||||
* a 32 bit addressable address.
|
||||
*
|
||||
* @return 1 on success
|
||||
* Return: 1 on success
|
||||
* 0 on failure
|
||||
*/
|
||||
s64 cvmx_bootmem_phy_mem_list_init_multi(u8 nodemask, u32 mem_size[],
|
||||
|
||||
@ -154,7 +154,7 @@ cvmx_cmd_queue_result_t __cvmx_cmd_queue_write_raw(cvmx_cmd_queue_id_t queue_id,
|
||||
* @param fpa_pool FPA pool the command queues should come from.
|
||||
* @param pool_size Size of each buffer in the FPA pool (bytes)
|
||||
*
|
||||
* @return CVMX_CMD_QUEUE_SUCCESS or a failure code
|
||||
* Return: CVMX_CMD_QUEUE_SUCCESS or a failure code
|
||||
*/
|
||||
cvmx_cmd_queue_result_t cvmx_cmd_queue_initialize(cvmx_cmd_queue_id_t queue_id, int max_depth,
|
||||
int fpa_pool, int pool_size);
|
||||
@ -166,7 +166,7 @@ cvmx_cmd_queue_result_t cvmx_cmd_queue_initialize(cvmx_cmd_queue_id_t queue_id,
|
||||
*
|
||||
* @param queue_id Queue to shutdown
|
||||
*
|
||||
* @return CVMX_CMD_QUEUE_SUCCESS or a failure code
|
||||
* Return: CVMX_CMD_QUEUE_SUCCESS or a failure code
|
||||
*/
|
||||
cvmx_cmd_queue_result_t cvmx_cmd_queue_shutdown(cvmx_cmd_queue_id_t queue_id);
|
||||
|
||||
@ -176,7 +176,7 @@ cvmx_cmd_queue_result_t cvmx_cmd_queue_shutdown(cvmx_cmd_queue_id_t queue_id);
|
||||
*
|
||||
* @param queue_id Hardware command queue to query
|
||||
*
|
||||
* @return Number of outstanding commands
|
||||
* Return: Number of outstanding commands
|
||||
*/
|
||||
int cvmx_cmd_queue_length(cvmx_cmd_queue_id_t queue_id);
|
||||
|
||||
@ -188,7 +188,7 @@ int cvmx_cmd_queue_length(cvmx_cmd_queue_id_t queue_id);
|
||||
*
|
||||
* @param queue_id Command queue to query
|
||||
*
|
||||
* @return Command buffer or NULL on failure
|
||||
* Return: Command buffer or NULL on failure
|
||||
*/
|
||||
void *cvmx_cmd_queue_buffer(cvmx_cmd_queue_id_t queue_id);
|
||||
|
||||
@ -204,7 +204,7 @@ cvmx_cmd_queue_result_t __cvmx_cmd_queue_init_state_ptr(unsigned int node);
|
||||
*
|
||||
* @param queue_id Queue ID to get an index for
|
||||
*
|
||||
* @return Index into the state arrays
|
||||
* Return: Index into the state arrays
|
||||
*/
|
||||
static inline unsigned int __cvmx_cmd_queue_get_index(cvmx_cmd_queue_id_t queue_id)
|
||||
{
|
||||
@ -270,7 +270,7 @@ static inline void __cvmx_cmd_queue_lock_init(cvmx_cmd_queue_id_t queue_id)
|
||||
*
|
||||
* @param queue_id Queue id to get
|
||||
*
|
||||
* @return Queue structure or NULL on failure
|
||||
* Return: Queue structure or NULL on failure
|
||||
*/
|
||||
static inline __cvmx_cmd_queue_state_t *__cvmx_cmd_queue_get_state(cvmx_cmd_queue_id_t queue_id)
|
||||
{
|
||||
@ -301,7 +301,7 @@ static inline __cvmx_cmd_queue_state_t *__cvmx_cmd_queue_get_state(cvmx_cmd_queu
|
||||
* @param cmd_count Number of command words to write
|
||||
* @param cmds Array of commands to write
|
||||
*
|
||||
* @return CVMX_CMD_QUEUE_SUCCESS or a failure code
|
||||
* Return: CVMX_CMD_QUEUE_SUCCESS or a failure code
|
||||
*/
|
||||
static inline cvmx_cmd_queue_result_t
|
||||
cvmx_cmd_queue_write(cvmx_cmd_queue_id_t queue_id, bool use_locking, int cmd_count, const u64 *cmds)
|
||||
@ -348,7 +348,7 @@ cvmx_cmd_queue_write(cvmx_cmd_queue_id_t queue_id, bool use_locking, int cmd_cou
|
||||
* @param cmd1 Command
|
||||
* @param cmd2 Command
|
||||
*
|
||||
* @return CVMX_CMD_QUEUE_SUCCESS or a failure code
|
||||
* Return: CVMX_CMD_QUEUE_SUCCESS or a failure code
|
||||
*/
|
||||
static inline cvmx_cmd_queue_result_t cvmx_cmd_queue_write2(cvmx_cmd_queue_id_t queue_id,
|
||||
bool use_locking, u64 cmd1, u64 cmd2)
|
||||
@ -399,7 +399,7 @@ static inline cvmx_cmd_queue_result_t cvmx_cmd_queue_write2(cvmx_cmd_queue_id_t
|
||||
* @param cmd2 Command
|
||||
* @param cmd3 Command
|
||||
*
|
||||
* @return CVMX_CMD_QUEUE_SUCCESS or a failure code
|
||||
* Return: CVMX_CMD_QUEUE_SUCCESS or a failure code
|
||||
*/
|
||||
static inline cvmx_cmd_queue_result_t
|
||||
cvmx_cmd_queue_write3(cvmx_cmd_queue_id_t queue_id, bool use_locking, u64 cmd1, u64 cmd2, u64 cmd3)
|
||||
|
||||
@ -101,7 +101,7 @@ struct cvmx_coremask {
|
||||
* @param node starting node number
|
||||
* @param node_mask node mask to use to find the next node
|
||||
*
|
||||
* @return next node number or -1 if no more nodes are available
|
||||
* Return: next node number or -1 if no more nodes are available
|
||||
*/
|
||||
static inline int cvmx_coremask_next_node(int node, u8 node_mask)
|
||||
{
|
||||
@ -132,7 +132,7 @@ static inline int cvmx_coremask_next_node(int node, u8 node_mask)
|
||||
*
|
||||
* @param pcm is the pointer to the coremask.
|
||||
* @param core
|
||||
* @return 1 if core is set and 0 if not.
|
||||
* Return: 1 if core is set and 0 if not.
|
||||
*/
|
||||
static inline int cvmx_coremask_is_core_set(const struct cvmx_coremask *pcm,
|
||||
int core)
|
||||
@ -149,7 +149,7 @@ static inline int cvmx_coremask_is_core_set(const struct cvmx_coremask *pcm,
|
||||
* Is ``current core'' set in the coremask?
|
||||
*
|
||||
* @param pcm is the pointer to the coremask.
|
||||
* @return 1 if core is set and 0 if not.
|
||||
* Return: 1 if core is set and 0 if not.
|
||||
*/
|
||||
static inline int cvmx_coremask_is_self_set(const struct cvmx_coremask *pcm)
|
||||
{
|
||||
@ -159,7 +159,7 @@ static inline int cvmx_coremask_is_self_set(const struct cvmx_coremask *pcm)
|
||||
/**
|
||||
* Is coremask empty?
|
||||
* @param pcm is the pointer to the coremask.
|
||||
* @return 1 if *pcm is empty (all zeros), 0 if not empty.
|
||||
* Return: 1 if *pcm is empty (all zeros), 0 if not empty.
|
||||
*/
|
||||
static inline int cvmx_coremask_is_empty(const struct cvmx_coremask *pcm)
|
||||
{
|
||||
@ -177,7 +177,7 @@ static inline int cvmx_coremask_is_empty(const struct cvmx_coremask *pcm)
|
||||
*
|
||||
* @param pcm is the pointer to the coremask.
|
||||
* @param core
|
||||
* @return 0.
|
||||
* Return: 0.
|
||||
*/
|
||||
static inline int cvmx_coremask_set_core(struct cvmx_coremask *pcm, int core)
|
||||
{
|
||||
@ -194,7 +194,7 @@ static inline int cvmx_coremask_set_core(struct cvmx_coremask *pcm, int core)
|
||||
* Set ``current core'' in the coremask.
|
||||
*
|
||||
* @param pcm is the pointer to the coremask.
|
||||
* @return 0.
|
||||
* Return: 0.
|
||||
*/
|
||||
static inline int cvmx_coremask_set_self(struct cvmx_coremask *pcm)
|
||||
{
|
||||
@ -206,7 +206,7 @@ static inline int cvmx_coremask_set_self(struct cvmx_coremask *pcm)
|
||||
*
|
||||
* @param pcm is the pointer to the coremask.
|
||||
* @param core
|
||||
* @return 0.
|
||||
* Return: 0.
|
||||
*/
|
||||
static inline int cvmx_coremask_clear_core(struct cvmx_coremask *pcm, int core)
|
||||
{
|
||||
@ -223,7 +223,7 @@ static inline int cvmx_coremask_clear_core(struct cvmx_coremask *pcm, int core)
|
||||
* Clear ``current core'' from the coremask.
|
||||
*
|
||||
* @param pcm is the pointer to the coremask.
|
||||
* @return 0.
|
||||
* Return: 0.
|
||||
*/
|
||||
static inline int cvmx_coremask_clear_self(struct cvmx_coremask *pcm)
|
||||
{
|
||||
@ -235,7 +235,7 @@ static inline int cvmx_coremask_clear_self(struct cvmx_coremask *pcm)
|
||||
*
|
||||
* @param pcm is the pointer to the coremask.
|
||||
* @param core
|
||||
* @return 0.
|
||||
* Return: 0.
|
||||
*/
|
||||
static inline int cvmx_coremask_toggle_core(struct cvmx_coremask *pcm, int core)
|
||||
{
|
||||
@ -252,7 +252,7 @@ static inline int cvmx_coremask_toggle_core(struct cvmx_coremask *pcm, int core)
|
||||
* Toggle ``current core'' in the coremask.
|
||||
*
|
||||
* @param pcm is the pointer to the coremask.
|
||||
* @return 0.
|
||||
* Return: 0.
|
||||
*/
|
||||
static inline int cvmx_coremask_toggle_self(struct cvmx_coremask *pcm)
|
||||
{
|
||||
@ -288,7 +288,7 @@ static inline void cvmx_coremask_set64_node(struct cvmx_coremask *pcm,
|
||||
* Gets the lower 64-bits of the coremask
|
||||
*
|
||||
* @param[in] pcm - pointer to coremask
|
||||
* @return 64-bit coremask for the first node
|
||||
* Return: 64-bit coremask for the first node
|
||||
*/
|
||||
static inline u64 cvmx_coremask_get64(const struct cvmx_coremask *pcm)
|
||||
{
|
||||
@ -300,7 +300,7 @@ static inline u64 cvmx_coremask_get64(const struct cvmx_coremask *pcm)
|
||||
*
|
||||
* @param[in] pcm - pointer to coremask
|
||||
* @param node - node to get coremask for
|
||||
* @return 64-bit coremask for the first node
|
||||
* Return: 64-bit coremask for the first node
|
||||
*/
|
||||
static inline u64 cvmx_coremask_get64_node(const struct cvmx_coremask *pcm,
|
||||
u8 node)
|
||||
@ -312,7 +312,7 @@ static inline u64 cvmx_coremask_get64_node(const struct cvmx_coremask *pcm,
|
||||
* Gets the lower 32-bits of the coremask for compatibility
|
||||
*
|
||||
* @param[in] pcm - pointer to coremask
|
||||
* @return 32-bit coremask for the first node
|
||||
* Return: 32-bit coremask for the first node
|
||||
* @deprecated This function is to maintain compatibility with older
|
||||
* SDK applications and may disappear at some point.
|
||||
* This function is not compatible with the CN78XX or any other
|
||||
@ -515,7 +515,7 @@ static inline int cvmx_coremask_get_first_core(const struct cvmx_coremask *pcm)
|
||||
* @param core - starting core to check (can be -1 for core 0)
|
||||
* @param pcm - pointer to coremask to check for the next core.
|
||||
*
|
||||
* @return next core following the core parameter or -1 if no more cores.
|
||||
* Return: next core following the core parameter or -1 if no more cores.
|
||||
*/
|
||||
static inline int cvmx_coremask_next_core(int core,
|
||||
const struct cvmx_coremask *pcm)
|
||||
@ -597,7 +597,7 @@ static inline void cvmx_coremask_copy(struct cvmx_coremask *dest,
|
||||
* @param[in] pcm pointer to the coremask to test against
|
||||
* @param[in] core core to check
|
||||
*
|
||||
* @return 1 if the core is first core in the coremask, 0 otherwise
|
||||
* Return: 1 if the core is first core in the coremask, 0 otherwise
|
||||
*
|
||||
*/
|
||||
static inline int cvmx_coremask_is_core_first_core(const struct cvmx_coremask *pcm,
|
||||
@ -634,7 +634,7 @@ static inline int cvmx_coremask_is_core_first_core(const struct cvmx_coremask *p
|
||||
*
|
||||
* @param[in] pcm - pointer to core mask
|
||||
*
|
||||
* @return number of bits set in the coremask
|
||||
* Return: number of bits set in the coremask
|
||||
*/
|
||||
static inline int cvmx_coremask_get_core_count(const struct cvmx_coremask *pcm)
|
||||
{
|
||||
@ -652,7 +652,7 @@ static inline int cvmx_coremask_get_core_count(const struct cvmx_coremask *pcm)
|
||||
*
|
||||
* @param core - core number (0-1023)
|
||||
*
|
||||
* @return node number core belongs to
|
||||
* Return: node number core belongs to
|
||||
*/
|
||||
static inline int cvmx_coremask_core_to_node(int core)
|
||||
{
|
||||
@ -678,7 +678,7 @@ static inline int cvmx_coremask_core_on_node(int core)
|
||||
* @param main - main coremask to test
|
||||
* @param subset - subset coremask to test
|
||||
*
|
||||
* @return 0 if the subset contains cores not in the main coremask or 1 if
|
||||
* Return: 0 if the subset contains cores not in the main coremask or 1 if
|
||||
* the subset is fully contained in the main coremask.
|
||||
*/
|
||||
static inline int cvmx_coremask_is_subset(const struct cvmx_coremask *main,
|
||||
@ -699,7 +699,7 @@ static inline int cvmx_coremask_is_subset(const struct cvmx_coremask *main,
|
||||
* @param c1 - main coremask to test
|
||||
* @param c2 - subset coremask to test
|
||||
*
|
||||
* @return 1 if coremask c1 intersects coremask c2, 0 if they are exclusive
|
||||
* Return: 1 if coremask c1 intersects coremask c2, 0 if they are exclusive
|
||||
*/
|
||||
static inline int cvmx_coremask_intersects(const struct cvmx_coremask *c1,
|
||||
const struct cvmx_coremask *c2)
|
||||
@ -735,7 +735,7 @@ static inline void cvmx_coremask_mask_node(struct cvmx_coremask *pcm, int node)
|
||||
*
|
||||
* @param[in] pcm - pointer to core mask
|
||||
*
|
||||
* @return nothing
|
||||
* Return: nothing
|
||||
*/
|
||||
void cvmx_coremask_print(const struct cvmx_coremask *pcm);
|
||||
|
||||
|
||||
@ -90,7 +90,7 @@ typedef struct cvmx_error_info {
|
||||
*
|
||||
* @param flags Optional flags.
|
||||
*
|
||||
* @return Zero on success, negative on failure.
|
||||
* Return: Zero on success, negative on failure.
|
||||
*/
|
||||
int cvmx_error_initialize(void);
|
||||
|
||||
@ -99,7 +99,7 @@ int cvmx_error_initialize(void);
|
||||
* handlers. This should be called in the RSL interrupt handler
|
||||
* for your application or operating system.
|
||||
*
|
||||
* @return Number of error handlers called. Zero means this call
|
||||
* Return: Number of error handlers called. Zero means this call
|
||||
* found no errors and was spurious.
|
||||
*/
|
||||
int cvmx_error_poll(void);
|
||||
@ -116,7 +116,7 @@ int cvmx_error_poll(void);
|
||||
* call. All members of the structure must be populated, even the
|
||||
* parent information.
|
||||
*
|
||||
* @return Zero on success, negative on failure.
|
||||
* Return: Zero on success, negative on failure.
|
||||
*/
|
||||
int cvmx_error_add(const cvmx_error_info_t *new_info);
|
||||
|
||||
@ -136,7 +136,7 @@ int cvmx_error_add(const cvmx_error_info_t *new_info);
|
||||
* @param old_info If not NULL, this is filled with information about the handler
|
||||
* that was removed.
|
||||
*
|
||||
* @return Zero on success, negative on failure (not found).
|
||||
* Return: Zero on success, negative on failure (not found).
|
||||
*/
|
||||
int cvmx_error_remove(cvmx_error_register_t reg_type, u64 status_addr, u64 status_mask,
|
||||
cvmx_error_info_t *old_info);
|
||||
@ -160,7 +160,7 @@ int cvmx_error_remove(cvmx_error_register_t reg_type, u64 status_addr, u64 statu
|
||||
* @param old_user_info
|
||||
* If not NULL, the old user info parameter.
|
||||
*
|
||||
* @return Zero on success, negative on failure
|
||||
* Return: Zero on success, negative on failure
|
||||
*/
|
||||
int cvmx_error_change_handler(cvmx_error_register_t reg_type, u64 status_addr, u64 status_mask,
|
||||
cvmx_error_func_t new_func, u64 new_user_info,
|
||||
@ -175,7 +175,7 @@ int cvmx_error_change_handler(cvmx_error_register_t reg_type, u64 status_addr, u
|
||||
* Index for the group as defined in the cvmx_error_group_t
|
||||
* comments.
|
||||
*
|
||||
* @return Zero on success, negative on failure.
|
||||
* Return: Zero on success, negative on failure.
|
||||
*/
|
||||
/*
|
||||
* Rather than conditionalize the calls throughout the executive to not enable
|
||||
@ -197,7 +197,7 @@ static inline int cvmx_error_enable_group(cvmx_error_group_t group, int group_in
|
||||
* Index for the group as defined in the cvmx_error_group_t
|
||||
* comments.
|
||||
*
|
||||
* @return Zero on success, negative on failure.
|
||||
* Return: Zero on success, negative on failure.
|
||||
*/
|
||||
/*
|
||||
* Rather than conditionalize the calls throughout the executive to not disable
|
||||
@ -218,7 +218,7 @@ static inline int cvmx_error_disable_group(cvmx_error_group_t group, int group_i
|
||||
* All handlers for this status register with this mask will be
|
||||
* enabled.
|
||||
*
|
||||
* @return Zero on success, negative on failure.
|
||||
* Return: Zero on success, negative on failure.
|
||||
*/
|
||||
int cvmx_error_enable(cvmx_error_register_t reg_type, u64 status_addr, u64 status_mask);
|
||||
|
||||
@ -232,7 +232,7 @@ int cvmx_error_enable(cvmx_error_register_t reg_type, u64 status_addr, u64 statu
|
||||
* All handlers for this status register with this mask will be
|
||||
* disabled.
|
||||
*
|
||||
* @return Zero on success, negative on failure.
|
||||
* Return: Zero on success, negative on failure.
|
||||
*/
|
||||
int cvmx_error_disable(cvmx_error_register_t reg_type, u64 status_addr, u64 status_mask);
|
||||
|
||||
@ -244,7 +244,7 @@ int cvmx_error_disable(cvmx_error_register_t reg_type, u64 status_addr, u64 stat
|
||||
*
|
||||
* @param info Error register to check
|
||||
*
|
||||
* @return Number of error status bits found or zero if no bits were set.
|
||||
* Return: Number of error status bits found or zero if no bits were set.
|
||||
*/
|
||||
int __cvmx_error_decode(const cvmx_error_info_t *info);
|
||||
|
||||
@ -264,7 +264,7 @@ int __cvmx_error_display(const cvmx_error_info_t *info);
|
||||
* @param status_addr
|
||||
* Status register address
|
||||
*
|
||||
* @return Return the handler on success or null on failure.
|
||||
* Return: Return the handler on success or null on failure.
|
||||
*/
|
||||
cvmx_error_info_t *cvmx_error_get_index(u64 status_addr);
|
||||
|
||||
@ -279,7 +279,7 @@ void __cvmx_install_gmx_error_handler_for_xaui(void);
|
||||
* @param key INTSN value to search for
|
||||
* @param data current entry from the searched array
|
||||
*
|
||||
* @return Negative, 0 or positive when respectively key is less than,
|
||||
* Return: Negative, 0 or positive when respectively key is less than,
|
||||
* equal or greater than data.
|
||||
*/
|
||||
int cvmx_error_intsn_cmp(const void *key, const void *data);
|
||||
@ -291,7 +291,7 @@ int cvmx_error_intsn_cmp(const void *key, const void *data);
|
||||
*
|
||||
* @param node Node number
|
||||
*
|
||||
* @return Zero on success, -1 on error
|
||||
* Return: Zero on success, -1 on error
|
||||
*/
|
||||
int cvmx_error_intsn_display_v3(int node, u32 intsn);
|
||||
|
||||
@ -302,7 +302,7 @@ int cvmx_error_intsn_display_v3(int node, u32 intsn);
|
||||
*
|
||||
* @param node Node number
|
||||
*
|
||||
* @return Zero on success, negative on failure.
|
||||
* Return: Zero on success, negative on failure.
|
||||
*/
|
||||
int cvmx_error_initialize_cn78xx(int node);
|
||||
|
||||
@ -312,7 +312,7 @@ int cvmx_error_initialize_cn78xx(int node);
|
||||
* @param node Node number
|
||||
* @param intsn Interrupt source number
|
||||
*
|
||||
* @return Zero on success, negative on failure.
|
||||
* Return: Zero on success, negative on failure.
|
||||
*/
|
||||
int cvmx_error_intsn_enable_v3(int node, u32 intsn);
|
||||
|
||||
@ -322,7 +322,7 @@ int cvmx_error_intsn_enable_v3(int node, u32 intsn);
|
||||
* @param node Node number
|
||||
* @param intsn Interrupt source number
|
||||
*
|
||||
* @return Zero on success, negative on failure.
|
||||
* Return: Zero on success, negative on failure.
|
||||
*/
|
||||
int cvmx_error_intsn_disable_v3(int node, u32 intsn);
|
||||
|
||||
@ -331,7 +331,7 @@ int cvmx_error_intsn_disable_v3(int node, u32 intsn);
|
||||
*
|
||||
* @param intsn Interrupt source number
|
||||
*
|
||||
* @return Zero on success, negative on failure.
|
||||
* Return: Zero on success, negative on failure.
|
||||
*/
|
||||
int cvmx_error_intsn_clear_v3(int node, u32 intsn);
|
||||
|
||||
@ -341,7 +341,7 @@ int cvmx_error_intsn_clear_v3(int node, u32 intsn);
|
||||
* @param node Node number
|
||||
* @param csr_address CSR address
|
||||
*
|
||||
* @return Zero on success, negative on failure.
|
||||
* Return: Zero on success, negative on failure.
|
||||
*/
|
||||
int cvmx_error_csr_enable_v3(int node, u64 csr_address);
|
||||
|
||||
@ -351,7 +351,7 @@ int cvmx_error_csr_enable_v3(int node, u64 csr_address);
|
||||
* @param node Node number
|
||||
* @param csr_address CSR address
|
||||
*
|
||||
* @return Zero
|
||||
* Return: Zero
|
||||
*/
|
||||
int cvmx_error_csr_disable_v3(int node, u64 csr_address);
|
||||
|
||||
@ -362,7 +362,7 @@ int cvmx_error_csr_disable_v3(int node, u64 csr_address);
|
||||
* @param group Logical group to enable
|
||||
* @param xipd_port The IPD port value
|
||||
*
|
||||
* @return Zero.
|
||||
* Return: Zero.
|
||||
*/
|
||||
int cvmx_error_enable_group_v3(cvmx_error_group_t group, int xipd_port);
|
||||
|
||||
@ -372,7 +372,7 @@ int cvmx_error_enable_group_v3(cvmx_error_group_t group, int xipd_port);
|
||||
* @param group Logical group to enable
|
||||
* @param xipd_port The IPD port value
|
||||
*
|
||||
* @return Zero.
|
||||
* Return: Zero.
|
||||
*/
|
||||
int cvmx_error_disable_group_v3(cvmx_error_group_t group, int xipd_port);
|
||||
|
||||
@ -384,7 +384,7 @@ int cvmx_error_disable_group_v3(cvmx_error_group_t group, int xipd_port);
|
||||
* @param type Category in a logical group to enable
|
||||
* @param xipd_port The IPD port value
|
||||
*
|
||||
* @return Zero.
|
||||
* Return: Zero.
|
||||
*/
|
||||
int cvmx_error_enable_group_type_v3(cvmx_error_group_t group, cvmx_error_type_t type,
|
||||
int xipd_port);
|
||||
@ -397,7 +397,7 @@ int cvmx_error_enable_group_type_v3(cvmx_error_group_t group, cvmx_error_type_t
|
||||
* @param type Category in a logical group to disable
|
||||
* @param xipd_port The IPD port value
|
||||
*
|
||||
* @return Zero.
|
||||
* Return: Zero.
|
||||
*/
|
||||
int cvmx_error_disable_group_type_v3(cvmx_error_group_t group, cvmx_error_type_t type,
|
||||
int xipd_port);
|
||||
@ -408,7 +408,7 @@ int cvmx_error_disable_group_type_v3(cvmx_error_group_t group, cvmx_error_type_t
|
||||
* @param group Logical group to disable
|
||||
* @param xipd_port The IPD port value
|
||||
*
|
||||
* @return Zero.
|
||||
* Return: Zero.
|
||||
*/
|
||||
int cvmx_error_clear_group_v3(cvmx_error_group_t group, int xipd_port);
|
||||
|
||||
@ -418,7 +418,7 @@ int cvmx_error_clear_group_v3(cvmx_error_group_t group, int xipd_port);
|
||||
* @param node CCPI node
|
||||
* @param type category to enable
|
||||
*
|
||||
*@return Zero.
|
||||
*Return: Zero.
|
||||
*/
|
||||
int cvmx_error_enable_type_v3(int node, cvmx_error_type_t type);
|
||||
|
||||
@ -428,7 +428,7 @@ int cvmx_error_enable_type_v3(int node, cvmx_error_type_t type);
|
||||
* @param node CCPI node
|
||||
* @param type category to disable
|
||||
*
|
||||
*@return Zero.
|
||||
*Return: Zero.
|
||||
*/
|
||||
int cvmx_error_disable_type_v3(int node, cvmx_error_type_t type);
|
||||
|
||||
@ -449,7 +449,7 @@ int __cvmx_cn7xxx_l2c_l2d_ecc_error_display(int node, int intsn);
|
||||
* @param intsn intsn from error array.
|
||||
* @param remote true for remote node (cn78xx only)
|
||||
*
|
||||
* @return 1 if handled, 0 if not handled
|
||||
* Return: 1 if handled, 0 if not handled
|
||||
*/
|
||||
int __cvmx_cn7xxx_l2c_tag_error_display(int node, int intsn, bool remote);
|
||||
|
||||
|
||||
@ -36,7 +36,7 @@ typedef struct cvmx_fpa_pool_config cvmx_fpa_pool_config_t;
|
||||
* Return the name of the pool
|
||||
*
|
||||
* @param pool_num Pool to get the name of
|
||||
* @return The name
|
||||
* Return: The name
|
||||
*/
|
||||
const char *cvmx_fpa_get_name(int pool_num);
|
||||
|
||||
@ -97,7 +97,7 @@ static inline cvmx_fpa3_gaura_t cvmx_fpa1_pool_to_fpa3_aura(cvmx_fpa1_pool_t poo
|
||||
* Get a new block from the FPA
|
||||
*
|
||||
* @param pool Pool to get the block from
|
||||
* @return Pointer to the block or NULL on failure
|
||||
* Return: Pointer to the block or NULL on failure
|
||||
*/
|
||||
static inline void *cvmx_fpa_alloc(u64 pool)
|
||||
{
|
||||
@ -135,7 +135,7 @@ static inline void cvmx_fpa_async_alloc(u64 scr_addr, u64 pool)
|
||||
* @param pool Pool the block came from. Must be the same value
|
||||
* passed to cvmx_fpa_async_alloc.
|
||||
*
|
||||
* @return Pointer to the block or NULL on failure
|
||||
* Return: Pointer to the block or NULL on failure
|
||||
*/
|
||||
static inline void *cvmx_fpa_async_alloc_finish(u64 scr_addr, u64 pool)
|
||||
{
|
||||
@ -194,7 +194,7 @@ static inline void cvmx_fpa_free(void *ptr, u64 pool, u64 num_cache_lines)
|
||||
* @param block_size Size for each block controlled by the FPA
|
||||
* @param num_blocks Number of blocks
|
||||
*
|
||||
* @return the pool number on Success,
|
||||
* Return: the pool number on Success,
|
||||
* -1 on failure
|
||||
*/
|
||||
int cvmx_fpa_setup_pool(int pool, const char *name, void *buffer, u64 block_size, u64 num_blocks);
|
||||
@ -204,7 +204,7 @@ int cvmx_fpa_shutdown_pool(int pool);
|
||||
/**
|
||||
* Gets the block size of buffer in specified pool
|
||||
* @param pool Pool to get the block size from
|
||||
* @return Size of buffer in specified pool
|
||||
* Return: Size of buffer in specified pool
|
||||
*/
|
||||
unsigned int cvmx_fpa_get_block_size(int pool);
|
||||
|
||||
|
||||
@ -38,7 +38,7 @@ typedef union {
|
||||
*
|
||||
* @param pool FPA pool to allocate/reserve. If -1 it
|
||||
* finds an empty pool to allocate.
|
||||
* @return Alloctaed pool number or CVMX_FPA1_POOL_INVALID
|
||||
* Return: Alloctaed pool number or CVMX_FPA1_POOL_INVALID
|
||||
* if fails to allocate the pool
|
||||
*/
|
||||
cvmx_fpa1_pool_t cvmx_fpa1_reserve_pool(cvmx_fpa1_pool_t pool);
|
||||
@ -46,7 +46,7 @@ cvmx_fpa1_pool_t cvmx_fpa1_reserve_pool(cvmx_fpa1_pool_t pool);
|
||||
/**
|
||||
* Free the specified fpa pool.
|
||||
* @param pool Pool to free
|
||||
* @return 0 for success -1 failure
|
||||
* Return: 0 for success -1 failure
|
||||
*/
|
||||
int cvmx_fpa1_release_pool(cvmx_fpa1_pool_t pool);
|
||||
|
||||
@ -173,7 +173,7 @@ static inline void cvmx_fpa1_async_alloc(u64 scr_addr, cvmx_fpa1_pool_t pool)
|
||||
* @param pool Pool the block came from. Must be the same value
|
||||
* passed to cvmx_fpa_async_alloc.
|
||||
*
|
||||
* @return Pointer to the block or NULL on failure
|
||||
* Return: Pointer to the block or NULL on failure
|
||||
*/
|
||||
static inline void *cvmx_fpa1_async_alloc_finish(u64 scr_addr, cvmx_fpa1_pool_t pool)
|
||||
{
|
||||
|
||||
@ -206,7 +206,7 @@ static inline cvmx_fpa3_pool_t cvmx_fpa3_aura_to_pool(cvmx_fpa3_gaura_t aura)
|
||||
* Get a new block from the FPA pool
|
||||
*
|
||||
* @param aura - aura number
|
||||
* @return pointer to the block or NULL on failure
|
||||
* Return: pointer to the block or NULL on failure
|
||||
*/
|
||||
static inline void *cvmx_fpa3_alloc(cvmx_fpa3_gaura_t aura)
|
||||
{
|
||||
@ -267,7 +267,7 @@ static inline void cvmx_fpa3_async_alloc(u64 scr_addr, cvmx_fpa3_gaura_t aura)
|
||||
* @param aura Global aura the block came from. Must be the same value
|
||||
* passed to cvmx_fpa_async_alloc.
|
||||
*
|
||||
* @return Pointer to the block or NULL on failure
|
||||
* Return: Pointer to the block or NULL on failure
|
||||
*/
|
||||
static inline void *cvmx_fpa3_async_alloc_finish(u64 scr_addr, cvmx_fpa3_gaura_t aura)
|
||||
{
|
||||
@ -376,7 +376,7 @@ static inline int cvmx_fpa3_config_red_params(unsigned int node, int qos_avg_en,
|
||||
* Gets the buffer size of the specified pool,
|
||||
*
|
||||
* @param aura Global aura number
|
||||
* @return Returns size of the buffers in the specified pool.
|
||||
* Return: Returns size of the buffers in the specified pool.
|
||||
*/
|
||||
static inline int cvmx_fpa3_get_aura_buf_size(cvmx_fpa3_gaura_t aura)
|
||||
{
|
||||
@ -395,7 +395,7 @@ static inline int cvmx_fpa3_get_aura_buf_size(cvmx_fpa3_gaura_t aura)
|
||||
* Return the number of available buffers in an AURA
|
||||
*
|
||||
* @param aura to receive count for
|
||||
* @return available buffer count
|
||||
* Return: available buffer count
|
||||
*/
|
||||
static inline long long cvmx_fpa3_get_available(cvmx_fpa3_gaura_t aura)
|
||||
{
|
||||
@ -500,7 +500,7 @@ cvmx_fpa3_pool_t cvmx_fpa3_setup_fill_pool(int node, int desired_pool, const cha
|
||||
* @param block_size - size of buffers to use
|
||||
* @param num_blocks - number of blocks to allocate
|
||||
*
|
||||
* @return configured gaura on success, CVMX_FPA3_INVALID_GAURA on failure
|
||||
* Return: configured gaura on success, CVMX_FPA3_INVALID_GAURA on failure
|
||||
*/
|
||||
cvmx_fpa3_gaura_t cvmx_fpa3_set_aura_for_pool(cvmx_fpa3_pool_t pool, int desired_aura,
|
||||
const char *name, unsigned int block_size,
|
||||
|
||||
@ -11,7 +11,7 @@
|
||||
* @param node node to read from
|
||||
* @param byte_addr address to read
|
||||
*
|
||||
* @return fuse value: 0 or 1
|
||||
* Return: fuse value: 0 or 1
|
||||
*/
|
||||
static inline u8 cvmx_fuse_read_byte_node(u8 node, int byte_addr)
|
||||
{
|
||||
@ -31,7 +31,7 @@ static inline u8 cvmx_fuse_read_byte_node(u8 node, int byte_addr)
|
||||
* Read a byte of fuse data
|
||||
* @param byte_addr address to read
|
||||
*
|
||||
* @return fuse value: 0 or 1
|
||||
* Return: fuse value: 0 or 1
|
||||
*/
|
||||
static inline u8 cvmx_fuse_read_byte(int byte_addr)
|
||||
{
|
||||
@ -44,7 +44,7 @@ static inline u8 cvmx_fuse_read_byte(int byte_addr)
|
||||
* @param node Node number
|
||||
* @param fuse Fuse number (0-1024)
|
||||
*
|
||||
* @return fuse value: 0 or 1
|
||||
* Return: fuse value: 0 or 1
|
||||
*/
|
||||
static inline int cvmx_fuse_read_node(u8 node, int fuse)
|
||||
{
|
||||
@ -56,7 +56,7 @@ static inline int cvmx_fuse_read_node(u8 node, int fuse)
|
||||
*
|
||||
* @param fuse Fuse number (0-1024)
|
||||
*
|
||||
* @return fuse value: 0 or 1
|
||||
* Return: fuse value: 0 or 1
|
||||
*/
|
||||
static inline int cvmx_fuse_read(int fuse)
|
||||
{
|
||||
|
||||
@ -116,7 +116,7 @@ int cvmx_create_global_resource_range(struct global_resource_tag tag, int neleme
|
||||
* @param nelements is the number of elements to be allocated.
|
||||
* @param owner is a 64 bit number that identifes the owner of this range.
|
||||
* @aligment specifes the required alignment of the returned base number.
|
||||
* @return returns the base of the allocated range. -1 return value indicates
|
||||
* Return: returns the base of the allocated range. -1 return value indicates
|
||||
* failure.
|
||||
*/
|
||||
int cvmx_allocate_global_resource_range(struct global_resource_tag tag, u64 owner, int nelements,
|
||||
@ -133,7 +133,7 @@ int cvmx_allocate_global_resource_range(struct global_resource_tag tag, u64 owne
|
||||
* @param owner is a 64 bit number that identifes the owner of the allocated
|
||||
* elements.
|
||||
* @param allocated_elements returns indexs of the allocated entries.
|
||||
* @return returns 0 on success and -1 on failure.
|
||||
* Return: returns 0 on success and -1 on failure.
|
||||
*/
|
||||
int cvmx_resource_alloc_many(struct global_resource_tag tag, u64 owner, int nelements,
|
||||
int allocated_elements[]);
|
||||
@ -148,7 +148,7 @@ int cvmx_resource_alloc_reverse(struct global_resource_tag, u64 owner);
|
||||
* @param nelements is the number of elements to be allocated.
|
||||
* @param owner is a 64 bit number that identifes the owner of this range.
|
||||
* @base specifies the base start of nelements.
|
||||
* @return returns the base of the allocated range. -1 return value indicates
|
||||
* Return: returns the base of the allocated range. -1 return value indicates
|
||||
* failure.
|
||||
*/
|
||||
int cvmx_reserve_global_resource_range(struct global_resource_tag tag, u64 owner, int base,
|
||||
@ -160,7 +160,7 @@ int cvmx_reserve_global_resource_range(struct global_resource_tag tag, u64 owner
|
||||
* @param tag is the tag of the global resource range.
|
||||
* @param base is the base number
|
||||
* @param nelements is the number of elements that are to be freed.
|
||||
* @return returns 0 if successful and -1 on failure.
|
||||
* Return: returns 0 if successful and -1 on failure.
|
||||
*/
|
||||
int cvmx_free_global_resource_range_with_base(struct global_resource_tag tag, int base,
|
||||
int nelements);
|
||||
@ -172,7 +172,7 @@ int cvmx_free_global_resource_range_with_base(struct global_resource_tag tag, in
|
||||
* @param tag is the tag of the global resource range.
|
||||
* @param bases is an array containing the bases to be freed.
|
||||
* @param nelements is the number of elements that are to be freed.
|
||||
* @return returns 0 if successful and -1 on failure.
|
||||
* Return: returns 0 if successful and -1 on failure.
|
||||
*/
|
||||
int cvmx_free_global_resource_range_multiple(struct global_resource_tag tag, int bases[],
|
||||
int nelements);
|
||||
@ -182,7 +182,7 @@ int cvmx_free_global_resource_range_multiple(struct global_resource_tag tag, int
|
||||
* specified tag.
|
||||
* @param tag is the tag of the global resource range.
|
||||
* @param owner is the owner of resources that are to be freed.
|
||||
* @return returns 0 if successful and -1 on failure.
|
||||
* Return: returns 0 if successful and -1 on failure.
|
||||
*/
|
||||
int cvmx_free_global_resource_range_with_owner(struct global_resource_tag tag, int owner);
|
||||
|
||||
|
||||
@ -21,7 +21,7 @@ int cvmx_helper_agl_get_port(int xiface);
|
||||
*
|
||||
* @param interface Interface to probe
|
||||
*
|
||||
* @return Number of ports on the interface. Zero to disable.
|
||||
* Return: Number of ports on the interface. Zero to disable.
|
||||
*/
|
||||
int __cvmx_helper_agl_probe(int interface);
|
||||
|
||||
@ -33,7 +33,7 @@ int __cvmx_helper_agl_probe(int interface);
|
||||
*
|
||||
* @param interface Interface to bring up
|
||||
*
|
||||
* @return Zero on success, negative on failure
|
||||
* Return: Zero on success, negative on failure
|
||||
*/
|
||||
int __cvmx_helper_agl_enable(int interface);
|
||||
|
||||
@ -46,7 +46,7 @@ int __cvmx_helper_agl_enable(int interface);
|
||||
*
|
||||
* @param ipd_port IPD/PKO port to query
|
||||
*
|
||||
* @return Link state
|
||||
* Return: Link state
|
||||
*/
|
||||
cvmx_helper_link_info_t __cvmx_helper_agl_link_get(int ipd_port);
|
||||
|
||||
@ -61,7 +61,7 @@ cvmx_helper_link_info_t __cvmx_helper_agl_link_get(int ipd_port);
|
||||
* @param ipd_port IPD/PKO port to configure
|
||||
* @param link_info The new link state
|
||||
*
|
||||
* @return Zero on success, negative on failure
|
||||
* Return: Zero on success, negative on failure
|
||||
*/
|
||||
int __cvmx_helper_agl_link_set(int ipd_port, cvmx_helper_link_info_t link_info);
|
||||
|
||||
|
||||
@ -29,7 +29,7 @@ void cvmx_helper_bgx_disable(int xipd_port);
|
||||
*
|
||||
* @param xiface Interface to probe
|
||||
*
|
||||
* @return Number of ports on the interface. Zero to disable.
|
||||
* Return: Number of ports on the interface. Zero to disable.
|
||||
*/
|
||||
int __cvmx_helper_bgx_probe(int xiface);
|
||||
|
||||
@ -42,7 +42,7 @@ int __cvmx_helper_bgx_probe(int xiface);
|
||||
*
|
||||
* @param xiface Interface to bring up
|
||||
*
|
||||
* @return Zero on success, negative on failure
|
||||
* Return: Zero on success, negative on failure
|
||||
*/
|
||||
int __cvmx_helper_bgx_sgmii_enable(int xiface);
|
||||
|
||||
@ -56,7 +56,7 @@ int __cvmx_helper_bgx_sgmii_enable(int xiface);
|
||||
*
|
||||
* @param xipd_port IPD/PKO port to query
|
||||
*
|
||||
* @return Link state
|
||||
* Return: Link state
|
||||
*/
|
||||
cvmx_helper_link_info_t __cvmx_helper_bgx_sgmii_link_get(int xipd_port);
|
||||
|
||||
@ -72,7 +72,7 @@ cvmx_helper_link_info_t __cvmx_helper_bgx_sgmii_link_get(int xipd_port);
|
||||
* @param xipd_port IPD/PKO port to configure
|
||||
* @param link_info The new link state
|
||||
*
|
||||
* @return Zero on success, negative on failure
|
||||
* Return: Zero on success, negative on failure
|
||||
*/
|
||||
int __cvmx_helper_bgx_sgmii_link_set(int xipd_port, cvmx_helper_link_info_t link_info);
|
||||
|
||||
@ -89,7 +89,7 @@ int __cvmx_helper_bgx_sgmii_link_set(int xipd_port, cvmx_helper_link_info_t link
|
||||
* @param enable_external
|
||||
* Non zero if you want external loopback
|
||||
*
|
||||
* @return Zero on success, negative on failure.
|
||||
* Return: Zero on success, negative on failure.
|
||||
*/
|
||||
int __cvmx_helper_bgx_sgmii_configure_loopback(int xipd_port, int enable_internal,
|
||||
int enable_external);
|
||||
@ -103,7 +103,7 @@ int __cvmx_helper_bgx_sgmii_configure_loopback(int xipd_port, int enable_interna
|
||||
*
|
||||
* @param xiface Interface to bring up
|
||||
*
|
||||
* @return Zero on success, negative on failure
|
||||
* Return: Zero on success, negative on failure
|
||||
*/
|
||||
int __cvmx_helper_bgx_xaui_enable(int xiface);
|
||||
|
||||
@ -117,7 +117,7 @@ int __cvmx_helper_bgx_xaui_enable(int xiface);
|
||||
*
|
||||
* @param xipd_port IPD/PKO port to query
|
||||
*
|
||||
* @return Link state
|
||||
* Return: Link state
|
||||
*/
|
||||
cvmx_helper_link_info_t __cvmx_helper_bgx_xaui_link_get(int xipd_port);
|
||||
|
||||
@ -133,7 +133,7 @@ cvmx_helper_link_info_t __cvmx_helper_bgx_xaui_link_get(int xipd_port);
|
||||
* @param xipd_port IPD/PKO port to configure
|
||||
* @param link_info The new link state
|
||||
*
|
||||
* @return Zero on success, negative on failure
|
||||
* Return: Zero on success, negative on failure
|
||||
*/
|
||||
int __cvmx_helper_bgx_xaui_link_set(int xipd_port, cvmx_helper_link_info_t link_info);
|
||||
|
||||
@ -150,7 +150,7 @@ int __cvmx_helper_bgx_xaui_link_set(int xipd_port, cvmx_helper_link_info_t link_
|
||||
* @param enable_external
|
||||
* Non zero if you want external loopback
|
||||
*
|
||||
* @return Zero on success, negative on failure.
|
||||
* Return: Zero on success, negative on failure.
|
||||
*/
|
||||
int __cvmx_helper_bgx_xaui_configure_loopback(int xipd_port, int enable_internal,
|
||||
int enable_external);
|
||||
@ -239,7 +239,7 @@ int __cvmx_helper_bgx_fifo_size(int xiface, unsigned int lmac);
|
||||
* @param xiface xinterface to check
|
||||
* @param index port index (must be 0 for rgmii)
|
||||
*
|
||||
* @return true if RGMII, false otherwise
|
||||
* Return: true if RGMII, false otherwise
|
||||
*/
|
||||
static inline bool cvmx_helper_bgx_is_rgmii(int xiface, int index)
|
||||
{
|
||||
@ -257,7 +257,7 @@ static inline bool cvmx_helper_bgx_is_rgmii(int xiface, int index)
|
||||
* @param xiface global interface number
|
||||
* @param index interface index
|
||||
*
|
||||
* @return true, if Super-MAC/PCS mode, false -- otherwise
|
||||
* Return: true, if Super-MAC/PCS mode, false -- otherwise
|
||||
*/
|
||||
bool cvmx_helper_bgx_is_smu(int xiface, int index);
|
||||
|
||||
@ -271,7 +271,7 @@ bool cvmx_helper_bgx_is_smu(int xiface, int index);
|
||||
* @param type PAUSE packet type.
|
||||
* @param time Pause time for PAUSE packets (number of 512 bit-times).
|
||||
* @param interval Interval between PAUSE packets (number of 512 bit-times).
|
||||
* @return Zero on success, negative on failure.
|
||||
* Return: Zero on success, negative on failure.
|
||||
*/
|
||||
int cvmx_bgx_set_pause_pkt_param(int xipd_port, u64 smac, u64 dmac, unsigned int type,
|
||||
unsigned int time, unsigned int interval);
|
||||
@ -283,7 +283,7 @@ int cvmx_bgx_set_pause_pkt_param(int xipd_port, u64 smac, u64 dmac, unsigned int
|
||||
* @param xipd_port Global IPD port (node + IPD port).
|
||||
* @param type Flow-control type/protocol.
|
||||
* @param mode Flow-control mode.
|
||||
* @return Zero on success, negative on failure.
|
||||
* Return: Zero on success, negative on failure.
|
||||
*/
|
||||
int cvmx_bgx_set_flowctl_mode(int xipd_port, cvmx_qos_proto_t qos, cvmx_qos_pkt_mode_t mode);
|
||||
|
||||
@ -294,7 +294,7 @@ int cvmx_bgx_set_flowctl_mode(int xipd_port, cvmx_qos_proto_t qos, cvmx_qos_pkt_
|
||||
* @param index port index
|
||||
* @param enable true to enable autonegotiation, false to disable it
|
||||
*
|
||||
* @return 0 for success, -1 on error.
|
||||
* Return: 0 for success, -1 on error.
|
||||
*/
|
||||
int cvmx_helper_set_autonegotiation(int xiface, int index, bool enable);
|
||||
|
||||
@ -305,7 +305,7 @@ int cvmx_helper_set_autonegotiation(int xiface, int index, bool enable);
|
||||
* @param index port index
|
||||
* @param enable set to true to enable FEC, false to disable
|
||||
*
|
||||
* @return 0 for success, -1 on error
|
||||
* Return: 0 for success, -1 on error
|
||||
*
|
||||
* @NOTE: If autonegotiation is enabled then autonegotiation will be
|
||||
* restarted for negotiating FEC.
|
||||
|
||||
@ -329,7 +329,7 @@ typedef struct cvmx_phy_info {
|
||||
*
|
||||
* @param ipd_port Octeon IPD port to get the MII address for.
|
||||
*
|
||||
* @return MII PHY address and bus number or -1.
|
||||
* Return: MII PHY address and bus number or -1.
|
||||
*/
|
||||
int cvmx_helper_board_get_mii_address(int ipd_port);
|
||||
|
||||
@ -346,7 +346,7 @@ int cvmx_helper_board_get_mii_address(int ipd_port);
|
||||
* @param link_info Link speed to program. If the speed is zero and autonegotiation
|
||||
* is enabled, all possible negotiation speeds are advertised.
|
||||
*
|
||||
* @return Zero on success, negative on failure
|
||||
* Return: Zero on success, negative on failure
|
||||
*/
|
||||
int cvmx_helper_board_link_set_phy(int phy_addr,
|
||||
cvmx_helper_board_set_phy_link_flags_types_t link_flags,
|
||||
@ -368,7 +368,7 @@ int cvmx_helper_board_link_set_phy(int phy_addr,
|
||||
* @param ipd_port IPD input port associated with the port we want to get link
|
||||
* status for.
|
||||
*
|
||||
* @return The ports link status. If the link isn't fully resolved, this must
|
||||
* Return: The ports link status. If the link isn't fully resolved, this must
|
||||
* return zero.
|
||||
*/
|
||||
cvmx_helper_link_info_t __cvmx_helper_board_link_get(int ipd_port);
|
||||
@ -392,7 +392,7 @@ cvmx_helper_link_info_t __cvmx_helper_board_link_get(int ipd_port);
|
||||
* @param supported_ports
|
||||
* Number of ports Octeon supports.
|
||||
*
|
||||
* @return Number of ports the actual board supports. Many times this will
|
||||
* Return: Number of ports the actual board supports. Many times this will
|
||||
* simple be "support_ports".
|
||||
*/
|
||||
int __cvmx_helper_board_interface_probe(int interface, int supported_ports);
|
||||
@ -406,7 +406,7 @@ int __cvmx_helper_board_interface_probe(int interface, int supported_ports);
|
||||
*
|
||||
* @param interface Interface to enable
|
||||
*
|
||||
* @return Zero on success, negative on failure
|
||||
* Return: Zero on success, negative on failure
|
||||
*/
|
||||
int __cvmx_helper_board_hardware_enable(int interface);
|
||||
|
||||
@ -415,7 +415,7 @@ int __cvmx_helper_board_hardware_enable(int interface);
|
||||
* Gets the clock type used for the USB block based on board type.
|
||||
* Used by the USB code for auto configuration of clock type.
|
||||
*
|
||||
* @return USB clock type enumeration
|
||||
* Return: USB clock type enumeration
|
||||
*/
|
||||
cvmx_helper_board_usb_clock_types_t __cvmx_helper_board_usb_get_clock_type(void);
|
||||
|
||||
@ -427,7 +427,7 @@ cvmx_helper_board_usb_clock_types_t __cvmx_helper_board_usb_get_clock_type(void)
|
||||
* @param supported_ports expected number of ports based on chip type;
|
||||
*
|
||||
*
|
||||
* @return number of available usb ports, based on board specifics.
|
||||
* Return: number of available usb ports, based on board specifics.
|
||||
* Return value is supported_ports if function does not
|
||||
* override.
|
||||
*/
|
||||
@ -440,7 +440,7 @@ int __cvmx_helper_board_usb_get_num_ports(int supported_ports);
|
||||
* @param fdt_addr - address fo flat device tree
|
||||
* @param ipd_port - IPD port number
|
||||
*
|
||||
* @return 1 if port is present, 0 if not present, -1 if error
|
||||
* Return: 1 if port is present, 0 if not present, -1 if error
|
||||
*/
|
||||
int __cvmx_helper_board_get_port_from_dt(void *fdt_addr, int ipd_port);
|
||||
|
||||
@ -450,7 +450,7 @@ int __cvmx_helper_board_get_port_from_dt(void *fdt_addr, int ipd_port);
|
||||
*
|
||||
* @param ipd_port - ipd port number to get the host mode for
|
||||
*
|
||||
* @return host mode for phy
|
||||
* Return: host mode for phy
|
||||
*/
|
||||
cvmx_phy_host_mode_t cvmx_helper_board_get_phy_host_mode(int ipd_port);
|
||||
|
||||
@ -462,7 +462,7 @@ cvmx_phy_host_mode_t cvmx_helper_board_get_phy_host_mode(int ipd_port);
|
||||
* @param[out] - phy_info - phy info data structure
|
||||
* @param ipd_port - port to get phy info for
|
||||
*
|
||||
* @return 0 for success, -1 if info not available
|
||||
* Return: 0 for success, -1 if info not available
|
||||
*
|
||||
* NOTE: The phy_info data structure is subject to change.
|
||||
*/
|
||||
@ -474,7 +474,7 @@ int cvmx_helper_board_get_phy_info(cvmx_phy_info_t *phy_info, int ipd_port);
|
||||
*
|
||||
* @param fdt_addr Pointer to device tree
|
||||
*
|
||||
* @return 0 for success, -1 on error.
|
||||
* Return: 0 for success, -1 on error.
|
||||
*/
|
||||
int __cvmx_helper_parse_bgx_dt(const void *fdt_addr);
|
||||
|
||||
@ -484,7 +484,7 @@ int __cvmx_helper_parse_bgx_dt(const void *fdt_addr);
|
||||
*
|
||||
* @param fdt_addr Pointer to device tree
|
||||
*
|
||||
* @return 0 for success, -1 on error.
|
||||
* Return: 0 for success, -1 on error.
|
||||
*/
|
||||
int __cvmx_helper_parse_bgx_rgmii_dt(const void *fdt_addr);
|
||||
|
||||
@ -513,7 +513,7 @@ void cvmx_update_rx_activity_led(int xiface, int index, bool check_time);
|
||||
* @param xiface xinterface number
|
||||
* @param index port index on interface
|
||||
*
|
||||
* @return 0 for success, -1 on error
|
||||
* Return: 0 for success, -1 on error
|
||||
*
|
||||
* This function figures out the proper mod_abs_changed function to use and
|
||||
* registers the appropriate function. This should be called after the device
|
||||
@ -529,7 +529,7 @@ int cvmx_helper_phy_register_mod_abs_changed(int xiface, int index);
|
||||
* @param xiface xinterface number
|
||||
* @param index port index on interface
|
||||
*
|
||||
* @return 0 if signal present, 1 if loss of signal.
|
||||
* Return: 0 if signal present, 1 if loss of signal.
|
||||
*
|
||||
* @NOTE: A result of 0 is possible in some cases where the signal is
|
||||
* not present.
|
||||
|
||||
@ -193,7 +193,7 @@ extern int cvmx_enable_helper_flag;
|
||||
*
|
||||
* @param interface the interface number
|
||||
* @param index the port's index number
|
||||
* @return the pknd
|
||||
* Return: the pknd
|
||||
*/
|
||||
int __cvmx_helper_cfg_pknd(int interface, int index);
|
||||
|
||||
@ -203,7 +203,7 @@ int __cvmx_helper_cfg_pknd(int interface, int index);
|
||||
*
|
||||
* @param interface the interface number
|
||||
* @param index the port's index number
|
||||
* @return the bpid
|
||||
* Return: the bpid
|
||||
*/
|
||||
int __cvmx_helper_cfg_bpid(int interface, int index);
|
||||
|
||||
@ -213,7 +213,7 @@ int __cvmx_helper_cfg_bpid(int interface, int index);
|
||||
*
|
||||
* @param interface the interface number
|
||||
* @param index the port's index number
|
||||
* @return the pko_port base
|
||||
* Return: the pko_port base
|
||||
*/
|
||||
int __cvmx_helper_cfg_pko_port_base(int interface, int index);
|
||||
|
||||
@ -223,7 +223,7 @@ int __cvmx_helper_cfg_pko_port_base(int interface, int index);
|
||||
*
|
||||
* @param interface the interface number
|
||||
* @param index the port's index number
|
||||
* @return the number of pko_ports
|
||||
* Return: the number of pko_ports
|
||||
*/
|
||||
int __cvmx_helper_cfg_pko_port_num(int interface, int index);
|
||||
|
||||
@ -232,7 +232,7 @@ int __cvmx_helper_cfg_pko_port_num(int interface, int index);
|
||||
* Return the configured pko_queue base for the pko_port
|
||||
*
|
||||
* @param pko_port
|
||||
* @return the pko_queue base
|
||||
* Return: the pko_queue base
|
||||
*/
|
||||
int __cvmx_helper_cfg_pko_queue_base(int pko_port);
|
||||
|
||||
@ -241,7 +241,7 @@ int __cvmx_helper_cfg_pko_queue_base(int pko_port);
|
||||
* Return the configured number of pko_queues for the pko_port
|
||||
*
|
||||
* @param pko_port
|
||||
* @return the number of pko_queues
|
||||
* Return: the number of pko_queues
|
||||
*/
|
||||
int __cvmx_helper_cfg_pko_queue_num(int pko_port);
|
||||
|
||||
@ -250,7 +250,7 @@ int __cvmx_helper_cfg_pko_queue_num(int pko_port);
|
||||
* Return the interface the pko_port is configured for
|
||||
*
|
||||
* @param pko_port
|
||||
* @return the interface for the pko_port
|
||||
* Return: the interface for the pko_port
|
||||
*/
|
||||
int __cvmx_helper_cfg_pko_port_interface(int pko_port);
|
||||
|
||||
@ -259,7 +259,7 @@ int __cvmx_helper_cfg_pko_port_interface(int pko_port);
|
||||
* Return the index of the port the pko_port is configured for
|
||||
*
|
||||
* @param pko_port
|
||||
* @return the index of the port
|
||||
* Return: the index of the port
|
||||
*/
|
||||
int __cvmx_helper_cfg_pko_port_index(int pko_port);
|
||||
|
||||
@ -268,7 +268,7 @@ int __cvmx_helper_cfg_pko_port_index(int pko_port);
|
||||
* Return the pko_eid of the pko_port
|
||||
*
|
||||
* @param pko_port
|
||||
* @return the pko_eid
|
||||
* Return: the pko_eid
|
||||
*/
|
||||
int __cvmx_helper_cfg_pko_port_eid(int pko_port);
|
||||
|
||||
@ -276,7 +276,7 @@ int __cvmx_helper_cfg_pko_port_eid(int pko_port);
|
||||
* @INTERNAL
|
||||
* Return the max# of pko queues allocated.
|
||||
*
|
||||
* @return the max# of pko queues
|
||||
* Return: the max# of pko queues
|
||||
*
|
||||
* Note: there might be holes in the queue space depending on user
|
||||
* configuration. The function returns the highest queue's index in
|
||||
@ -288,7 +288,7 @@ int __cvmx_helper_cfg_pko_max_queue(void);
|
||||
* @INTERNAL
|
||||
* Return the max# of PKO DMA engines allocated.
|
||||
*
|
||||
* @return the max# of DMA engines
|
||||
* Return: the max# of DMA engines
|
||||
*
|
||||
* NOTE: the DMA engines are allocated contiguously and starting from
|
||||
* 0.
|
||||
@ -299,7 +299,7 @@ int __cvmx_helper_cfg_pko_max_engine(void);
|
||||
* Get the value set for the config option ``opt''.
|
||||
*
|
||||
* @param opt is the config option.
|
||||
* @return the value set for the option
|
||||
* Return: the value set for the option
|
||||
*
|
||||
* LR: only used for DWB in NPI, POW, PKO1
|
||||
*/
|
||||
@ -310,7 +310,7 @@ u64 cvmx_helper_cfg_opt_get(cvmx_helper_cfg_option_t opt);
|
||||
*
|
||||
* @param opt is the config option.
|
||||
* @param val is the value to set for the opt.
|
||||
* @return 0 for success and -1 on error
|
||||
* Return: 0 for success and -1 on error
|
||||
*
|
||||
* Note an option here is a config-time parameter and this means that
|
||||
* it has to be set before calling the corresponding setup functions
|
||||
@ -324,7 +324,7 @@ int cvmx_helper_cfg_opt_set(cvmx_helper_cfg_option_t opt, u64 val);
|
||||
* Retrieve the pko_port base given ipd_port.
|
||||
*
|
||||
* @param ipd_port is the IPD eport
|
||||
* @return the corresponding PKO port base for the physical port
|
||||
* Return: the corresponding PKO port base for the physical port
|
||||
* represented by the IPD eport or CVMX_HELPER_CFG_INVALID_VALUE.
|
||||
*/
|
||||
int cvmx_helper_cfg_ipd2pko_port_base(int ipd_port);
|
||||
@ -333,7 +333,7 @@ int cvmx_helper_cfg_ipd2pko_port_base(int ipd_port);
|
||||
* Retrieve the number of pko_ports given ipd_port.
|
||||
*
|
||||
* @param ipd_port is the IPD eport
|
||||
* @return the corresponding number of PKO ports for the physical port
|
||||
* Return: the corresponding number of PKO ports for the physical port
|
||||
* represented by IPD eport or CVMX_HELPER_CFG_INVALID_VALUE.
|
||||
*/
|
||||
int cvmx_helper_cfg_ipd2pko_port_num(int ipd_port);
|
||||
@ -343,7 +343,7 @@ int cvmx_helper_cfg_ipd2pko_port_num(int ipd_port);
|
||||
* The init function
|
||||
*
|
||||
* @param node
|
||||
* @return 0 for success.
|
||||
* Return: 0 for success.
|
||||
*
|
||||
* Note: this function is meant to be called to set the ``configured
|
||||
* parameters,'' e.g., pknd, bpid, etc. and therefore should be before
|
||||
@ -357,7 +357,7 @@ int __cvmx_helper_init_port_config_data(int node);
|
||||
* The local init function
|
||||
*
|
||||
* @param none
|
||||
* @return 0 for success.
|
||||
* Return: 0 for success.
|
||||
*
|
||||
* Note: this function is meant to be called to set the ``configured
|
||||
* parameters locally,'' e.g., pknd, bpid, etc. and therefore should be before
|
||||
@ -390,7 +390,7 @@ void cvmx_helper_cfg_store_short_packets_in_wqe(void);
|
||||
* port. This call will allocate a total of
|
||||
* (port_cnt * queue_cnt) queues
|
||||
*
|
||||
* @return 0 on success
|
||||
* Return: 0 on success
|
||||
* -1 on failure
|
||||
*
|
||||
* LR: Called ONLY from comfig-parse!
|
||||
@ -402,14 +402,14 @@ int cvmx_pko_alloc_iport_and_queues(int interface, int port, int port_cnt, int q
|
||||
*
|
||||
* @param port the internal port for which the queues are freed.
|
||||
*
|
||||
* @return 0 on success
|
||||
* Return: 0 on success
|
||||
* -1 on failure
|
||||
*/
|
||||
int cvmx_pko_queue_free(u64 port);
|
||||
|
||||
/*
|
||||
* Initializes the pko queue range data structure.
|
||||
* @return 0 on success
|
||||
* Return: 0 on success
|
||||
* -1 on failure
|
||||
*/
|
||||
int init_cvmx_pko_que_range(void);
|
||||
@ -425,7 +425,7 @@ void cvmx_pko_queue_free_all(void);
|
||||
* @param xiface interface to check
|
||||
* @param index port index in the interface
|
||||
*
|
||||
* @return status of the port present or not.
|
||||
* Return: status of the port present or not.
|
||||
*/
|
||||
int cvmx_helper_is_port_valid(int xiface, int index);
|
||||
|
||||
@ -445,7 +445,7 @@ void cvmx_helper_set_port_valid(int interface, int index, bool valid);
|
||||
* @param interface the interface number
|
||||
* @param index the port's index number
|
||||
*
|
||||
* @return 1 if port is in PHY mode, 0 if port is in MAC mode
|
||||
* Return: 1 if port is in PHY mode, 0 if port is in MAC mode
|
||||
*/
|
||||
bool cvmx_helper_get_mac_phy_mode(int interface, int index);
|
||||
void cvmx_helper_set_mac_phy_mode(int interface, int index, bool valid);
|
||||
@ -457,7 +457,7 @@ void cvmx_helper_set_mac_phy_mode(int interface, int index, bool valid);
|
||||
* @param interface the interface number
|
||||
* @param index the port's index number
|
||||
*
|
||||
* @return 1 if port is in 1000Base X mode, 0 if port is in SGMII mode
|
||||
* Return: 1 if port is in 1000Base X mode, 0 if port is in SGMII mode
|
||||
*/
|
||||
bool cvmx_helper_get_1000x_mode(int interface, int index);
|
||||
void cvmx_helper_set_1000x_mode(int interface, int index, bool valid);
|
||||
@ -521,7 +521,7 @@ void cvmx_helper_set_port_fdt_node_offset(int xiface, int index, int node_offset
|
||||
*
|
||||
* @param xiface node and interface
|
||||
* @param index port index
|
||||
* @return node offset of port or -1 if invalid
|
||||
* Return: node offset of port or -1 if invalid
|
||||
*/
|
||||
int cvmx_helper_get_port_fdt_node_offset(int xiface, int index);
|
||||
|
||||
@ -541,7 +541,7 @@ void cvmx_helper_set_phy_fdt_node_offset(int xiface, int index, int node_offset)
|
||||
*
|
||||
* @param xiface node and interface
|
||||
* @param index port index
|
||||
* @return node offset of phy or -1 if invalid
|
||||
* Return: node offset of phy or -1 if invalid
|
||||
*/
|
||||
int cvmx_helper_get_phy_fdt_node_offset(int xiface, int index);
|
||||
|
||||
@ -563,7 +563,7 @@ void cvmx_helper_set_port_autonegotiation(int xiface, int index, bool enable);
|
||||
* @param xiface node and interface
|
||||
* @param index port index
|
||||
*
|
||||
* @return 0 if autonegotiation is disabled, 1 if enabled.
|
||||
* Return: 0 if autonegotiation is disabled, 1 if enabled.
|
||||
*/
|
||||
bool cvmx_helper_get_port_autonegotiation(int xiface, int index);
|
||||
|
||||
@ -574,7 +574,7 @@ bool cvmx_helper_get_port_autonegotiation(int xiface, int index);
|
||||
* @param xiface node and interface
|
||||
* @param index port index
|
||||
*
|
||||
* @return 0 if fec is disabled, 1 if enabled.
|
||||
* Return: 0 if fec is disabled, 1 if enabled.
|
||||
*/
|
||||
bool cvmx_helper_get_port_fec(int xiface, int index);
|
||||
|
||||
@ -683,7 +683,7 @@ void cvmx_helper_set_port_phy_info(int xiface, int index, struct cvmx_phy_info *
|
||||
* @param xiface node and interface
|
||||
* @param index port index
|
||||
*
|
||||
* @return pointer to PHY information data structure or NULL if not set
|
||||
* Return: pointer to PHY information data structure or NULL if not set
|
||||
*/
|
||||
struct cvmx_phy_info *cvmx_helper_get_port_phy_info(int xiface, int index);
|
||||
|
||||
@ -694,7 +694,7 @@ struct cvmx_phy_info *cvmx_helper_get_port_phy_info(int xiface, int index);
|
||||
* @param xiface node and interface
|
||||
* @param index portindex
|
||||
*
|
||||
* @return pointer to the PHY LED information data structure or NULL if not
|
||||
* Return: pointer to the PHY LED information data structure or NULL if not
|
||||
* present
|
||||
*/
|
||||
struct cvmx_phy_gpio_leds *cvmx_helper_get_port_phy_leds(int xiface, int index);
|
||||
@ -760,7 +760,7 @@ int cvmx_helper_pko_queue_config_set(int node, cvmx_user_static_pko_queue_config
|
||||
* @param xiface node and interface
|
||||
* @param index port index
|
||||
*
|
||||
* @return offset in device tree or -1 if error or not defined.
|
||||
* Return: offset in device tree or -1 if error or not defined.
|
||||
*/
|
||||
int cvmx_helper_cfg_get_sfp_fdt_offset(int xiface, int index);
|
||||
|
||||
@ -769,7 +769,7 @@ int cvmx_helper_cfg_get_sfp_fdt_offset(int xiface, int index);
|
||||
*
|
||||
* @param of_offset Node offset of port to search for
|
||||
*
|
||||
* @return ipd_port or -1 if not found
|
||||
* Return: ipd_port or -1 if not found
|
||||
*/
|
||||
int cvmx_helper_cfg_get_ipd_port_by_fdt_node_offset(int of_offset);
|
||||
|
||||
@ -790,7 +790,7 @@ void cvmx_helper_cfg_set_sfp_fdt_offset(int xiface, int index, int sfp_of_offset
|
||||
* @param[out] xiface xinterface of match
|
||||
* @param[out] index port index of match
|
||||
*
|
||||
* @return 0 if found, -1 if not found
|
||||
* Return: 0 if found, -1 if not found
|
||||
*/
|
||||
int cvmx_helper_cfg_get_xiface_index_by_fdt_node_offset(int of_offset, int *xiface, int *index);
|
||||
|
||||
@ -801,7 +801,7 @@ int cvmx_helper_cfg_get_xiface_index_by_fdt_node_offset(int of_offset, int *xifa
|
||||
* @param xiface node and interface
|
||||
* @param index port index
|
||||
*
|
||||
* @return pointer to vsc7224 data structure or NULL if not present
|
||||
* Return: pointer to vsc7224 data structure or NULL if not present
|
||||
*/
|
||||
struct cvmx_vsc7224_chan *cvmx_helper_cfg_get_vsc7224_chan_info(int xiface, int index);
|
||||
|
||||
@ -822,7 +822,7 @@ void cvmx_helper_cfg_set_vsc7224_chan_info(int xiface, int index,
|
||||
* @param xiface node and interface
|
||||
* @param index port index
|
||||
*
|
||||
* @return pointer to avsp5410 data structure or NULL if not present
|
||||
* Return: pointer to avsp5410 data structure or NULL if not present
|
||||
*/
|
||||
struct cvmx_avsp5410 *cvmx_helper_cfg_get_avsp5410_info(int xiface, int index);
|
||||
|
||||
@ -841,7 +841,7 @@ void cvmx_helper_cfg_set_avsp5410_info(int xiface, int index, struct cvmx_avsp54
|
||||
* @param xiface node and interface
|
||||
* @param index port index
|
||||
*
|
||||
* @return pointer to SFP data structure or NULL if none
|
||||
* Return: pointer to SFP data structure or NULL if none
|
||||
*/
|
||||
struct cvmx_fdt_sfp_info *cvmx_helper_cfg_get_sfp_info(int xiface, int index);
|
||||
|
||||
|
||||
@ -17,7 +17,7 @@
|
||||
* @INTERNAL
|
||||
* Function to adjust internal IPD pointer alignments
|
||||
*
|
||||
* @return 0 on success
|
||||
* Return: 0 on success
|
||||
* !0 on failure
|
||||
*/
|
||||
int __cvmx_helper_errata_fix_ipd_ptr_alignment(void);
|
||||
@ -35,7 +35,7 @@ int __cvmx_helper_errata_fix_ipd_ptr_alignment(void);
|
||||
* in each buffer).
|
||||
*
|
||||
* @param work Work queue entry to fix
|
||||
* @return Zero on success. Negative on failure
|
||||
* Return: Zero on success. Negative on failure
|
||||
*/
|
||||
int cvmx_helper_fix_ipd_packet_chain(cvmx_wqe_t *work);
|
||||
|
||||
|
||||
@ -141,7 +141,7 @@ struct cvmx_fdt_sfp_info {
|
||||
* @param[in,out] lenp Number of phandles, input max number
|
||||
* @param[out] nodes Array of phandle nodes
|
||||
*
|
||||
* @return -ve error code on error or 0 for success
|
||||
* Return: -ve error code on error or 0 for success
|
||||
*/
|
||||
int cvmx_fdt_lookup_phandles(const void *fdt_addr, int node, const char *prop_name, int *lenp,
|
||||
int *nodes);
|
||||
@ -153,7 +153,7 @@ int cvmx_fdt_lookup_phandles(const void *fdt_addr, int node, const char *prop_na
|
||||
* @param node node to read address from
|
||||
* @param prop_name property name to read
|
||||
*
|
||||
* @return address of property or FDT_ADDR_T_NONE if not found
|
||||
* Return: address of property or FDT_ADDR_T_NONE if not found
|
||||
*/
|
||||
static inline fdt_addr_t cvmx_fdt_get_addr(const void *fdt_addr, int node, const char *prop_name)
|
||||
{
|
||||
@ -168,7 +168,7 @@ static inline fdt_addr_t cvmx_fdt_get_addr(const void *fdt_addr, int node, const
|
||||
* @param[in] prop_name property name to read
|
||||
* @param default_val default value to return if property doesn't exist
|
||||
*
|
||||
* @return integer value of property or default_val if it doesn't exist.
|
||||
* Return: integer value of property or default_val if it doesn't exist.
|
||||
*/
|
||||
static inline int cvmx_fdt_get_int(const void *fdt_addr, int node, const char *prop_name,
|
||||
int default_val)
|
||||
@ -195,7 +195,7 @@ static inline u64 cvmx_fdt_get_uint64(const void *fdt_addr, int node, const char
|
||||
* @param node node to read phandle from
|
||||
* @param[in] prop_name name of property to find
|
||||
*
|
||||
* @return node offset if found, -ve error code on error
|
||||
* Return: node offset if found, -ve error code on error
|
||||
*/
|
||||
static inline int cvmx_fdt_lookup_phandle(const void *fdt_addr, int node, const char *prop_name)
|
||||
{
|
||||
@ -214,7 +214,7 @@ static inline int cvmx_fdt_lookup_phandle(const void *fdt_addr, int node, const
|
||||
* NOTE: in_addr must be in the native ENDIAN
|
||||
* format.
|
||||
*
|
||||
* @return Translated address or FDT_ADDR_T_NONE if address cannot be
|
||||
* Return: Translated address or FDT_ADDR_T_NONE if address cannot be
|
||||
* translated.
|
||||
*/
|
||||
static inline u64 cvmx_fdt_translate_address(const void *fdt_addr, int node, const u32 *in_addr)
|
||||
@ -228,7 +228,7 @@ static inline u64 cvmx_fdt_translate_address(const void *fdt_addr, int node, con
|
||||
* @param[in] s1 First string to compare
|
||||
* @param[in] sw Second string to compare
|
||||
*
|
||||
* @return 0 if no match
|
||||
* Return: 0 if no match
|
||||
* 1 if only the part number matches and not the manufacturer
|
||||
* 2 if both the part number and manufacturer match
|
||||
*/
|
||||
@ -241,7 +241,7 @@ int cvmx_fdt_compat_match(const char *s1, const char *s2);
|
||||
* @param llen string list total length
|
||||
* @param[in] str string to search for
|
||||
*
|
||||
* @return 1 if string list contains string, 0 if it does not.
|
||||
* Return: 1 if string list contains string, 0 if it does not.
|
||||
*/
|
||||
int cvmx_fdt_compat_list_contains(const char *slist, int llen, const char *str);
|
||||
|
||||
@ -252,7 +252,7 @@ int cvmx_fdt_compat_list_contains(const char *slist, int llen, const char *str);
|
||||
* @param node node offset to check
|
||||
* @param[in] compat compatible string to check
|
||||
*
|
||||
* @return 0 if compatible, 1 if not compatible, error if negative
|
||||
* Return: 0 if compatible, 1 if not compatible, error if negative
|
||||
*/
|
||||
int cvmx_fdt_node_check_compatible(const void *fdt_addr, int node, const char *compat);
|
||||
|
||||
@ -263,7 +263,7 @@ int cvmx_fdt_node_check_compatible(const void *fdt_addr, int node, const char *c
|
||||
* @param[in] compat compatible string
|
||||
* @param[in] str string to check
|
||||
*
|
||||
* @return 0 if not compatible, 1 if manufacturer compatible, 2 if
|
||||
* Return: 0 if not compatible, 1 if manufacturer compatible, 2 if
|
||||
* part is compatible, 3 if both part and manufacturer are
|
||||
* compatible.
|
||||
*/
|
||||
@ -276,7 +276,7 @@ int __cvmx_fdt_compat_match(const char *compat, const char *str);
|
||||
* @param phandle phandle to GPIO
|
||||
* @param[out] size Number of pins (optional, may be NULL)
|
||||
*
|
||||
* @return Type of GPIO device or PIN_ERROR if error
|
||||
* Return: Type of GPIO device or PIN_ERROR if error
|
||||
*/
|
||||
enum cvmx_gpio_type cvmx_fdt_get_gpio_type(const void *fdt_addr, int phandle, int *size);
|
||||
|
||||
@ -289,7 +289,7 @@ enum cvmx_gpio_type cvmx_fdt_get_gpio_type(const void *fdt_addr, int phandle, in
|
||||
* NULL for none.
|
||||
* @param[out] addr TWSI address number, can be NULL for none
|
||||
*
|
||||
* @return 0 for success, error otherwise
|
||||
* Return: 0 for success, error otherwise
|
||||
*/
|
||||
int cvmx_fdt_get_twsi_gpio_bus_addr(const void *fdt_addr, int phandle, int *bus, int *addr);
|
||||
|
||||
@ -299,7 +299,7 @@ int cvmx_fdt_get_twsi_gpio_bus_addr(const void *fdt_addr, int phandle, int *bus,
|
||||
* @param[in] fdt_addr Address of FDT
|
||||
* @param node FDT node number
|
||||
*
|
||||
* @return CPU node number or error if negative
|
||||
* Return: CPU node number or error if negative
|
||||
*/
|
||||
int cvmx_fdt_get_cpu_node(const void *fdt_addr, int node);
|
||||
|
||||
@ -308,7 +308,7 @@ int cvmx_fdt_get_cpu_node(const void *fdt_addr, int node);
|
||||
*
|
||||
* @param[in] fdt_addr Address of FDT
|
||||
*
|
||||
* @return Size of flat device tree in bytes or -1 if error.
|
||||
* Return: Size of flat device tree in bytes or -1 if error.
|
||||
*/
|
||||
int cvmx_fdt_get_fdt_size(const void *fdt_addr);
|
||||
|
||||
@ -320,7 +320,7 @@ int cvmx_fdt_get_fdt_size(const void *fdt_addr);
|
||||
* @param[in] strlist Array of FDT device compatibility strings,
|
||||
* must end with NULL or empty string.
|
||||
*
|
||||
* @return 0 if at least one item matches, 1 if no matches
|
||||
* Return: 0 if at least one item matches, 1 if no matches
|
||||
*/
|
||||
int cvmx_fdt_node_check_compatible_list(const void *fdt_addr, int node, const char *const *strlist);
|
||||
|
||||
@ -332,7 +332,7 @@ int cvmx_fdt_node_check_compatible_list(const void *fdt_addr, int node, const ch
|
||||
* @param strlist Array of FDT device compatibility strings, must
|
||||
* end with NULL or empty string.
|
||||
*
|
||||
* @return next matching node or -1 if no more matches.
|
||||
* Return: next matching node or -1 if no more matches.
|
||||
*/
|
||||
int cvmx_fdt_node_offset_by_compatible_list(const void *fdt_addr, int startoffset,
|
||||
const char *const *strlist);
|
||||
@ -345,7 +345,7 @@ int cvmx_fdt_node_offset_by_compatible_list(const void *fdt_addr, int startoffse
|
||||
* @param of_offset Offset of the parent node of a GPIO device in
|
||||
* the device tree.
|
||||
*
|
||||
* @return pointer to list of i2c devices starting from the root which
|
||||
* Return: pointer to list of i2c devices starting from the root which
|
||||
* can include i2c muxes and switches or NULL if error. Note that
|
||||
* all entries are allocated on the heap.
|
||||
*
|
||||
@ -358,7 +358,7 @@ struct cvmx_fdt_i2c_bus_info *cvmx_fdt_get_i2c_bus(const void *fdt_addr, int of_
|
||||
*
|
||||
* @param[in] bus bus descriptor
|
||||
*
|
||||
* @return Octeon twsi bus number or -1 on error
|
||||
* Return: Octeon twsi bus number or -1 on error
|
||||
*/
|
||||
int cvmx_fdt_i2c_get_root_bus(const struct cvmx_fdt_i2c_bus_info *bus);
|
||||
|
||||
@ -367,7 +367,7 @@ int cvmx_fdt_i2c_get_root_bus(const struct cvmx_fdt_i2c_bus_info *bus);
|
||||
*
|
||||
* @param bus bus to free
|
||||
*
|
||||
* @return 0
|
||||
* Return: 0
|
||||
*/
|
||||
int cvmx_fdt_free_i2c_bus(struct cvmx_fdt_i2c_bus_info *bus);
|
||||
|
||||
@ -377,7 +377,7 @@ int cvmx_fdt_free_i2c_bus(struct cvmx_fdt_i2c_bus_info *bus);
|
||||
* @param[in] bus i2c bus descriptor to enable or disable
|
||||
* @param enable set to true to enable, false to disable
|
||||
*
|
||||
* @return 0 for success or -1 for invalid bus
|
||||
* Return: 0 for success or -1 for invalid bus
|
||||
*
|
||||
* This enables the entire bus including muxes and switches in the path.
|
||||
*/
|
||||
@ -390,7 +390,7 @@ int cvmx_fdt_enable_i2c_bus(const struct cvmx_fdt_i2c_bus_info *bus, bool enable
|
||||
* @param of_offset node offset for property
|
||||
* @param prop_name name of property
|
||||
*
|
||||
* @return pointer to GPIO handle or NULL if error
|
||||
* Return: pointer to GPIO handle or NULL if error
|
||||
*/
|
||||
struct cvmx_fdt_gpio_info *cvmx_fdt_gpio_get_info_phandle(const void *fdt_addr, int of_offset,
|
||||
const char *prop_name);
|
||||
@ -401,7 +401,7 @@ struct cvmx_fdt_gpio_info *cvmx_fdt_gpio_get_info_phandle(const void *fdt_addr,
|
||||
* @param pin GPIO pin descriptor
|
||||
* @param value value to set it to, 0 or 1
|
||||
*
|
||||
* @return 0 on success, -1 on error.
|
||||
* Return: 0 on success, -1 on error.
|
||||
*
|
||||
* NOTE: If the CVMX_GPIO_ACTIVE_LOW flag is set then the output value will be
|
||||
* inverted.
|
||||
@ -413,7 +413,7 @@ int cvmx_fdt_gpio_set(struct cvmx_fdt_gpio_info *pin, int value);
|
||||
*
|
||||
* @param pin GPIO pin descriptor
|
||||
*
|
||||
* @return 0 if low, 1 if high, -1 on error. Note that the input will be
|
||||
* Return: 0 if low, 1 if high, -1 on error. Note that the input will be
|
||||
* inverted if the CVMX_GPIO_ACTIVE_LOW flag bit is set.
|
||||
*/
|
||||
int cvmx_fdt_gpio_get(struct cvmx_fdt_gpio_info *pin);
|
||||
@ -424,7 +424,7 @@ int cvmx_fdt_gpio_get(struct cvmx_fdt_gpio_info *pin);
|
||||
* @param sfp Handle to SFP data structure
|
||||
* @param ipd_port Port to assign it to
|
||||
*
|
||||
* @return 0 for success, -1 on error
|
||||
* Return: 0 for success, -1 on error
|
||||
*/
|
||||
int cvmx_sfp_set_ipd_port(struct cvmx_fdt_sfp_info *sfp, int ipd_port);
|
||||
|
||||
@ -433,7 +433,7 @@ int cvmx_sfp_set_ipd_port(struct cvmx_fdt_sfp_info *sfp, int ipd_port);
|
||||
*
|
||||
* @param[in] sfp Handle to SFP data structure
|
||||
*
|
||||
* @return IPD port number for SFP slot
|
||||
* Return: IPD port number for SFP slot
|
||||
*/
|
||||
static inline int cvmx_sfp_get_ipd_port(const struct cvmx_fdt_sfp_info *sfp)
|
||||
{
|
||||
@ -469,7 +469,7 @@ void cvmx_sfp_attach_phy(struct cvmx_fdt_sfp_info *sfp, struct cvmx_phy_info *ph
|
||||
*
|
||||
* @param[in] sfp SFP to get phy info from
|
||||
*
|
||||
* @return phy descriptor or NULL if none.
|
||||
* Return: phy descriptor or NULL if none.
|
||||
*/
|
||||
static inline struct cvmx_phy_info *cvmx_sfp_get_phy_info(const struct cvmx_fdt_sfp_info *sfp)
|
||||
{
|
||||
@ -482,7 +482,7 @@ static inline struct cvmx_phy_info *cvmx_sfp_get_phy_info(const struct cvmx_fdt_
|
||||
*
|
||||
* @param[in] fdt_addr Address of flat device tree
|
||||
*
|
||||
* @return 0 for success, error otherwise
|
||||
* Return: 0 for success, error otherwise
|
||||
*/
|
||||
int __cvmx_fdt_parse_vsc7224(const void *fdt_addr);
|
||||
|
||||
@ -492,7 +492,7 @@ int __cvmx_fdt_parse_vsc7224(const void *fdt_addr);
|
||||
*
|
||||
* @param[in] fdt_addr Address of flat device tree
|
||||
*
|
||||
* @return 0 for success, error otherwise
|
||||
* Return: 0 for success, error otherwise
|
||||
*/
|
||||
int __cvmx_fdt_parse_avsp5410(const void *fdt_addr);
|
||||
|
||||
@ -501,7 +501,7 @@ int __cvmx_fdt_parse_avsp5410(const void *fdt_addr);
|
||||
*
|
||||
* @param[in] fdt_addr Address of flat device tree
|
||||
*
|
||||
* @return pointer to sfp info or NULL if error
|
||||
* Return: pointer to sfp info or NULL if error
|
||||
*/
|
||||
struct cvmx_fdt_sfp_info *cvmx_helper_fdt_parse_sfp_info(const void *fdt_addr, int of_offset);
|
||||
|
||||
@ -512,7 +512,7 @@ struct cvmx_fdt_sfp_info *cvmx_helper_fdt_parse_sfp_info(const void *fdt_addr, i
|
||||
* @param of_offset offset of slice or phy in device tree
|
||||
* @param phy_info phy_info data structure to fill in
|
||||
*
|
||||
* @return 0 for success, -1 on error
|
||||
* Return: 0 for success, -1 on error
|
||||
*/
|
||||
int cvmx_fdt_parse_cs4343(const void *fdt_addr, int of_offset, struct cvmx_phy_info *phy_info);
|
||||
|
||||
@ -533,7 +533,7 @@ void cvmx_fdt_i2c_reg_write(int bus, int addr, u8 val);
|
||||
* @param bus i2c bus number
|
||||
* @param addr i2c device address (7 bits)
|
||||
*
|
||||
* @return 8-bit value or error if negative
|
||||
* Return: 8-bit value or error if negative
|
||||
*/
|
||||
int cvmx_fdt_i2c_reg_read(int bus, int addr);
|
||||
|
||||
@ -545,7 +545,7 @@ int cvmx_fdt_i2c_reg_read(int bus, int addr);
|
||||
* @param reg i2c 8-bit register address
|
||||
* @param val 8-bit value to write
|
||||
*
|
||||
* @return 0 for success, otherwise error
|
||||
* Return: 0 for success, otherwise error
|
||||
*/
|
||||
int cvmx_fdt_i2c_write8(int bus, int addr, int reg, u8 val);
|
||||
|
||||
@ -556,7 +556,7 @@ int cvmx_fdt_i2c_write8(int bus, int addr, int reg, u8 val);
|
||||
* @param addr i2c device address (7 bits)
|
||||
* @param reg i2c 8-bit register address
|
||||
*
|
||||
* @return value or error if negative
|
||||
* Return: value or error if negative
|
||||
*/
|
||||
int cvmx_fdt_i2c_read8(int bus, int addr, int reg);
|
||||
|
||||
|
||||
@ -29,7 +29,7 @@
|
||||
* @param dfa_buffers
|
||||
* DFA command buffer. A relatively small (32 for example)
|
||||
* number should work.
|
||||
* @return Zero on success, non-zero if out of memory
|
||||
* Return: Zero on success, non-zero if out of memory
|
||||
*/
|
||||
int cvmx_helper_initialize_fpa(int packet_buffers, int work_queue_entries, int pko_buffers,
|
||||
int tim_buffers, int dfa_buffers);
|
||||
|
||||
@ -272,7 +272,7 @@ struct cvmx_fdt_gpio_led {
|
||||
* @param[in] fdt_addr Pointer to FDT
|
||||
* @param phandle phandle of GPIO entry
|
||||
*
|
||||
* @return Pointer to op function or NULL if not found.
|
||||
* Return: Pointer to op function or NULL if not found.
|
||||
*/
|
||||
cvmx_fdt_gpio_op_func_t cvmx_fdt_gpio_get_op_func(const void *fdt_addr, int phandle);
|
||||
|
||||
@ -283,7 +283,7 @@ cvmx_fdt_gpio_op_func_t cvmx_fdt_gpio_get_op_func(const void *fdt_addr, int phan
|
||||
* @param phandle phandle to GPIO
|
||||
* @param[out] size Number of pins (optional, may be NULL)
|
||||
*
|
||||
* @return Type of GPIO device or PIN_ERROR if error
|
||||
* Return: Type of GPIO device or PIN_ERROR if error
|
||||
*/
|
||||
enum cvmx_gpio_type cvmx_fdt_get_gpio_type(const void *fdt_addr, int phandle, int *size);
|
||||
|
||||
@ -294,7 +294,7 @@ enum cvmx_gpio_type cvmx_fdt_get_gpio_type(const void *fdt_addr, int phandle, in
|
||||
* @param of_offset node offset of GPIO device
|
||||
* @param prop_name name of property
|
||||
*
|
||||
* @return pointer to GPIO handle or NULL if error
|
||||
* Return: pointer to GPIO handle or NULL if error
|
||||
*/
|
||||
struct cvmx_fdt_gpio_info *cvmx_fdt_gpio_get_info(const void *fdt_addr, int of_offset,
|
||||
const char *prop_name);
|
||||
@ -306,7 +306,7 @@ struct cvmx_fdt_gpio_info *cvmx_fdt_gpio_get_info(const void *fdt_addr, int of_o
|
||||
* @param of_offset node offset for property
|
||||
* @param prop_name name of property
|
||||
*
|
||||
* @return pointer to GPIO handle or NULL if error
|
||||
* Return: pointer to GPIO handle or NULL if error
|
||||
*/
|
||||
struct cvmx_fdt_gpio_info *cvmx_fdt_gpio_get_info_phandle(const void *fdt_addr, int of_offset,
|
||||
const char *prop_name);
|
||||
@ -320,7 +320,7 @@ struct cvmx_fdt_gpio_info *cvmx_fdt_gpio_get_info_phandle(const void *fdt_addr,
|
||||
* @param flags flags set (1 = invert)
|
||||
* @param[out] gpio GPIO info data structure
|
||||
*
|
||||
* @return 0 for success, -1 on error
|
||||
* Return: 0 for success, -1 on error
|
||||
*/
|
||||
int cvmx_fdt_parse_gpio(const void *fdt_addr, int phandle, int pin, u32 flags,
|
||||
struct cvmx_fdt_gpio_info *gpio);
|
||||
@ -336,7 +336,7 @@ void cvmx_fdt_gpio_set_timer(struct cvmx_fdt_gpio_info *gpio, int timer);
|
||||
*
|
||||
* @param pin GPIO pin descriptor
|
||||
*
|
||||
* @return 0 if low, 1 if high, -1 on error. Note that the input will be
|
||||
* Return: 0 if low, 1 if high, -1 on error. Note that the input will be
|
||||
* inverted if the CVMX_GPIO_ACTIVE_LOW flag bit is set.
|
||||
*/
|
||||
int cvmx_fdt_gpio_get(struct cvmx_fdt_gpio_info *pin);
|
||||
@ -347,7 +347,7 @@ int cvmx_fdt_gpio_get(struct cvmx_fdt_gpio_info *pin);
|
||||
* @param gpio GPIO pin descriptor
|
||||
* @param value value to set it to, 0 or 1
|
||||
*
|
||||
* @return 0 on success, -1 on error.
|
||||
* Return: 0 on success, -1 on error.
|
||||
*
|
||||
* NOTE: If the CVMX_GPIO_ACTIVE_LOW flag is set then the output value will be
|
||||
* inverted.
|
||||
@ -368,7 +368,7 @@ void cvmx_fdt_gpio_set_freq(struct cvmx_fdt_gpio_info *gpio, int freq);
|
||||
* @param gpio GPIO handle
|
||||
* @param blink True to start blinking, false to stop
|
||||
*
|
||||
* @return 0 for success, -1 on error
|
||||
* Return: 0 for success, -1 on error
|
||||
* NOTE: Not all GPIO types support blinking.
|
||||
*/
|
||||
int cvmx_fdt_gpio_set_blink(struct cvmx_fdt_gpio_info *gpio, bool blink);
|
||||
@ -379,7 +379,7 @@ int cvmx_fdt_gpio_set_blink(struct cvmx_fdt_gpio_info *gpio, bool blink);
|
||||
* @param gpio GPIO handle
|
||||
* @param blink True to start blinking, false to use link status
|
||||
*
|
||||
* @return 0 for success, -1 on error
|
||||
* Return: 0 for success, -1 on error
|
||||
* NOTE: Not all GPIO types support this.
|
||||
*/
|
||||
int cvmx_fdt_gpio_set_link_blink(struct cvmx_fdt_gpio_info *gpio, bool blink);
|
||||
@ -404,7 +404,7 @@ void cvmx_fdt_gpio_set_output(struct cvmx_fdt_gpio_info *gpio, bool output);
|
||||
* @param gpio GPIO assigned to LED (can be NULL)
|
||||
* @param last Previous LED to build a list
|
||||
*
|
||||
* @return pointer to LED data structure or NULL if out of memory
|
||||
* Return: pointer to LED data structure or NULL if out of memory
|
||||
*/
|
||||
struct cvmx_fdt_gpio_led *cvmx_alloc_led(const char *name, int of_offset,
|
||||
struct cvmx_fdt_gpio_info *gpio,
|
||||
@ -418,7 +418,7 @@ struct cvmx_fdt_gpio_led *cvmx_alloc_led(const char *name, int of_offset,
|
||||
* @param gpio GPIO data structure to use (can be NULL)
|
||||
* @param last Previous LED if this is a group of LEDs
|
||||
*
|
||||
* @return Pointer to LED data structure or NULL if error
|
||||
* Return: Pointer to LED data structure or NULL if error
|
||||
*/
|
||||
struct cvmx_fdt_gpio_led *cvmx_fdt_parse_led(const void *fdt_addr, int led_of_offset,
|
||||
struct cvmx_fdt_gpio_info *gpio,
|
||||
|
||||
@ -48,7 +48,7 @@ void __cvmx_ilk_write_rx_cal_entry(int interface, int channel, unsigned char pip
|
||||
*
|
||||
* @param xiface Interface to probe
|
||||
*
|
||||
* @return Number of ports on the interface. Zero to disable.
|
||||
* Return: Number of ports on the interface. Zero to disable.
|
||||
*/
|
||||
int __cvmx_helper_ilk_probe(int xiface);
|
||||
|
||||
@ -60,7 +60,7 @@ int __cvmx_helper_ilk_probe(int xiface);
|
||||
*
|
||||
* @param xiface Interface to bring up
|
||||
*
|
||||
* @return Zero on success, negative on failure
|
||||
* Return: Zero on success, negative on failure
|
||||
*/
|
||||
int __cvmx_helper_ilk_enable(int xiface);
|
||||
|
||||
@ -70,7 +70,7 @@ int __cvmx_helper_ilk_enable(int xiface);
|
||||
*
|
||||
* @param ipd_port IPD/PKO port to query
|
||||
*
|
||||
* @return Link state
|
||||
* Return: Link state
|
||||
*/
|
||||
cvmx_helper_link_info_t __cvmx_helper_ilk_link_get(int ipd_port);
|
||||
|
||||
@ -85,7 +85,7 @@ cvmx_helper_link_info_t __cvmx_helper_ilk_link_get(int ipd_port);
|
||||
* @param ipd_port IPD/PKO port to configure
|
||||
* @param link_info The new link state
|
||||
*
|
||||
* @return Zero on success, negative on failure
|
||||
* Return: Zero on success, negative on failure
|
||||
*/
|
||||
int __cvmx_helper_ilk_link_set(int ipd_port, cvmx_helper_link_info_t link_info);
|
||||
|
||||
|
||||
@ -48,7 +48,7 @@ void cvmx_helper_qlm_jtag_init(void);
|
||||
* @param data Data to shift in. Bit 0 enters the chain first, followed by
|
||||
* bit 1, etc.
|
||||
*
|
||||
* @return The low order bits of the JTAG chain that shifted out of the
|
||||
* Return: The low order bits of the JTAG chain that shifted out of the
|
||||
* circle.
|
||||
*/
|
||||
u32 cvmx_helper_qlm_jtag_shift(int qlm, int bits, u32 data);
|
||||
|
||||
@ -17,7 +17,7 @@
|
||||
*
|
||||
* @param xiface Interface to probe
|
||||
*
|
||||
* @return Number of ports on the interface. Zero to disable.
|
||||
* Return: Number of ports on the interface. Zero to disable.
|
||||
*/
|
||||
int __cvmx_helper_loop_probe(int xiface);
|
||||
int __cvmx_helper_loop_enumerate(int xiface);
|
||||
@ -30,7 +30,7 @@ int __cvmx_helper_loop_enumerate(int xiface);
|
||||
*
|
||||
* @param xiface Interface to bring up
|
||||
*
|
||||
* @return Zero on success, negative on failure
|
||||
* Return: Zero on success, negative on failure
|
||||
*/
|
||||
int __cvmx_helper_loop_enable(int xiface);
|
||||
|
||||
|
||||
@ -17,7 +17,7 @@
|
||||
*
|
||||
* @param interface Interface to probe
|
||||
*
|
||||
* @return Number of ports on the interface. Zero to disable.
|
||||
* Return: Number of ports on the interface. Zero to disable.
|
||||
*/
|
||||
int __cvmx_helper_npi_probe(int interface);
|
||||
|
||||
@ -29,7 +29,7 @@ int __cvmx_helper_npi_probe(int interface);
|
||||
*
|
||||
* @param xiface Interface to bring up
|
||||
*
|
||||
* @return Zero on success, negative on failure
|
||||
* Return: Zero on success, negative on failure
|
||||
*/
|
||||
int __cvmx_helper_npi_enable(int xiface);
|
||||
|
||||
|
||||
@ -163,7 +163,7 @@ int cvmx_helper_pki_set_qpg_entry(int node, struct cvmx_pki_qpg_config *qpg_cfg)
|
||||
* @param bp_thresh backpressure threshold.
|
||||
* @param ena_drop enable tail drop.
|
||||
* 1:enable 0:disable
|
||||
* @return Zero on success. Negative on failure
|
||||
* Return: Zero on success. Negative on failure
|
||||
*/
|
||||
int cvmx_helper_setup_aura_qos(int node, int aura, bool ena_red, bool ena_drop, u64 pass_thresh,
|
||||
u64 drop_thresh, bool ena_bp, u64 bp_thresh);
|
||||
@ -177,7 +177,7 @@ int cvmx_helper_setup_aura_qos(int node, int aura, bool ena_red, bool ena_drop,
|
||||
* @param bpid bpid to map.
|
||||
* @param chl_map array of channels to map to that bpid.
|
||||
* @param chl_cnt number of channel/ports to map to that bpid.
|
||||
* @return Zero on success. Negative on failure
|
||||
* Return: Zero on success. Negative on failure
|
||||
*/
|
||||
int cvmx_helper_pki_map_aura_chl_bpid(int node, u16 aura, u16 bpid, u16 chl_map[], u16 chl_cnt);
|
||||
|
||||
|
||||
@ -12,7 +12,7 @@
|
||||
* Covers the common hardware, memory and global configuration.
|
||||
* Per-interface initialization is performed separately.
|
||||
*
|
||||
* @return 0 on success.
|
||||
* Return: 0 on success.
|
||||
*
|
||||
*/
|
||||
int cvmx_helper_pko3_init_global(unsigned int node);
|
||||
@ -29,7 +29,7 @@ int __cvmx_pko3_config_gen_interface(int xiface, u8 subif, u8 num_queues, bool p
|
||||
* Configure and initialize PKO3 for an interface
|
||||
*
|
||||
* @param interface is the interface number to configure
|
||||
* @return 0 on success.
|
||||
* Return: 0 on success.
|
||||
*
|
||||
*/
|
||||
int cvmx_helper_pko3_init_interface(int xiface);
|
||||
|
||||
@ -15,7 +15,7 @@
|
||||
*
|
||||
* @param xiface Interface to probe
|
||||
*
|
||||
* @return Number of RGMII/GMII/MII ports (0-4).
|
||||
* Return: Number of RGMII/GMII/MII ports (0-4).
|
||||
*/
|
||||
int __cvmx_helper_rgmii_probe(int xiface);
|
||||
|
||||
@ -35,7 +35,7 @@ void cvmx_helper_rgmii_internal_loopback(int port);
|
||||
*
|
||||
* @param xiface PKO Interface to configure (0 or 1)
|
||||
*
|
||||
* @return Zero on success
|
||||
* Return: Zero on success
|
||||
*/
|
||||
int __cvmx_helper_rgmii_enable(int xiface);
|
||||
|
||||
@ -48,7 +48,7 @@ int __cvmx_helper_rgmii_enable(int xiface);
|
||||
*
|
||||
* @param ipd_port IPD/PKO port to query
|
||||
*
|
||||
* @return Link state
|
||||
* Return: Link state
|
||||
*/
|
||||
cvmx_helper_link_info_t __cvmx_helper_gmii_link_get(int ipd_port);
|
||||
|
||||
@ -61,7 +61,7 @@ cvmx_helper_link_info_t __cvmx_helper_gmii_link_get(int ipd_port);
|
||||
*
|
||||
* @param ipd_port IPD/PKO port to query
|
||||
*
|
||||
* @return Link state
|
||||
* Return: Link state
|
||||
*/
|
||||
cvmx_helper_link_info_t __cvmx_helper_rgmii_link_get(int ipd_port);
|
||||
|
||||
@ -76,7 +76,7 @@ cvmx_helper_link_info_t __cvmx_helper_rgmii_link_get(int ipd_port);
|
||||
* @param ipd_port IPD/PKO port to configure
|
||||
* @param link_info The new link state
|
||||
*
|
||||
* @return Zero on success, negative on failure
|
||||
* Return: Zero on success, negative on failure
|
||||
*/
|
||||
int __cvmx_helper_rgmii_link_set(int ipd_port, cvmx_helper_link_info_t link_info);
|
||||
|
||||
@ -92,7 +92,7 @@ int __cvmx_helper_rgmii_link_set(int ipd_port, cvmx_helper_link_info_t link_info
|
||||
* @param enable_external
|
||||
* Non zero if you want external loopback
|
||||
*
|
||||
* @return Zero on success, negative on failure.
|
||||
* Return: Zero on success, negative on failure.
|
||||
*/
|
||||
int __cvmx_helper_rgmii_configure_loopback(int ipd_port, int enable_internal, int enable_external);
|
||||
|
||||
|
||||
@ -264,7 +264,7 @@ struct cvmx_sfp_mod_info {
|
||||
* @param i2c_bus i2c bus number to read from for SFP port
|
||||
* @param i2c_addr i2c address to use, 0 for default
|
||||
*
|
||||
* @return -1 if invalid bus or i2c read error, 0 for success
|
||||
* Return: -1 if invalid bus or i2c read error, 0 for success
|
||||
*/
|
||||
int cvmx_phy_sfp_read_i2c_eeprom(u8 *buffer, int i2c_bus, int i2c_addr);
|
||||
|
||||
@ -275,7 +275,7 @@ int cvmx_phy_sfp_read_i2c_eeprom(u8 *buffer, int i2c_bus, int i2c_addr);
|
||||
* @param[out] sfp_info Info about SFP module
|
||||
* @param[in] buffer SFP EEPROM buffer to parse
|
||||
*
|
||||
* @return 0 on success, -1 if error reading EEPROM or if EEPROM corrupt
|
||||
* Return: 0 on success, -1 if error reading EEPROM or if EEPROM corrupt
|
||||
*/
|
||||
int cvmx_phy_sfp_parse_eeprom(struct cvmx_sfp_mod_info *sfp_info, const u8 *buffer);
|
||||
|
||||
@ -291,7 +291,7 @@ void cvmx_phy_sfp_print_info(const struct cvmx_sfp_mod_info *sfp_info);
|
||||
*
|
||||
* @param sfp sfp handle to read
|
||||
*
|
||||
* @return 0 for success, -1 on error.
|
||||
* Return: 0 for success, -1 on error.
|
||||
*/
|
||||
int cvmx_sfp_read_i2c_eeprom(struct cvmx_fdt_sfp_info *sfp);
|
||||
|
||||
@ -300,7 +300,7 @@ int cvmx_sfp_read_i2c_eeprom(struct cvmx_fdt_sfp_info *sfp);
|
||||
*
|
||||
* @param sfp sfp handle
|
||||
*
|
||||
* @return sfp_info Pointer sfp mod info data structure
|
||||
* Return: sfp_info Pointer sfp mod info data structure
|
||||
*/
|
||||
const struct cvmx_sfp_mod_info *cvmx_phy_get_sfp_mod_info(const struct cvmx_fdt_sfp_info *sfp);
|
||||
|
||||
@ -311,7 +311,7 @@ const struct cvmx_sfp_mod_info *cvmx_phy_get_sfp_mod_info(const struct cvmx_fdt_
|
||||
* @param sfp Handle to SFP information.
|
||||
* @param data User-defined data passed to the function
|
||||
*
|
||||
* @return 0 if absent, 1 if present, -1 on error
|
||||
* Return: 0 if absent, 1 if present, -1 on error
|
||||
*/
|
||||
int cvmx_sfp_check_mod_abs(struct cvmx_fdt_sfp_info *sfp, void *data);
|
||||
|
||||
@ -323,7 +323,7 @@ int cvmx_sfp_check_mod_abs(struct cvmx_fdt_sfp_info *sfp, void *data);
|
||||
* @param check_mod_abs Function to be called or NULL to remove
|
||||
* @param mod_abs_data User-defined data to be passed to check_mod_abs
|
||||
*
|
||||
* @return 0 for success
|
||||
* Return: 0 for success
|
||||
*/
|
||||
int cvmx_sfp_register_check_mod_abs(struct cvmx_fdt_sfp_info *sfp,
|
||||
int (*check_mod_abs)(struct cvmx_fdt_sfp_info *sfp, void *data),
|
||||
@ -339,7 +339,7 @@ int cvmx_sfp_register_check_mod_abs(struct cvmx_fdt_sfp_info *sfp,
|
||||
* @param mod_abs_changed_data User-defined data passed to
|
||||
* mod_abs_changed
|
||||
*
|
||||
* @return 0 for success
|
||||
* Return: 0 for success
|
||||
*/
|
||||
int cvmx_sfp_register_mod_abs_changed(struct cvmx_fdt_sfp_info *sfp,
|
||||
int (*mod_abs_changed)(struct cvmx_fdt_sfp_info *sfp, int val,
|
||||
@ -352,7 +352,7 @@ int cvmx_sfp_register_mod_abs_changed(struct cvmx_fdt_sfp_info *sfp,
|
||||
* @param sfp Handle to SFP information.
|
||||
* @param data User-defined data passed to the function
|
||||
*
|
||||
* @return 0 if signal present, 1 if signal absent, -1 on error
|
||||
* Return: 0 if signal present, 1 if signal absent, -1 on error
|
||||
*/
|
||||
int cvmx_sfp_check_tx_fault(struct cvmx_fdt_sfp_info *sfp, void *data);
|
||||
|
||||
@ -362,7 +362,7 @@ int cvmx_sfp_check_tx_fault(struct cvmx_fdt_sfp_info *sfp, void *data);
|
||||
* @param sfp Handle to SFP information.
|
||||
* @param data User-defined data passed to the function
|
||||
*
|
||||
* @return 0 if signal present, 1 if signal absent, -1 on error
|
||||
* Return: 0 if signal present, 1 if signal absent, -1 on error
|
||||
*/
|
||||
int cvmx_sfp_check_rx_los(struct cvmx_fdt_sfp_info *sfp, void *data);
|
||||
|
||||
@ -375,7 +375,7 @@ int cvmx_sfp_check_rx_los(struct cvmx_fdt_sfp_info *sfp, void *data);
|
||||
* @param rx_los_changed_data User-defined data passed to
|
||||
* rx_los_changed
|
||||
*
|
||||
* @return 0 for success
|
||||
* Return: 0 for success
|
||||
*/
|
||||
int cvmx_sfp_register_rx_los_changed(struct cvmx_fdt_sfp_info *sfp,
|
||||
int (*rx_los_changed)(struct cvmx_fdt_sfp_info *sfp, int val,
|
||||
@ -387,7 +387,7 @@ int cvmx_sfp_register_rx_los_changed(struct cvmx_fdt_sfp_info *sfp,
|
||||
*
|
||||
* @param fdt_addr Address of flat device-tree
|
||||
*
|
||||
* @return 0 for success, -1 on error
|
||||
* Return: 0 for success, -1 on error
|
||||
*/
|
||||
int cvmx_sfp_parse_device_tree(const void *fdt_addr);
|
||||
|
||||
@ -396,7 +396,7 @@ int cvmx_sfp_parse_device_tree(const void *fdt_addr);
|
||||
*
|
||||
* @param ipd_port IPD port number to search for
|
||||
*
|
||||
* @return pointer to SFP data structure or NULL if not found
|
||||
* Return: pointer to SFP data structure or NULL if not found
|
||||
*/
|
||||
struct cvmx_fdt_sfp_info *cvmx_sfp_find_slot_by_port(int ipd_port);
|
||||
|
||||
@ -405,14 +405,14 @@ struct cvmx_fdt_sfp_info *cvmx_sfp_find_slot_by_port(int ipd_port);
|
||||
*
|
||||
* @param of_offset flat device tree node offset
|
||||
*
|
||||
* @return pointer to SFP data structure or NULL if not found
|
||||
* Return: pointer to SFP data structure or NULL if not found
|
||||
*/
|
||||
struct cvmx_fdt_sfp_info *cvmx_sfp_find_slot_by_fdt_node(int of_offset);
|
||||
|
||||
/**
|
||||
* Reads the EEPROMs of all SFP modules.
|
||||
*
|
||||
* @return 0 for success
|
||||
* Return: 0 for success
|
||||
*/
|
||||
int cvmx_sfp_read_all_modules(void);
|
||||
|
||||
@ -422,7 +422,7 @@ int cvmx_sfp_read_all_modules(void);
|
||||
* @param[in] sfp SFP port to check
|
||||
* @param mode interface mode
|
||||
*
|
||||
* @return true if module is valid, false if invalid
|
||||
* Return: true if module is valid, false if invalid
|
||||
* NOTE: This will also toggle the error LED, if present
|
||||
*/
|
||||
bool cvmx_sfp_validate_module(struct cvmx_fdt_sfp_info *sfp, int mode);
|
||||
|
||||
@ -17,7 +17,7 @@
|
||||
*
|
||||
* @param xiface Interface to probe
|
||||
*
|
||||
* @return Number of ports on the interface. Zero to disable.
|
||||
* Return: Number of ports on the interface. Zero to disable.
|
||||
*/
|
||||
int __cvmx_helper_sgmii_probe(int xiface);
|
||||
int __cvmx_helper_sgmii_enumerate(int xiface);
|
||||
@ -30,7 +30,7 @@ int __cvmx_helper_sgmii_enumerate(int xiface);
|
||||
*
|
||||
* @param xiface Interface to bring up
|
||||
*
|
||||
* @return Zero on success, negative on failure
|
||||
* Return: Zero on success, negative on failure
|
||||
*/
|
||||
int __cvmx_helper_sgmii_enable(int xiface);
|
||||
|
||||
@ -43,7 +43,7 @@ int __cvmx_helper_sgmii_enable(int xiface);
|
||||
*
|
||||
* @param ipd_port IPD/PKO port to query
|
||||
*
|
||||
* @return Link state
|
||||
* Return: Link state
|
||||
*/
|
||||
cvmx_helper_link_info_t __cvmx_helper_sgmii_link_get(int ipd_port);
|
||||
|
||||
@ -58,7 +58,7 @@ cvmx_helper_link_info_t __cvmx_helper_sgmii_link_get(int ipd_port);
|
||||
* @param ipd_port IPD/PKO port to configure
|
||||
* @param link_info The new link state
|
||||
*
|
||||
* @return Zero on success, negative on failure
|
||||
* Return: Zero on success, negative on failure
|
||||
*/
|
||||
int __cvmx_helper_sgmii_link_set(int ipd_port, cvmx_helper_link_info_t link_info);
|
||||
|
||||
@ -74,7 +74,7 @@ int __cvmx_helper_sgmii_link_set(int ipd_port, cvmx_helper_link_info_t link_info
|
||||
* @param enable_external
|
||||
* Non zero if you want external loopback
|
||||
*
|
||||
* @return Zero on success, negative on failure.
|
||||
* Return: Zero on success, negative on failure.
|
||||
*/
|
||||
int __cvmx_helper_sgmii_configure_loopback(int ipd_port, int enable_internal, int enable_external);
|
||||
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
*
|
||||
* @param interface Interface to probe
|
||||
*
|
||||
* @return Number of ports on the interface. Zero to disable.
|
||||
* Return: Number of ports on the interface. Zero to disable.
|
||||
*/
|
||||
int __cvmx_helper_spi_probe(int interface);
|
||||
int __cvmx_helper_spi_enumerate(int interface);
|
||||
@ -32,7 +32,7 @@ int __cvmx_helper_spi_enumerate(int interface);
|
||||
*
|
||||
* @param interface Interface to bring up
|
||||
*
|
||||
* @return Zero on success, negative on failure
|
||||
* Return: Zero on success, negative on failure
|
||||
*/
|
||||
int __cvmx_helper_spi_enable(int interface);
|
||||
|
||||
@ -45,7 +45,7 @@ int __cvmx_helper_spi_enable(int interface);
|
||||
*
|
||||
* @param ipd_port IPD/PKO port to query
|
||||
*
|
||||
* @return Link state
|
||||
* Return: Link state
|
||||
*/
|
||||
cvmx_helper_link_info_t __cvmx_helper_spi_link_get(int ipd_port);
|
||||
|
||||
@ -60,7 +60,7 @@ cvmx_helper_link_info_t __cvmx_helper_spi_link_get(int ipd_port);
|
||||
* @param ipd_port IPD/PKO port to configure
|
||||
* @param link_info The new link state
|
||||
*
|
||||
* @return Zero on success, negative on failure
|
||||
* Return: Zero on success, negative on failure
|
||||
*/
|
||||
int __cvmx_helper_spi_link_set(int ipd_port, cvmx_helper_link_info_t link_info);
|
||||
|
||||
|
||||
@ -16,7 +16,7 @@
|
||||
*
|
||||
* @param xiface Interface to convert
|
||||
*
|
||||
* @return Srio link number
|
||||
* Return: Srio link number
|
||||
*/
|
||||
int __cvmx_helper_srio_port(int xiface);
|
||||
|
||||
@ -28,7 +28,7 @@ int __cvmx_helper_srio_port(int xiface);
|
||||
*
|
||||
* @param xiface Interface to probe
|
||||
*
|
||||
* @return Number of ports on the interface. Zero to disable.
|
||||
* Return: Number of ports on the interface. Zero to disable.
|
||||
*/
|
||||
int __cvmx_helper_srio_probe(int xiface);
|
||||
|
||||
@ -40,7 +40,7 @@ int __cvmx_helper_srio_probe(int xiface);
|
||||
*
|
||||
* @param xiface Interface to bring up
|
||||
*
|
||||
* @return Zero on success, negative on failure
|
||||
* Return: Zero on success, negative on failure
|
||||
*/
|
||||
int __cvmx_helper_srio_enable(int xiface);
|
||||
|
||||
@ -50,7 +50,7 @@ int __cvmx_helper_srio_enable(int xiface);
|
||||
*
|
||||
* @param ipd_port IPD/PKO port to query
|
||||
*
|
||||
* @return Link state
|
||||
* Return: Link state
|
||||
*/
|
||||
cvmx_helper_link_info_t __cvmx_helper_srio_link_get(int ipd_port);
|
||||
|
||||
@ -65,7 +65,7 @@ cvmx_helper_link_info_t __cvmx_helper_srio_link_get(int ipd_port);
|
||||
* @param ipd_port IPD/PKO port to configure
|
||||
* @param link_info The new link state
|
||||
*
|
||||
* @return Zero on success, negative on failure
|
||||
* Return: Zero on success, negative on failure
|
||||
*/
|
||||
int __cvmx_helper_srio_link_set(int ipd_port, cvmx_helper_link_info_t link_info);
|
||||
|
||||
|
||||
@ -82,7 +82,7 @@ typedef struct cvmx_xiface cvmx_xiface_t;
|
||||
*
|
||||
* @param xiface interface with node information
|
||||
*
|
||||
* @return struct that contains node and interface number.
|
||||
* Return: struct that contains node and interface number.
|
||||
*/
|
||||
static inline struct cvmx_xiface cvmx_helper_xiface_to_node_interface(int xiface)
|
||||
{
|
||||
@ -237,7 +237,7 @@ static inline void cvmx_wqe_pki_free(cvmx_wqe_t *work)
|
||||
*
|
||||
* @param mode Mode to convert
|
||||
*
|
||||
* @return String
|
||||
* Return: String
|
||||
*/
|
||||
const char *cvmx_helper_interface_mode_to_string(cvmx_helper_interface_mode_t mode);
|
||||
|
||||
@ -252,7 +252,7 @@ int cvmx_helper_dump_packet(cvmx_wqe_t *work);
|
||||
/**
|
||||
* Get the version of the CVMX libraries.
|
||||
*
|
||||
* @return Version string. Note this buffer is allocated statically
|
||||
* Return: Version string. Note this buffer is allocated statically
|
||||
* and will be shared by all callers.
|
||||
*/
|
||||
const char *cvmx_helper_get_version(void);
|
||||
@ -266,7 +266,7 @@ const char *cvmx_helper_get_version(void);
|
||||
* @param xiface Interface to configure
|
||||
* @param num_ports Number of ports on the interface
|
||||
*
|
||||
* @return Zero on success, negative on failure
|
||||
* Return: Zero on success, negative on failure
|
||||
*/
|
||||
int __cvmx_helper_setup_gmx(int xiface, int num_ports);
|
||||
|
||||
@ -276,7 +276,7 @@ int __cvmx_helper_setup_gmx(int xiface, int num_ports);
|
||||
*
|
||||
* @param interface
|
||||
*
|
||||
* @return the number of pko_ports on the interface.
|
||||
* Return: the number of pko_ports on the interface.
|
||||
*/
|
||||
int __cvmx_helper_get_num_pko_ports(int interface);
|
||||
|
||||
@ -287,7 +287,7 @@ int __cvmx_helper_get_num_pko_ports(int interface);
|
||||
* @param interface Interface to use
|
||||
* @param port Port on the interface
|
||||
*
|
||||
* @return IPD port number
|
||||
* Return: IPD port number
|
||||
*/
|
||||
int cvmx_helper_get_ipd_port(int interface, int port);
|
||||
|
||||
@ -298,7 +298,7 @@ int cvmx_helper_get_ipd_port(int interface, int port);
|
||||
* @param interface Interface to use
|
||||
* @param port Port on the interface
|
||||
*
|
||||
* @return PKO port number and -1 on error.
|
||||
* Return: PKO port number and -1 on error.
|
||||
*/
|
||||
int cvmx_helper_get_pko_port(int interface, int port);
|
||||
|
||||
@ -308,7 +308,7 @@ int cvmx_helper_get_pko_port(int interface, int port);
|
||||
*
|
||||
* @param interface Interface to use
|
||||
*
|
||||
* @return IPD/PKO port number
|
||||
* Return: IPD/PKO port number
|
||||
*/
|
||||
static inline int cvmx_helper_get_first_ipd_port(int interface)
|
||||
{
|
||||
@ -323,7 +323,7 @@ int cvmx_helper_ports_on_interface(int interface);
|
||||
*
|
||||
* @param interface Interface to use
|
||||
*
|
||||
* @return IPD/PKO port number
|
||||
* Return: IPD/PKO port number
|
||||
*
|
||||
* Note: for o68, the last ipd port on an interface does not always equal to
|
||||
* the first plus the number of ports as the ipd ports are not contiguous in
|
||||
@ -354,7 +354,7 @@ void cvmx_helper_free_packet_data(cvmx_wqe_t *work);
|
||||
*
|
||||
* @param ipd_port IPD/PKO port number
|
||||
*
|
||||
* @return Interface number
|
||||
* Return: Interface number
|
||||
*/
|
||||
int cvmx_helper_get_interface_num(int ipd_port);
|
||||
|
||||
@ -364,7 +364,7 @@ int cvmx_helper_get_interface_num(int ipd_port);
|
||||
*
|
||||
* @param ipd_port IPD/PKO port number
|
||||
*
|
||||
* @return Interface index number
|
||||
* Return: Interface index number
|
||||
*/
|
||||
int cvmx_helper_get_interface_index_num(int ipd_port);
|
||||
|
||||
@ -374,7 +374,7 @@ int cvmx_helper_get_interface_index_num(int ipd_port);
|
||||
* @param xiface Interface
|
||||
* @param index index of the port in the interface
|
||||
*
|
||||
* @return port kind on sucicess and -1 on failure
|
||||
* Return: port kind on sucicess and -1 on failure
|
||||
*/
|
||||
int cvmx_helper_get_pknd(int xiface, int index);
|
||||
|
||||
@ -384,7 +384,7 @@ int cvmx_helper_get_pknd(int xiface, int index);
|
||||
* @param interface Interface
|
||||
* @param port index of the port in the interface
|
||||
*
|
||||
* @return port kind on sucicess and -1 on failure
|
||||
* Return: port kind on sucicess and -1 on failure
|
||||
*/
|
||||
int cvmx_helper_get_bpid(int interface, int port);
|
||||
|
||||
|
||||
@ -17,7 +17,7 @@
|
||||
*
|
||||
* @param xiface Interface to probe
|
||||
*
|
||||
* @return Number of ports on the interface. Zero to disable.
|
||||
* Return: Number of ports on the interface. Zero to disable.
|
||||
*/
|
||||
int __cvmx_helper_xaui_probe(int xiface);
|
||||
int __cvmx_helper_xaui_enumerate(int xiface);
|
||||
@ -30,7 +30,7 @@ int __cvmx_helper_xaui_enumerate(int xiface);
|
||||
*
|
||||
* @param xiface Interface to bring up
|
||||
*
|
||||
* @return Zero on success, negative on failure
|
||||
* Return: Zero on success, negative on failure
|
||||
*/
|
||||
int __cvmx_helper_xaui_enable(int xiface);
|
||||
|
||||
@ -47,7 +47,7 @@ int __cvmx_helper_xaui_enable(int xiface);
|
||||
*
|
||||
* @param interface Interface to retrain
|
||||
*
|
||||
* @return Zero on success, negative on failure
|
||||
* Return: Zero on success, negative on failure
|
||||
*/
|
||||
int cvmx_helper_xaui_link_retrain(int interface);
|
||||
|
||||
@ -57,7 +57,7 @@ int cvmx_helper_xaui_link_retrain(int interface);
|
||||
*
|
||||
* @param interface Interface to reinitialize
|
||||
*
|
||||
* @return 0 on success, negative on failure
|
||||
* Return: 0 on success, negative on failure
|
||||
*/
|
||||
int cvmx_helper_xaui_link_reinit(int interface);
|
||||
|
||||
@ -70,7 +70,7 @@ int cvmx_helper_xaui_link_reinit(int interface);
|
||||
*
|
||||
* @param ipd_port IPD/PKO port to query
|
||||
*
|
||||
* @return Link state
|
||||
* Return: Link state
|
||||
*/
|
||||
cvmx_helper_link_info_t __cvmx_helper_xaui_link_get(int ipd_port);
|
||||
|
||||
@ -85,7 +85,7 @@ cvmx_helper_link_info_t __cvmx_helper_xaui_link_get(int ipd_port);
|
||||
* @param ipd_port IPD/PKO port to configure
|
||||
* @param link_info The new link state
|
||||
*
|
||||
* @return Zero on success, negative on failure
|
||||
* Return: Zero on success, negative on failure
|
||||
*/
|
||||
int __cvmx_helper_xaui_link_set(int ipd_port, cvmx_helper_link_info_t link_info);
|
||||
|
||||
@ -101,7 +101,7 @@ int __cvmx_helper_xaui_link_set(int ipd_port, cvmx_helper_link_info_t link_info)
|
||||
* @param enable_external
|
||||
* Non zero if you want external loopback
|
||||
*
|
||||
* @return Zero on success, negative on failure.
|
||||
* Return: Zero on success, negative on failure.
|
||||
*/
|
||||
int __cvmx_helper_xaui_configure_loopback(int ipd_port, int enable_internal, int enable_external);
|
||||
|
||||
|
||||
@ -134,7 +134,7 @@ enum cvmx_pko_padding {
|
||||
* IPD configuration changes are made if CVMX_HELPER_ENABLE_IPD
|
||||
* is not set in the executive-config.h file.
|
||||
*
|
||||
* @return 0 on success
|
||||
* Return: 0 on success
|
||||
* -1 on failure
|
||||
*/
|
||||
int cvmx_helper_ipd_and_packet_input_enable_node(int node);
|
||||
@ -146,7 +146,7 @@ int cvmx_helper_ipd_and_packet_input_enable(void);
|
||||
* @param wqe_entries The maximum number of work queue entries to be
|
||||
* supported.
|
||||
*
|
||||
* @return Zero on success, non-zero on failure.
|
||||
* Return: Zero on success, non-zero on failure.
|
||||
*/
|
||||
int cvmx_helper_initialize_sso(int wqe_entries);
|
||||
|
||||
@ -157,14 +157,14 @@ int cvmx_helper_initialize_sso(int wqe_entries);
|
||||
* @param wqe_entries The maximum number of work queue entries to be
|
||||
* supported.
|
||||
*
|
||||
* @return Zero on success, non-zero on failure.
|
||||
* Return: Zero on success, non-zero on failure.
|
||||
*/
|
||||
int cvmx_helper_initialize_sso_node(unsigned int node, int wqe_entries);
|
||||
|
||||
/**
|
||||
* Undo the effect of cvmx_helper_initialize_sso().
|
||||
*
|
||||
* @return Zero on success, non-zero on failure.
|
||||
* Return: Zero on success, non-zero on failure.
|
||||
*/
|
||||
int cvmx_helper_uninitialize_sso(void);
|
||||
|
||||
@ -173,7 +173,7 @@ int cvmx_helper_uninitialize_sso(void);
|
||||
*
|
||||
* @param node Node SSO to initialize
|
||||
*
|
||||
* @return Zero on success, non-zero on failure.
|
||||
* Return: Zero on success, non-zero on failure.
|
||||
*/
|
||||
int cvmx_helper_uninitialize_sso_node(unsigned int node);
|
||||
|
||||
@ -184,7 +184,7 @@ int cvmx_helper_uninitialize_sso_node(unsigned int node);
|
||||
* on CVMX_PKO_QUEUES_PER_PORT_* where each queue is lower
|
||||
* priority than the previous.
|
||||
*
|
||||
* @return Zero on success, non-zero on failure
|
||||
* Return: Zero on success, non-zero on failure
|
||||
*/
|
||||
int cvmx_helper_initialize_packet_io_global(void);
|
||||
/**
|
||||
@ -196,14 +196,14 @@ int cvmx_helper_initialize_packet_io_global(void);
|
||||
*
|
||||
* @param node Node on which to initialize packet io hardware
|
||||
*
|
||||
* @return Zero on success, non-zero on failure
|
||||
* Return: Zero on success, non-zero on failure
|
||||
*/
|
||||
int cvmx_helper_initialize_packet_io_node(unsigned int node);
|
||||
|
||||
/**
|
||||
* Does core local initialization for packet io
|
||||
*
|
||||
* @return Zero on success, non-zero on failure
|
||||
* Return: Zero on success, non-zero on failure
|
||||
*/
|
||||
int cvmx_helper_initialize_packet_io_local(void);
|
||||
|
||||
@ -216,7 +216,7 @@ int cvmx_helper_initialize_packet_io_local(void);
|
||||
* buffers used by the packet IO hardware to the FPA so a function emptying the
|
||||
* FPA after shutdown should find all packet buffers in the FPA.
|
||||
*
|
||||
* @return Zero on success, negative on failure.
|
||||
* Return: Zero on success, negative on failure.
|
||||
*/
|
||||
int cvmx_helper_shutdown_packet_io_global(void);
|
||||
|
||||
@ -228,7 +228,7 @@ int cvmx_helper_shutdown_packet_io_global_cn78xx(int node);
|
||||
/**
|
||||
* Does core local shutdown of packet io
|
||||
*
|
||||
* @return Zero on success, non-zero on failure
|
||||
* Return: Zero on success, non-zero on failure
|
||||
*/
|
||||
int cvmx_helper_shutdown_packet_io_local(void);
|
||||
|
||||
@ -239,7 +239,7 @@ int cvmx_helper_shutdown_packet_io_local(void);
|
||||
*
|
||||
* @param interface Which interface to return port count for.
|
||||
*
|
||||
* @return Port count for interface
|
||||
* Return: Port count for interface
|
||||
* -1 for uninitialized interface
|
||||
*/
|
||||
int cvmx_helper_ports_on_interface(int interface);
|
||||
@ -250,7 +250,7 @@ int cvmx_helper_ports_on_interface(int interface);
|
||||
* but the CNX0XX and CNX1XX are exceptions. These only support
|
||||
* one interface.
|
||||
*
|
||||
* @return Number of interfaces on chip
|
||||
* Return: Number of interfaces on chip
|
||||
*/
|
||||
int cvmx_helper_get_number_of_interfaces(void);
|
||||
|
||||
@ -261,7 +261,7 @@ int cvmx_helper_get_number_of_interfaces(void);
|
||||
*
|
||||
* @param xiface Interface to probe
|
||||
*
|
||||
* @return Mode of the interface. Unknown or unsupported interfaces return
|
||||
* Return: Mode of the interface. Unknown or unsupported interfaces return
|
||||
* DISABLED.
|
||||
*/
|
||||
cvmx_helper_interface_mode_t cvmx_helper_interface_get_mode(int xiface);
|
||||
@ -273,7 +273,7 @@ cvmx_helper_interface_mode_t cvmx_helper_interface_get_mode(int xiface);
|
||||
*
|
||||
* @param ipd_port IPD/PKO port to auto configure
|
||||
*
|
||||
* @return Link state after configure
|
||||
* Return: Link state after configure
|
||||
*/
|
||||
cvmx_helper_link_info_t cvmx_helper_link_autoconf(int ipd_port);
|
||||
|
||||
@ -285,7 +285,7 @@ cvmx_helper_link_info_t cvmx_helper_link_autoconf(int ipd_port);
|
||||
*
|
||||
* @param ipd_port IPD/PKO port to query
|
||||
*
|
||||
* @return Link state
|
||||
* Return: Link state
|
||||
*/
|
||||
cvmx_helper_link_info_t cvmx_helper_link_get(int ipd_port);
|
||||
|
||||
@ -299,7 +299,7 @@ cvmx_helper_link_info_t cvmx_helper_link_get(int ipd_port);
|
||||
* @param ipd_port IPD/PKO port to configure
|
||||
* @param link_info The new link state
|
||||
*
|
||||
* @return Zero on success, negative on failure
|
||||
* Return: Zero on success, negative on failure
|
||||
*/
|
||||
int cvmx_helper_link_set(int ipd_port, cvmx_helper_link_info_t link_info);
|
||||
|
||||
@ -312,7 +312,7 @@ int cvmx_helper_link_set(int ipd_port, cvmx_helper_link_info_t link_info);
|
||||
*
|
||||
* @param xiface Interface to probe
|
||||
*
|
||||
* @return Zero on success, negative on failure
|
||||
* Return: Zero on success, negative on failure
|
||||
*/
|
||||
int cvmx_helper_interface_probe(int xiface);
|
||||
|
||||
@ -322,7 +322,7 @@ int cvmx_helper_interface_probe(int xiface);
|
||||
*
|
||||
* @param xiface Interface to enumerate
|
||||
*
|
||||
* @return Zero on success, negative on failure
|
||||
* Return: Zero on success, negative on failure
|
||||
*/
|
||||
int cvmx_helper_interface_enumerate(int xiface);
|
||||
|
||||
@ -337,7 +337,7 @@ int cvmx_helper_interface_enumerate(int xiface);
|
||||
* @param enable_external
|
||||
* Non zero if you want external loopback
|
||||
*
|
||||
* @return Zero on success, negative on failure.
|
||||
* Return: Zero on success, negative on failure.
|
||||
*/
|
||||
int cvmx_helper_configure_loopback(int ipd_port, int enable_internal, int enable_external);
|
||||
|
||||
@ -346,7 +346,7 @@ int cvmx_helper_configure_loopback(int ipd_port, int enable_internal, int enable
|
||||
*
|
||||
* @param interface Which interface to return port count for.
|
||||
*
|
||||
* @return Port count for interface
|
||||
* Return: Port count for interface
|
||||
* -1 for uninitialized interface
|
||||
*/
|
||||
int __cvmx_helper_early_ports_on_interface(int interface);
|
||||
@ -404,7 +404,7 @@ static inline u8 cvmx_helper_prio2qos(u8 prio)
|
||||
*
|
||||
* @param xiface
|
||||
*
|
||||
* @return the number of ipd_ports on the interface and -1 for error.
|
||||
* Return: the number of ipd_ports on the interface and -1 for error.
|
||||
*/
|
||||
int __cvmx_helper_get_num_ipd_ports(int xiface);
|
||||
|
||||
@ -419,7 +419,7 @@ enum cvmx_pko_padding __cvmx_helper_get_pko_padding(int xiface);
|
||||
* @param pad The padding that PKO should apply.
|
||||
* interface.
|
||||
*
|
||||
* @return 0 for success and -1 for failure
|
||||
* Return: 0 for success and -1 for failure
|
||||
*/
|
||||
int __cvmx_helper_init_interface(int xiface, int num_ipd_ports, int has_fcs,
|
||||
enum cvmx_pko_padding pad);
|
||||
@ -434,14 +434,14 @@ void __cvmx_helper_shutdown_interfaces(void);
|
||||
* hardware ports. PKO should still be disabled to make sure packets
|
||||
* aren't sent out partially setup hardware.
|
||||
*
|
||||
* @return Zero on success, negative on failure
|
||||
* Return: Zero on success, negative on failure
|
||||
*/
|
||||
int __cvmx_helper_packet_hardware_enable(int xiface);
|
||||
|
||||
/*
|
||||
* @INTERNAL
|
||||
*
|
||||
* @return 0 for success and -1 for failure
|
||||
* Return: 0 for success and -1 for failure
|
||||
*/
|
||||
int __cvmx_helper_set_link_info(int xiface, int index, cvmx_helper_link_info_t link_info);
|
||||
|
||||
@ -451,7 +451,7 @@ int __cvmx_helper_set_link_info(int xiface, int index, cvmx_helper_link_info_t l
|
||||
* @param xiface
|
||||
* @param port
|
||||
*
|
||||
* @return valid link_info on success or -1 on failure
|
||||
* Return: valid link_info on success or -1 on failure
|
||||
*/
|
||||
cvmx_helper_link_info_t __cvmx_helper_get_link_info(int xiface, int port);
|
||||
|
||||
@ -460,7 +460,7 @@ cvmx_helper_link_info_t __cvmx_helper_get_link_info(int xiface, int port);
|
||||
*
|
||||
* @param xiface
|
||||
*
|
||||
* @return 0 if PKO does not do FCS and 1 otherwise.
|
||||
* Return: 0 if PKO does not do FCS and 1 otherwise.
|
||||
*/
|
||||
int __cvmx_helper_get_has_fcs(int xiface);
|
||||
|
||||
@ -513,7 +513,7 @@ typedef struct cvmx_qos_config {
|
||||
* Initialize QoS configuraiton with the SDK defaults.
|
||||
*
|
||||
* @param qos_cfg User QOS configuration parameters.
|
||||
* @return Zero on success, negative number otherwise.
|
||||
* Return: Zero on success, negative number otherwise.
|
||||
*/
|
||||
int cvmx_helper_qos_config_init(cvmx_qos_proto_t qos_proto, cvmx_qos_config_t *qos_cfg);
|
||||
|
||||
@ -523,7 +523,7 @@ int cvmx_helper_qos_config_init(cvmx_qos_proto_t qos_proto, cvmx_qos_config_t *q
|
||||
*
|
||||
* @param xipdport Global IPD port
|
||||
* @param qos_cfg User QOS configuration parameters.
|
||||
* @return Zero on success, negative number otherwise.
|
||||
* Return: Zero on success, negative number otherwise.
|
||||
*/
|
||||
int cvmx_helper_qos_port_config_update(int xipdport, cvmx_qos_config_t *qos_cfg);
|
||||
|
||||
@ -534,7 +534,7 @@ int cvmx_helper_qos_port_config_update(int xipdport, cvmx_qos_config_t *qos_cfg)
|
||||
*
|
||||
* @param xipdport Global IPD port
|
||||
* @param qos_cfg User QOS configuration parameters.
|
||||
* @return Zero on success, negative number otherwise.
|
||||
* Return: Zero on success, negative number otherwise.
|
||||
*/
|
||||
int cvmx_helper_qos_port_setup(int xipdport, cvmx_qos_config_t *qos_cfg);
|
||||
|
||||
@ -545,7 +545,7 @@ int cvmx_helper_qos_port_setup(int xipdport, cvmx_qos_config_t *qos_cfg);
|
||||
*
|
||||
* @param node OCTEON3 node number.
|
||||
* @param qos_cfg User QOS configuration parameters.
|
||||
* @return Zero on success, negative number otherwise.
|
||||
* Return: Zero on success, negative number otherwise.
|
||||
*/
|
||||
int cvmx_helper_qos_sso_setup(int node, cvmx_qos_config_t *qos_cfg);
|
||||
|
||||
@ -554,7 +554,7 @@ int cvmx_helper_qos_sso_setup(int node, cvmx_qos_config_t *qos_cfg);
|
||||
* @param chan Channel index.
|
||||
* @param namebuf Name buffer (output).
|
||||
* @param buflen Name maximum length.
|
||||
* @return Length of name (in bytes) on success, negative number otherwise.
|
||||
* Return: Length of name (in bytes) on success, negative number otherwise.
|
||||
*/
|
||||
int cvmx_helper_get_chan_e_name(int chan, char *namebuf, int buflen);
|
||||
|
||||
|
||||
@ -111,7 +111,7 @@ typedef union {
|
||||
* - Step by 2 for 16 bit access.
|
||||
* - Step by 4 for 32 bit access.
|
||||
* - Step by 8 for 64 bit access.
|
||||
* @return Address to store for atomic update
|
||||
* Return: Address to store for atomic update
|
||||
*/
|
||||
static inline u64 __cvmx_hwfau_store_address(u64 noadd, u64 reg)
|
||||
{
|
||||
@ -135,7 +135,7 @@ static inline u64 __cvmx_hwfau_store_address(u64 noadd, u64 reg)
|
||||
* @param value Signed value to add.
|
||||
* Note: When performing 32 and 64 bit access, only the low
|
||||
* 22 bits are available.
|
||||
* @return Address to read from for atomic update
|
||||
* Return: Address to read from for atomic update
|
||||
*/
|
||||
static inline u64 __cvmx_hwfau_atomic_address(u64 tagwait, u64 reg, s64 value)
|
||||
{
|
||||
@ -152,7 +152,7 @@ static inline u64 __cvmx_hwfau_atomic_address(u64 tagwait, u64 reg, s64 value)
|
||||
* - Step by 8 for 64 bit access.
|
||||
* @param value Signed value to add.
|
||||
* Note: Only the low 22 bits are available.
|
||||
* @return Value of the register before the update
|
||||
* Return: Value of the register before the update
|
||||
*/
|
||||
static inline s64 cvmx_hwfau_fetch_and_add64(cvmx_fau_reg64_t reg, s64 value)
|
||||
{
|
||||
@ -166,7 +166,7 @@ static inline s64 cvmx_hwfau_fetch_and_add64(cvmx_fau_reg64_t reg, s64 value)
|
||||
* - Step by 4 for 32 bit access.
|
||||
* @param value Signed value to add.
|
||||
* Note: Only the low 22 bits are available.
|
||||
* @return Value of the register before the update
|
||||
* Return: Value of the register before the update
|
||||
*/
|
||||
static inline s32 cvmx_hwfau_fetch_and_add32(cvmx_fau_reg32_t reg, s32 value)
|
||||
{
|
||||
@ -180,7 +180,7 @@ static inline s32 cvmx_hwfau_fetch_and_add32(cvmx_fau_reg32_t reg, s32 value)
|
||||
* @param reg FAU atomic register to access. 0 <= reg < 2048.
|
||||
* - Step by 2 for 16 bit access.
|
||||
* @param value Signed value to add.
|
||||
* @return Value of the register before the update
|
||||
* Return: Value of the register before the update
|
||||
*/
|
||||
static inline s16 cvmx_hwfau_fetch_and_add16(cvmx_fau_reg16_t reg, s16 value)
|
||||
{
|
||||
@ -193,7 +193,7 @@ static inline s16 cvmx_hwfau_fetch_and_add16(cvmx_fau_reg16_t reg, s16 value)
|
||||
*
|
||||
* @param reg FAU atomic register to access. 0 <= reg < 2048.
|
||||
* @param value Signed value to add.
|
||||
* @return Value of the register before the update
|
||||
* Return: Value of the register before the update
|
||||
*/
|
||||
static inline int8_t cvmx_hwfau_fetch_and_add8(cvmx_fau_reg8_t reg, int8_t value)
|
||||
{
|
||||
@ -209,7 +209,7 @@ static inline int8_t cvmx_hwfau_fetch_and_add8(cvmx_fau_reg8_t reg, int8_t value
|
||||
* - Step by 8 for 64 bit access.
|
||||
* @param value Signed value to add.
|
||||
* Note: Only the low 22 bits are available.
|
||||
* @return If a timeout occurs, the error bit will be set. Otherwise
|
||||
* Return: If a timeout occurs, the error bit will be set. Otherwise
|
||||
* the value of the register before the update will be
|
||||
* returned
|
||||
*/
|
||||
@ -232,7 +232,7 @@ static inline cvmx_fau_tagwait64_t cvmx_hwfau_tagwait_fetch_and_add64(cvmx_fau_r
|
||||
* - Step by 4 for 32 bit access.
|
||||
* @param value Signed value to add.
|
||||
* Note: Only the low 22 bits are available.
|
||||
* @return If a timeout occurs, the error bit will be set. Otherwise
|
||||
* Return: If a timeout occurs, the error bit will be set. Otherwise
|
||||
* the value of the register before the update will be
|
||||
* returned
|
||||
*/
|
||||
@ -255,7 +255,7 @@ static inline cvmx_fau_tagwait32_t cvmx_hwfau_tagwait_fetch_and_add32(cvmx_fau_r
|
||||
* @param reg FAU atomic register to access. 0 <= reg < 2048.
|
||||
* - Step by 2 for 16 bit access.
|
||||
* @param value Signed value to add.
|
||||
* @return If a timeout occurs, the error bit will be set. Otherwise
|
||||
* Return: If a timeout occurs, the error bit will be set. Otherwise
|
||||
* the value of the register before the update will be
|
||||
* returned
|
||||
*/
|
||||
@ -277,7 +277,7 @@ static inline cvmx_fau_tagwait16_t cvmx_hwfau_tagwait_fetch_and_add16(cvmx_fau_r
|
||||
*
|
||||
* @param reg FAU atomic register to access. 0 <= reg < 2048.
|
||||
* @param value Signed value to add.
|
||||
* @return If a timeout occurs, the error bit will be set. Otherwise
|
||||
* Return: If a timeout occurs, the error bit will be set. Otherwise
|
||||
* the value of the register before the update will be
|
||||
* returned
|
||||
*/
|
||||
@ -314,7 +314,7 @@ static inline cvmx_fau_tagwait8_t cvmx_hwfau_tagwait_fetch_and_add8(cvmx_fau_reg
|
||||
* - Step by 2 for 16 bit access.
|
||||
* - Step by 4 for 32 bit access.
|
||||
* - Step by 8 for 64 bit access.
|
||||
* @return Data to write using cvmx_send_single
|
||||
* Return: Data to write using cvmx_send_single
|
||||
*/
|
||||
static inline u64 __cvmx_fau_iobdma_data(u64 scraddr, s64 value, u64 tagwait,
|
||||
cvmx_fau_op_size_t size, u64 reg)
|
||||
@ -337,7 +337,7 @@ static inline u64 __cvmx_fau_iobdma_data(u64 scraddr, s64 value, u64 tagwait,
|
||||
* - Step by 8 for 64 bit access.
|
||||
* @param value Signed value to add.
|
||||
* Note: Only the low 22 bits are available.
|
||||
* @return Placed in the scratch pad register
|
||||
* Return: Placed in the scratch pad register
|
||||
*/
|
||||
static inline void cvmx_hwfau_async_fetch_and_add64(u64 scraddr, cvmx_fau_reg64_t reg, s64 value)
|
||||
{
|
||||
@ -354,7 +354,7 @@ static inline void cvmx_hwfau_async_fetch_and_add64(u64 scraddr, cvmx_fau_reg64_
|
||||
* - Step by 4 for 32 bit access.
|
||||
* @param value Signed value to add.
|
||||
* Note: Only the low 22 bits are available.
|
||||
* @return Placed in the scratch pad register
|
||||
* Return: Placed in the scratch pad register
|
||||
*/
|
||||
static inline void cvmx_hwfau_async_fetch_and_add32(u64 scraddr, cvmx_fau_reg32_t reg, s32 value)
|
||||
{
|
||||
@ -370,7 +370,7 @@ static inline void cvmx_hwfau_async_fetch_and_add32(u64 scraddr, cvmx_fau_reg32_
|
||||
* @param reg FAU atomic register to access. 0 <= reg < 2048.
|
||||
* - Step by 2 for 16 bit access.
|
||||
* @param value Signed value to add.
|
||||
* @return Placed in the scratch pad register
|
||||
* Return: Placed in the scratch pad register
|
||||
*/
|
||||
static inline void cvmx_hwfau_async_fetch_and_add16(u64 scraddr, cvmx_fau_reg16_t reg, s16 value)
|
||||
{
|
||||
@ -385,7 +385,7 @@ static inline void cvmx_hwfau_async_fetch_and_add16(u64 scraddr, cvmx_fau_reg16_
|
||||
* Must be 8 byte aligned.
|
||||
* @param reg FAU atomic register to access. 0 <= reg < 2048.
|
||||
* @param value Signed value to add.
|
||||
* @return Placed in the scratch pad register
|
||||
* Return: Placed in the scratch pad register
|
||||
*/
|
||||
static inline void cvmx_hwfau_async_fetch_and_add8(u64 scraddr, cvmx_fau_reg8_t reg, int8_t value)
|
||||
{
|
||||
@ -405,7 +405,7 @@ static inline void cvmx_hwfau_async_fetch_and_add8(u64 scraddr, cvmx_fau_reg8_t
|
||||
* - Step by 8 for 64 bit access.
|
||||
* @param value Signed value to add.
|
||||
* Note: Only the low 22 bits are available.
|
||||
* @return Placed in the scratch pad register
|
||||
* Return: Placed in the scratch pad register
|
||||
*/
|
||||
static inline void cvmx_hwfau_async_tagwait_fetch_and_add64(u64 scraddr, cvmx_fau_reg64_t reg,
|
||||
s64 value)
|
||||
@ -426,7 +426,7 @@ static inline void cvmx_hwfau_async_tagwait_fetch_and_add64(u64 scraddr, cvmx_fa
|
||||
* - Step by 4 for 32 bit access.
|
||||
* @param value Signed value to add.
|
||||
* Note: Only the low 22 bits are available.
|
||||
* @return Placed in the scratch pad register
|
||||
* Return: Placed in the scratch pad register
|
||||
*/
|
||||
static inline void cvmx_hwfau_async_tagwait_fetch_and_add32(u64 scraddr, cvmx_fau_reg32_t reg,
|
||||
s32 value)
|
||||
@ -446,7 +446,7 @@ static inline void cvmx_hwfau_async_tagwait_fetch_and_add32(u64 scraddr, cvmx_fa
|
||||
* @param reg FAU atomic register to access. 0 <= reg < 2048.
|
||||
* - Step by 2 for 16 bit access.
|
||||
* @param value Signed value to add.
|
||||
* @return Placed in the scratch pad register
|
||||
* Return: Placed in the scratch pad register
|
||||
*/
|
||||
static inline void cvmx_hwfau_async_tagwait_fetch_and_add16(u64 scraddr, cvmx_fau_reg16_t reg,
|
||||
s16 value)
|
||||
@ -465,7 +465,7 @@ static inline void cvmx_hwfau_async_tagwait_fetch_and_add16(u64 scraddr, cvmx_fa
|
||||
* returned
|
||||
* @param reg FAU atomic register to access. 0 <= reg < 2048.
|
||||
* @param value Signed value to add.
|
||||
* @return Placed in the scratch pad register
|
||||
* Return: Placed in the scratch pad register
|
||||
*/
|
||||
static inline void cvmx_hwfau_async_tagwait_fetch_and_add8(u64 scraddr, cvmx_fau_reg8_t reg,
|
||||
int8_t value)
|
||||
@ -574,28 +574,28 @@ static inline void cvmx_hwfau_atomic_write8(cvmx_fau_reg8_t reg, int8_t value)
|
||||
}
|
||||
|
||||
/** Allocates 64bit FAU register.
|
||||
* @return value is the base address of allocated FAU register
|
||||
* Return: value is the base address of allocated FAU register
|
||||
*/
|
||||
int cvmx_fau64_alloc(int reserve);
|
||||
|
||||
/** Allocates 32bit FAU register.
|
||||
* @return value is the base address of allocated FAU register
|
||||
* Return: value is the base address of allocated FAU register
|
||||
*/
|
||||
int cvmx_fau32_alloc(int reserve);
|
||||
|
||||
/** Allocates 16bit FAU register.
|
||||
* @return value is the base address of allocated FAU register
|
||||
* Return: value is the base address of allocated FAU register
|
||||
*/
|
||||
int cvmx_fau16_alloc(int reserve);
|
||||
|
||||
/** Allocates 8bit FAU register.
|
||||
* @return value is the base address of allocated FAU register
|
||||
* Return: value is the base address of allocated FAU register
|
||||
*/
|
||||
int cvmx_fau8_alloc(int reserve);
|
||||
|
||||
/** Frees the specified FAU register.
|
||||
* @param address Base address of register to release.
|
||||
* @return 0 on success; -1 on failure
|
||||
* Return: 0 on success; -1 on failure
|
||||
*/
|
||||
int cvmx_fau_free(int address);
|
||||
|
||||
|
||||
@ -270,7 +270,7 @@ static inline void cvmx_pko_send_packet_prepare(u64 port __attribute__((unused))
|
||||
* @param use_locking
|
||||
* CVMX_PKO_LOCK_NONE, CVMX_PKO_LOCK_ATOMIC_TAG, or CVMX_PKO_LOCK_CMD_QUEUE
|
||||
*
|
||||
* @return returns CVMX_PKO_SUCCESS on success, or error code on failure of output
|
||||
* Return: returns CVMX_PKO_SUCCESS on success, or error code on failure of output
|
||||
*/
|
||||
static inline cvmx_pko_return_value_t
|
||||
cvmx_hwpko_send_packet_finish(u64 ipd_port, u64 queue, cvmx_pko_command_word0_t pko_command,
|
||||
@ -313,7 +313,7 @@ cvmx_hwpko_send_packet_finish(u64 ipd_port, u64 queue, cvmx_pko_command_word0_t
|
||||
* @param use_locking
|
||||
* CVMX_PKO_LOCK_NONE, CVMX_PKO_LOCK_ATOMIC_TAG, or CVMX_PKO_LOCK_CMD_QUEUE
|
||||
*
|
||||
* @return returns CVMX_PKO_SUCCESS on success, or error code on failure of output
|
||||
* Return: returns CVMX_PKO_SUCCESS on success, or error code on failure of output
|
||||
*/
|
||||
static inline cvmx_pko_return_value_t
|
||||
cvmx_hwpko_send_packet_finish3(u64 ipd_port, u64 queue, cvmx_pko_command_word0_t pko_command,
|
||||
@ -358,7 +358,7 @@ int cvmx_pko_get_num_pko_ports(int interface, int index);
|
||||
* for the port.
|
||||
*
|
||||
* @param port IPD port number
|
||||
* @return Base output queue
|
||||
* Return: Base output queue
|
||||
*/
|
||||
int cvmx_pko_get_base_queue(int port);
|
||||
|
||||
@ -366,7 +366,7 @@ int cvmx_pko_get_base_queue(int port);
|
||||
* For a given port number, return the number of pko output queues.
|
||||
*
|
||||
* @param port IPD port number
|
||||
* @return Number of output queues
|
||||
* Return: Number of output queues
|
||||
*/
|
||||
int cvmx_pko_get_num_queues(int port);
|
||||
|
||||
@ -407,7 +407,7 @@ void cvmx_pko_get_port_status(u64 ipd_port, u64 clear, cvmx_pko_port_status_t *s
|
||||
* @param burst Maximum number of packets to burst in a row before rate
|
||||
* limiting cuts in.
|
||||
*
|
||||
* @return Zero on success, negative on failure
|
||||
* Return: Zero on success, negative on failure
|
||||
*/
|
||||
int cvmx_pko_rate_limit_packets(int port, int packets_s, int burst);
|
||||
|
||||
@ -420,7 +420,7 @@ int cvmx_pko_rate_limit_packets(int port, int packets_s, int burst);
|
||||
* @param burst Maximum number of bits to burst before rate
|
||||
* limiting cuts in.
|
||||
*
|
||||
* @return Zero on success, negative on failure
|
||||
* Return: Zero on success, negative on failure
|
||||
*/
|
||||
int cvmx_pko_rate_limit_bits(int port, u64 bits_s, int burst);
|
||||
|
||||
@ -432,7 +432,7 @@ int cvmx_pko_rate_limit_bits(int port, u64 bits_s, int burst);
|
||||
* @param interface
|
||||
* @param index
|
||||
*
|
||||
* @return negative on error.
|
||||
* Return: negative on error.
|
||||
*
|
||||
* This applies only to the non-loopback interfaces.
|
||||
*
|
||||
@ -444,7 +444,7 @@ int __cvmx_pko_get_pipe(int interface, int index);
|
||||
* for the port.
|
||||
*
|
||||
* @param pko_port PKO port number
|
||||
* @return Base output queue
|
||||
* Return: Base output queue
|
||||
*/
|
||||
int cvmx_pko_get_base_queue_pkoid(int pko_port);
|
||||
|
||||
@ -453,7 +453,7 @@ int cvmx_pko_get_base_queue_pkoid(int pko_port);
|
||||
* for the port.
|
||||
*
|
||||
* @param pko_port PKO port number
|
||||
* @return the number of output queues
|
||||
* Return: the number of output queues
|
||||
*/
|
||||
int cvmx_pko_get_num_queues_pkoid(int pko_port);
|
||||
|
||||
@ -495,7 +495,7 @@ static inline void cvmx_pko_doorbell_pkoid(u64 pko_port, u64 queue, u64 len)
|
||||
* @param use_locking
|
||||
* CVMX_PKO_LOCK_NONE, CVMX_PKO_LOCK_ATOMIC_TAG, or CVMX_PKO_LOCK_CMD_QUEUE
|
||||
*
|
||||
* @return returns CVMX_PKO_SUCCESS on success, or error code on failure of output
|
||||
* Return: returns CVMX_PKO_SUCCESS on success, or error code on failure of output
|
||||
*/
|
||||
static inline cvmx_pko_return_value_t
|
||||
cvmx_hwpko_send_packet_finish_pkoid(int pko_port, u64 queue, cvmx_pko_command_word0_t pko_command,
|
||||
@ -533,7 +533,7 @@ cvmx_hwpko_send_packet_finish_pkoid(int pko_port, u64 queue, cvmx_pko_command_wo
|
||||
* @param use_locking
|
||||
* CVMX_PKO_LOCK_NONE, CVMX_PKO_LOCK_ATOMIC_TAG, or CVMX_PKO_LOCK_CMD_QUEUE
|
||||
*
|
||||
* @return returns CVMX_PKO_SUCCESS on success, or error code on failure of output
|
||||
* Return: returns CVMX_PKO_SUCCESS on success, or error code on failure of output
|
||||
*/
|
||||
static inline cvmx_pko_return_value_t
|
||||
cvmx_hwpko_send_packet_finish3_pkoid(u64 pko_port, u64 queue, cvmx_pko_command_word0_t pko_command,
|
||||
@ -561,7 +561,7 @@ cvmx_hwpko_send_packet_finish3_pkoid(u64 pko_port, u64 queue, cvmx_pko_command_w
|
||||
* Obtain the number of PKO commands pending in a queue
|
||||
*
|
||||
* @param queue is the queue identifier to be queried
|
||||
* @return the number of commands pending transmission or -1 on error
|
||||
* Return: the number of commands pending transmission or -1 on error
|
||||
*/
|
||||
int cvmx_pko_queue_pend_count(cvmx_cmd_queue_id_t queue);
|
||||
|
||||
|
||||
@ -213,7 +213,7 @@ void cvmx_ipd_set_wqe_pool_buffer_count(u64 buffer_count);
|
||||
* @param drop_thresh
|
||||
* All incoming packets will be dropped when there are less
|
||||
* than this many free packet buffers in FPA 0.
|
||||
* @return Zero on success. Negative on failure
|
||||
* Return: Zero on success. Negative on failure
|
||||
*/
|
||||
int cvmx_ipd_setup_red_queue(int queue, int pass_thresh, int drop_thresh);
|
||||
|
||||
@ -226,7 +226,7 @@ int cvmx_ipd_setup_red_queue(int queue, int pass_thresh, int drop_thresh);
|
||||
* @param drop_thresh
|
||||
* All incoming packets will be dropped when there are less
|
||||
* than this many free packet buffers in FPA 0.
|
||||
* @return Zero on success. Negative on failure
|
||||
* Return: Zero on success. Negative on failure
|
||||
*/
|
||||
int cvmx_ipd_setup_red(int pass_thresh, int drop_thresh);
|
||||
|
||||
|
||||
@ -74,7 +74,7 @@ typedef union {
|
||||
*
|
||||
* @param pcie_port PCIe port the IO is for
|
||||
*
|
||||
* @return 64bit Octeon IO base address for read/write
|
||||
* Return: 64bit Octeon IO base address for read/write
|
||||
*/
|
||||
u64 cvmx_pcie_get_io_base_address(int pcie_port);
|
||||
|
||||
@ -84,7 +84,7 @@ u64 cvmx_pcie_get_io_base_address(int pcie_port);
|
||||
*
|
||||
* @param pcie_port PCIe port the IO is for
|
||||
*
|
||||
* @return Size of the IO window
|
||||
* Return: Size of the IO window
|
||||
*/
|
||||
u64 cvmx_pcie_get_io_size(int pcie_port);
|
||||
|
||||
@ -94,7 +94,7 @@ u64 cvmx_pcie_get_io_size(int pcie_port);
|
||||
*
|
||||
* @param pcie_port PCIe port the IO is for
|
||||
*
|
||||
* @return 64bit Octeon IO base address for read/write
|
||||
* Return: 64bit Octeon IO base address for read/write
|
||||
*/
|
||||
u64 cvmx_pcie_get_mem_base_address(int pcie_port);
|
||||
|
||||
@ -104,7 +104,7 @@ u64 cvmx_pcie_get_mem_base_address(int pcie_port);
|
||||
*
|
||||
* @param pcie_port PCIe port the IO is for
|
||||
*
|
||||
* @return Size of the Mem window
|
||||
* Return: Size of the Mem window
|
||||
*/
|
||||
u64 cvmx_pcie_get_mem_size(int pcie_port);
|
||||
|
||||
@ -113,7 +113,7 @@ u64 cvmx_pcie_get_mem_size(int pcie_port);
|
||||
*
|
||||
* @param pcie_port PCIe port to initialize
|
||||
*
|
||||
* @return Zero on success
|
||||
* Return: Zero on success
|
||||
*/
|
||||
int cvmx_pcie_rc_initialize(int pcie_port);
|
||||
|
||||
@ -122,7 +122,7 @@ int cvmx_pcie_rc_initialize(int pcie_port);
|
||||
*
|
||||
* @param pcie_port PCIe port to shutdown
|
||||
*
|
||||
* @return Zero on success
|
||||
* Return: Zero on success
|
||||
*/
|
||||
int cvmx_pcie_rc_shutdown(int pcie_port);
|
||||
|
||||
@ -135,7 +135,7 @@ int cvmx_pcie_rc_shutdown(int pcie_port);
|
||||
* @param fn Device sub function
|
||||
* @param reg Register to access
|
||||
*
|
||||
* @return Result of the read
|
||||
* Return: Result of the read
|
||||
*/
|
||||
u8 cvmx_pcie_config_read8(int pcie_port, int bus, int dev, int fn, int reg);
|
||||
|
||||
@ -148,7 +148,7 @@ u8 cvmx_pcie_config_read8(int pcie_port, int bus, int dev, int fn, int reg);
|
||||
* @param fn Device sub function
|
||||
* @param reg Register to access
|
||||
*
|
||||
* @return Result of the read
|
||||
* Return: Result of the read
|
||||
*/
|
||||
u16 cvmx_pcie_config_read16(int pcie_port, int bus, int dev, int fn, int reg);
|
||||
|
||||
@ -161,7 +161,7 @@ u16 cvmx_pcie_config_read16(int pcie_port, int bus, int dev, int fn, int reg);
|
||||
* @param fn Device sub function
|
||||
* @param reg Register to access
|
||||
*
|
||||
* @return Result of the read
|
||||
* Return: Result of the read
|
||||
*/
|
||||
u32 cvmx_pcie_config_read32(int pcie_port, int bus, int dev, int fn, int reg);
|
||||
|
||||
@ -208,7 +208,7 @@ void cvmx_pcie_config_write32(int pcie_port, int bus, int dev, int fn, int reg,
|
||||
* @param pcie_port PCIe port to read from
|
||||
* @param cfg_offset Address to read
|
||||
*
|
||||
* @return Value read
|
||||
* Return: Value read
|
||||
*/
|
||||
u32 cvmx_pcie_cfgx_read(int pcie_port, u32 cfg_offset);
|
||||
u32 cvmx_pcie_cfgx_read_node(int node, int pcie_port, u32 cfg_offset);
|
||||
@ -240,7 +240,7 @@ static inline void cvmx_pcie_npei_write32(u64 address, u32 val)
|
||||
* Read a 32bit value from the Octeon NPEI register space
|
||||
*
|
||||
* @param address Address to read
|
||||
* @return The result
|
||||
* Return: The result
|
||||
*/
|
||||
static inline u32 cvmx_pcie_npei_read32(u64 address)
|
||||
{
|
||||
@ -252,7 +252,7 @@ static inline u32 cvmx_pcie_npei_read32(u64 address)
|
||||
*
|
||||
* @param pcie_port PCIe port to initialize
|
||||
*
|
||||
* @return Zero on success
|
||||
* Return: Zero on success
|
||||
*/
|
||||
int cvmx_pcie_ep_initialize(int pcie_port);
|
||||
|
||||
@ -272,7 +272,7 @@ void cvmx_pcie_wait_for_pending(int pcie_port);
|
||||
*
|
||||
* @param pcie_port PCIe port number (PEM number)
|
||||
*
|
||||
* @return 0 if PCIe port is in target mode, !0 if in host mode.
|
||||
* Return: 0 if PCIe port is in target mode, !0 if in host mode.
|
||||
*/
|
||||
int cvmx_pcie_is_host_mode(int pcie_port);
|
||||
|
||||
|
||||
@ -946,7 +946,7 @@ static inline void cvmx_pip_bsel_config(int bit, int offset, int skip)
|
||||
/**
|
||||
* Get the entry for the Bit Select Extractor Table.
|
||||
* @param work pointer to work queue entry
|
||||
* @return Index of the Bit Select Extractor Table
|
||||
* Return: Index of the Bit Select Extractor Table
|
||||
*/
|
||||
static inline int cvmx_pip_get_bsel_table_index(cvmx_wqe_t *work)
|
||||
{
|
||||
|
||||
@ -14,7 +14,7 @@
|
||||
* @param style style to allocate, if -1 it will be allocated
|
||||
first available style from style resource. If index is positive
|
||||
number and in range, it will try to allocate specified style.
|
||||
* @return style number on success, -1 on failure.
|
||||
* Return: style number on success, -1 on failure.
|
||||
*/
|
||||
int cvmx_pki_style_alloc(int node, int style);
|
||||
|
||||
@ -24,7 +24,7 @@ int cvmx_pki_style_alloc(int node, int style);
|
||||
* @param node node to allocate cluster group from.
|
||||
@param cl_grp cluster group to allocate/reserve, if -1 ,
|
||||
allocate any available cluster group.
|
||||
* @return cluster group number or -1 on failure
|
||||
* Return: cluster group number or -1 on failure
|
||||
*/
|
||||
int cvmx_pki_cluster_grp_alloc(int node, int cl_grp);
|
||||
|
||||
@ -45,7 +45,7 @@ int cvmx_pki_cluster_alloc(int node, int num_clusters, u64 *cluster_mask);
|
||||
allocate any available pcam entry.
|
||||
* @param bank pcam bank where to allocate/reserve pcan entry from
|
||||
* @param cluster_mask mask of clusters from which pcam entry is needed.
|
||||
* @return pcam entry of -1 on failure
|
||||
* Return: pcam entry of -1 on failure
|
||||
*/
|
||||
int cvmx_pki_pcam_entry_alloc(int node, int index, int bank, u64 cluster_mask);
|
||||
|
||||
@ -57,7 +57,7 @@ int cvmx_pki_pcam_entry_alloc(int node, int index, int bank, u64 cluster_mask);
|
||||
number and in range, it will try to allocate specified base_offset.
|
||||
@param count number of consecutive qpg entries to allocate. They will be consecutive
|
||||
from base offset.
|
||||
* @return qpg table base offset number on success, -1 on failure.
|
||||
* Return: qpg table base offset number on success, -1 on failure.
|
||||
*/
|
||||
int cvmx_pki_qpg_entry_alloc(int node, int base_offset, int count);
|
||||
|
||||
@ -65,7 +65,7 @@ int cvmx_pki_qpg_entry_alloc(int node, int base_offset, int count);
|
||||
* This function frees a style from pool of global styles per node.
|
||||
* @param node node to free style from.
|
||||
* @param style style to free
|
||||
* @return 0 on success, -1 on failure.
|
||||
* Return: 0 on success, -1 on failure.
|
||||
*/
|
||||
int cvmx_pki_style_free(int node, int style);
|
||||
|
||||
@ -74,7 +74,7 @@ int cvmx_pki_style_free(int node, int style);
|
||||
cluster group resources.
|
||||
* @param node node to free cluster group from.
|
||||
@param cl_grp cluster group to free
|
||||
* @return 0 on success or -1 on failure
|
||||
* Return: 0 on success or -1 on failure
|
||||
*/
|
||||
int cvmx_pki_cluster_grp_free(int node, int cl_grp);
|
||||
|
||||
@ -86,7 +86,7 @@ int cvmx_pki_cluster_grp_free(int node, int cl_grp);
|
||||
* number and in range, it will try to allocate specified base_offset.
|
||||
* @param count number of consecutive qpg entries to allocate. They will be consecutive
|
||||
* from base offset.
|
||||
* @return qpg table base offset number on success, -1 on failure.
|
||||
* Return: qpg table base offset number on success, -1 on failure.
|
||||
*/
|
||||
int cvmx_pki_qpg_entry_free(int node, int base_offset, int count);
|
||||
|
||||
@ -95,7 +95,7 @@ int cvmx_pki_qpg_entry_free(int node, int base_offset, int count);
|
||||
clusters resources.
|
||||
* @param node node to free clusters from.
|
||||
* @param cluster_mask mask of clusters need freeing
|
||||
* @return 0 on success or -1 on failure
|
||||
* Return: 0 on success or -1 on failure
|
||||
*/
|
||||
int cvmx_pki_cluster_free(int node, u64 cluster_mask);
|
||||
|
||||
@ -105,7 +105,7 @@ int cvmx_pki_cluster_free(int node, u64 cluster_mask);
|
||||
@param index index of pacm entry (0-191) needs to be freed.
|
||||
* @param bank pcam bank where to free pcam entry from
|
||||
* @param cluster_mask mask of clusters from which pcam entry is freed.
|
||||
* @return 0 on success OR -1 on failure
|
||||
* Return: 0 on success OR -1 on failure
|
||||
*/
|
||||
int cvmx_pki_pcam_entry_free(int node, int index, int bank, u64 cluster_mask);
|
||||
|
||||
@ -115,7 +115,7 @@ int cvmx_pki_pcam_entry_free(int node, int index, int bank, u64 cluster_mask);
|
||||
* @param bpid bpid to allocate, if -1 it will be allocated
|
||||
* first available boid from bpid resource. If index is positive
|
||||
* number and in range, it will try to allocate specified bpid.
|
||||
* @return bpid number on success,
|
||||
* Return: bpid number on success,
|
||||
* -1 on alloc failure.
|
||||
* -2 on resource already reserved.
|
||||
*/
|
||||
@ -125,7 +125,7 @@ int cvmx_pki_bpid_alloc(int node, int bpid);
|
||||
* This function frees a bpid from pool of global bpid per node.
|
||||
* @param node node to free bpid from.
|
||||
* @param bpid bpid to free
|
||||
* @return 0 on success, -1 on failure or
|
||||
* Return: 0 on success, -1 on failure or
|
||||
*/
|
||||
int cvmx_pki_bpid_free(int node, int bpid);
|
||||
|
||||
@ -138,7 +138,7 @@ int cvmx_pki_bpid_free(int node, int bpid);
|
||||
* This function allocates/reserves an index from pool of global MTAG-IDX per node.
|
||||
* @param node node to allocate index from.
|
||||
* @param idx index to allocate, if -1 it will be allocated
|
||||
* @return MTAG index number on success,
|
||||
* Return: MTAG index number on success,
|
||||
* -1 on alloc failure.
|
||||
* -2 on resource already reserved.
|
||||
*/
|
||||
@ -148,7 +148,7 @@ int cvmx_pki_mtag_idx_alloc(int node, int idx);
|
||||
* This function frees an index from pool of global MTAG-IDX per node.
|
||||
* @param node node to free bpid from.
|
||||
* @param bpid bpid to free
|
||||
* @return 0 on success, -1 on failure or
|
||||
* Return: 0 on success, -1 on failure or
|
||||
*/
|
||||
int cvmx_pki_mtag_idx_free(int node, int idx);
|
||||
|
||||
|
||||
@ -14,7 +14,7 @@
|
||||
* are requested.
|
||||
* @param count the number of internal ports requested
|
||||
*
|
||||
* @return 0 on success
|
||||
* Return: 0 on success
|
||||
* -1 on failure
|
||||
*/
|
||||
int cvmx_pko_internal_ports_alloc(int interface, int port, u64 count);
|
||||
@ -26,7 +26,7 @@ int cvmx_pko_internal_ports_alloc(int interface, int port, u64 count);
|
||||
* @param port the index of the port within in the interface for which the internal ports
|
||||
* are requested.
|
||||
*
|
||||
* @return 0 on success
|
||||
* Return: 0 on success
|
||||
* -1 on failure
|
||||
*/
|
||||
int cvmx_pko_internal_ports_free(int interface, int port);
|
||||
|
||||
@ -113,7 +113,7 @@ int __cvmx_pko3_ipd_dq_unregister(int xiface, int index);
|
||||
* The channel assignment applies to L2 or L3 Shaper Queues depending
|
||||
* on the setting of channel credit level.
|
||||
*
|
||||
* @return returns none.
|
||||
* Return: returns none.
|
||||
*/
|
||||
void cvmx_pko3_map_channel(unsigned int node, unsigned int pq_num, unsigned int l2_l3_q_num,
|
||||
u16 channel);
|
||||
|
||||
@ -906,7 +906,7 @@ static inline unsigned int cvmx_sso_num_maskset(void)
|
||||
* If a tag switch is pending this routine returns the tag before
|
||||
* the tag switch, not after.
|
||||
*
|
||||
* @return Current tag
|
||||
* Return: Current tag
|
||||
*/
|
||||
static inline cvmx_pow_tag_info_t cvmx_pow_get_current_tag(void)
|
||||
{
|
||||
@ -967,7 +967,7 @@ static inline cvmx_pow_tag_info_t cvmx_pow_get_current_tag(void)
|
||||
* Get the POW WQE for this core. This returns the work queue
|
||||
* entry currently associated with this core.
|
||||
*
|
||||
* @return WQE pointer
|
||||
* Return: WQE pointer
|
||||
*/
|
||||
static inline cvmx_wqe_t *cvmx_pow_get_current_wqp(void)
|
||||
{
|
||||
@ -1059,7 +1059,7 @@ static inline void cvmx_pow_tag_sw_wait(void)
|
||||
* @param wait When set, call stalls until work becomes available, or
|
||||
* times out. If not set, returns immediately.
|
||||
*
|
||||
* @return Returns the WQE pointer from POW. Returns NULL if no work was
|
||||
* Return: Returns the WQE pointer from POW. Returns NULL if no work was
|
||||
* available.
|
||||
*/
|
||||
static inline cvmx_wqe_t *cvmx_pow_work_request_sync_nocheck(cvmx_pow_wait_t wait)
|
||||
@ -1099,7 +1099,7 @@ static inline cvmx_wqe_t *cvmx_pow_work_request_sync_nocheck(cvmx_pow_wait_t wai
|
||||
* @param wait When set, call stalls until work becomes available, or
|
||||
* times out. If not set, returns immediately.
|
||||
*
|
||||
* @return Returns the WQE pointer from POW. Returns NULL if no work was
|
||||
* Return: Returns the WQE pointer from POW. Returns NULL if no work was
|
||||
* available.
|
||||
*/
|
||||
static inline cvmx_wqe_t *cvmx_pow_work_request_sync(cvmx_pow_wait_t wait)
|
||||
@ -1114,7 +1114,7 @@ static inline cvmx_wqe_t *cvmx_pow_work_request_sync(cvmx_pow_wait_t wait)
|
||||
* This function waits for any previous tag switch to complete before
|
||||
* requesting the null_rd.
|
||||
*
|
||||
* @return Returns the POW state of type cvmx_pow_tag_type_t.
|
||||
* Return: Returns the POW state of type cvmx_pow_tag_type_t.
|
||||
*/
|
||||
static inline cvmx_pow_tag_type_t cvmx_pow_work_request_null_rd(void)
|
||||
{
|
||||
@ -1204,7 +1204,7 @@ static inline void cvmx_pow_work_request_async(int scr_addr, cvmx_pow_wait_t wai
|
||||
*
|
||||
* @param scr_addr Scratch memory address to get result from
|
||||
* Byte address, must be 8 byte aligned.
|
||||
* @return Returns the WQE from the scratch register, or NULL if no work was
|
||||
* Return: Returns the WQE from the scratch register, or NULL if no work was
|
||||
* available.
|
||||
*/
|
||||
static inline cvmx_wqe_t *cvmx_pow_work_response_async(int scr_addr)
|
||||
@ -1226,7 +1226,7 @@ static inline cvmx_wqe_t *cvmx_pow_work_response_async(int scr_addr)
|
||||
*
|
||||
* @param wqe_ptr pointer to a work queue entry returned by the POW
|
||||
*
|
||||
* @return 0 if pointer is valid
|
||||
* Return: 0 if pointer is valid
|
||||
* 1 if invalid (no work was returned)
|
||||
*/
|
||||
static inline u64 cvmx_pow_work_invalid(cvmx_wqe_t *wqe_ptr)
|
||||
@ -1735,7 +1735,7 @@ static inline void cvmx_pow_set_group_mask(u64 core_num, u64 mask)
|
||||
* indicates which groups each core will accept work from.
|
||||
*
|
||||
* @param core_num core to apply mask to
|
||||
* @return Group mask, one bit for up to 64 groups.
|
||||
* Return: Group mask, one bit for up to 64 groups.
|
||||
* Each 1 bit in the mask enables the core to accept work from
|
||||
* the corresponding group.
|
||||
* The CN68XX supports 64 groups, earlier models only support
|
||||
@ -2364,7 +2364,7 @@ static inline void cvmx_sso_work_request_grp_async_nocheck(int scr_addr, cvmx_xg
|
||||
* @param wait When set, call stalls until work becomes available, or times out.
|
||||
* If not set, returns immediately.
|
||||
*
|
||||
* @return Returns the WQE pointer from SSO.
|
||||
* Return: Returns the WQE pointer from SSO.
|
||||
* Returns NULL if no work was available.
|
||||
*/
|
||||
static inline void *cvmx_sso_work_request_grp_sync_nocheck(unsigned int lgrp, cvmx_pow_wait_t wait)
|
||||
@ -2403,7 +2403,7 @@ static inline void *cvmx_sso_work_request_grp_sync_nocheck(unsigned int lgrp, cv
|
||||
* @param wait When set, call stalls until work becomes available, or times out.
|
||||
* If not set, returns immediately.
|
||||
*
|
||||
* @return The WQE pointer or NULL, if work is not available.
|
||||
* Return: The WQE pointer or NULL, if work is not available.
|
||||
*/
|
||||
static inline void *cvmx_sso_work_request_grp_sync(unsigned int lgrp, cvmx_pow_wait_t wait)
|
||||
{
|
||||
@ -2829,7 +2829,7 @@ static inline void cvmx_sso_update_wqp_group(cvmx_wqe_t *wqp, u8 xgrp)
|
||||
* @param hw_bits The lower bits (number depends on configuration) are set
|
||||
* to this value. The remainder of bits are set by the sw_bits parameter.
|
||||
*
|
||||
* @return 32 bit value of the combined hw and sw bits.
|
||||
* Return: 32 bit value of the combined hw and sw bits.
|
||||
*/
|
||||
static inline u32 cvmx_pow_tag_compose(u64 sw_bits, u64 hw_bits)
|
||||
{
|
||||
@ -2842,7 +2842,7 @@ static inline u32 cvmx_pow_tag_compose(u64 sw_bits, u64 hw_bits)
|
||||
*
|
||||
* @param tag 32 bit tag value
|
||||
*
|
||||
* @return N bit software tag value, where N is configurable with
|
||||
* Return: N bit software tag value, where N is configurable with
|
||||
* the CVMX_TAG_SW_BITS define
|
||||
*/
|
||||
static inline u32 cvmx_pow_tag_get_sw_bits(u64 tag)
|
||||
@ -2856,7 +2856,7 @@ static inline u32 cvmx_pow_tag_get_sw_bits(u64 tag)
|
||||
*
|
||||
* @param tag 32 bit tag value
|
||||
*
|
||||
* @return (32 - N) bit software tag value, where N is configurable with
|
||||
* Return: (32 - N) bit software tag value, where N is configurable with
|
||||
* the CVMX_TAG_SW_BITS define
|
||||
*/
|
||||
static inline u32 cvmx_pow_tag_get_hw_bits(u64 tag)
|
||||
@ -2905,7 +2905,7 @@ static inline u64 cvmx_sso_get_total_wqe_count(void)
|
||||
* @param buffer Buffer to store capture into
|
||||
* @param buffer_size The size of the supplied buffer
|
||||
*
|
||||
* @return Zero on success, negative on failure
|
||||
* Return: Zero on success, negative on failure
|
||||
*/
|
||||
int cvmx_pow_capture(void *buffer, int buffer_size);
|
||||
|
||||
@ -2920,7 +2920,7 @@ void cvmx_pow_display(void *buffer, int buffer_size);
|
||||
/**
|
||||
* Return the number of POW entries supported by this chip
|
||||
*
|
||||
* @return Number of POW entries
|
||||
* Return: Number of POW entries
|
||||
*/
|
||||
int cvmx_pow_get_num_entries(void);
|
||||
int cvmx_pow_get_dump_size(void);
|
||||
@ -2932,7 +2932,7 @@ int cvmx_pow_get_dump_size(void);
|
||||
* @param node The numa node for the allocation.
|
||||
* @param base_group Pointer to the initial group, -1 to allocate anywhere.
|
||||
* @param count The number of consecutive groups to allocate.
|
||||
* @return 0 on success and -1 on failure.
|
||||
* Return: 0 on success and -1 on failure.
|
||||
*/
|
||||
int cvmx_sso_reserve_group_range(int node, int *base_group, int count);
|
||||
#define cvmx_sso_allocate_group_range cvmx_sso_reserve_group_range
|
||||
|
||||
@ -32,7 +32,7 @@ typedef struct {
|
||||
/**
|
||||
* Return the number of QLMs supported by the chip
|
||||
*
|
||||
* @return Number of QLMs
|
||||
* Return: Number of QLMs
|
||||
*/
|
||||
int cvmx_qlm_get_num(void);
|
||||
|
||||
@ -49,7 +49,7 @@ int cvmx_qlm_interface(int xiface);
|
||||
* @param xiface interface to look up
|
||||
* @param index index in an interface
|
||||
*
|
||||
* @return the qlm number based on the xiface
|
||||
* Return: the qlm number based on the xiface
|
||||
*/
|
||||
int cvmx_qlm_lmac(int xiface, int index);
|
||||
|
||||
@ -58,7 +58,7 @@ int cvmx_qlm_lmac(int xiface, int index);
|
||||
*
|
||||
* @param BGX BGX to search for.
|
||||
*
|
||||
* @return muxes used 0 = DLM5+DLM6, 1 = DLM5, 2 = DLM6.
|
||||
* Return: muxes used 0 = DLM5+DLM6, 1 = DLM5, 2 = DLM6.
|
||||
*/
|
||||
int cvmx_qlm_mux_interface(int bgx);
|
||||
|
||||
@ -67,14 +67,14 @@ int cvmx_qlm_mux_interface(int bgx);
|
||||
*
|
||||
* @param qlm QLM block to query
|
||||
*
|
||||
* @return Number of lanes
|
||||
* Return: Number of lanes
|
||||
*/
|
||||
int cvmx_qlm_get_lanes(int qlm);
|
||||
|
||||
/**
|
||||
* Get the QLM JTAG fields based on Octeon model on the supported chips.
|
||||
*
|
||||
* @return qlm_jtag_field_t structure
|
||||
* Return: qlm_jtag_field_t structure
|
||||
*/
|
||||
const __cvmx_qlm_jtag_field_t *cvmx_qlm_jtag_get_field(void);
|
||||
|
||||
@ -82,7 +82,7 @@ const __cvmx_qlm_jtag_field_t *cvmx_qlm_jtag_get_field(void);
|
||||
* Get the QLM JTAG length by going through qlm_jtag_field for each
|
||||
* Octeon model that is supported
|
||||
*
|
||||
* @return return the length.
|
||||
* Return: return the length.
|
||||
*/
|
||||
int cvmx_qlm_jtag_get_length(void);
|
||||
|
||||
@ -98,7 +98,7 @@ void cvmx_qlm_init(void);
|
||||
* @param lane Lane in QLM to get
|
||||
* @param name String name of field
|
||||
*
|
||||
* @return JTAG field value
|
||||
* Return: JTAG field value
|
||||
*/
|
||||
u64 cvmx_qlm_jtag_get(int qlm, int lane, const char *name);
|
||||
|
||||
@ -133,7 +133,7 @@ void __cvmx_qlm_pcie_cfg_rxd_set_tweak(int qlm, int lane);
|
||||
*
|
||||
* @param qlm QLM to examine
|
||||
*
|
||||
* @return Speed in Mhz
|
||||
* Return: Speed in Mhz
|
||||
*/
|
||||
int cvmx_qlm_get_gbaud_mhz(int qlm);
|
||||
/**
|
||||
@ -142,7 +142,7 @@ int cvmx_qlm_get_gbaud_mhz(int qlm);
|
||||
* @param node Target QLM node
|
||||
* @param qlm QLM to examine
|
||||
*
|
||||
* @return Speed in Mhz
|
||||
* Return: Speed in Mhz
|
||||
*/
|
||||
int cvmx_qlm_get_gbaud_mhz_node(int node, int qlm);
|
||||
|
||||
@ -250,7 +250,7 @@ int cvmx_qlm_measure_clock(int qlm);
|
||||
* @param node node to measure
|
||||
* @param qlm QLM to measure
|
||||
*
|
||||
* @return Clock rate in Hz
|
||||
* Return: Clock rate in Hz
|
||||
*/
|
||||
int cvmx_qlm_measure_clock_node(int node, int qlm);
|
||||
|
||||
@ -261,7 +261,7 @@ int cvmx_qlm_measure_clock_node(int node, int qlm);
|
||||
* @param qlm QLM to perform RX equalization on
|
||||
* @param lane Lane to use, or -1 for all lanes
|
||||
*
|
||||
* @return Zero on success, negative if any lane failed RX equalization
|
||||
* Return: Zero on success, negative if any lane failed RX equalization
|
||||
*/
|
||||
int __cvmx_qlm_rx_equalization(int node, int qlm, int lane);
|
||||
|
||||
|
||||
@ -295,7 +295,7 @@ static inline void cvmx_write_io(u64 io_addr, u64 val)
|
||||
*
|
||||
* @param major_did 5 bit major did
|
||||
* @param sub_did 3 bit sub did
|
||||
* @return I/O base address
|
||||
* Return: I/O base address
|
||||
*/
|
||||
static inline u64 cvmx_build_io_address(u64 major_did, u64 sub_did)
|
||||
{
|
||||
@ -306,7 +306,7 @@ static inline u64 cvmx_build_io_address(u64 major_did, u64 sub_did)
|
||||
* Builds a bit mask given the required size in bits.
|
||||
*
|
||||
* @param bits Number of bits in the mask
|
||||
* @return The mask
|
||||
* Return: The mask
|
||||
*/
|
||||
static inline u64 cvmx_build_mask(u64 bits)
|
||||
{
|
||||
@ -323,7 +323,7 @@ static inline u64 cvmx_build_mask(u64 bits)
|
||||
* @param lsb Starting bit, least significant (0-63)
|
||||
* @param width Width in bits (1-64)
|
||||
*
|
||||
* @return Extracted number
|
||||
* Return: Extracted number
|
||||
*/
|
||||
static inline u64 cvmx_bit_extract(u64 input, int lsb, int width)
|
||||
{
|
||||
@ -349,7 +349,7 @@ static inline u64 cvmx_bit_extract(u64 input, int lsb, int width)
|
||||
* @param high_bit Highest bit value can occupy (inclusive) 0-63
|
||||
* @param low_bit Lowest bit value can occupy inclusive 0-high_bit
|
||||
* @param value Value to use
|
||||
* @return Value masked and shifted
|
||||
* Return: Value masked and shifted
|
||||
*/
|
||||
static inline u64 cvmx_build_bits(u64 high_bit, u64 low_bit, u64 value)
|
||||
{
|
||||
@ -379,7 +379,7 @@ static inline u64 cvmx_ptr_to_phys(void *ptr)
|
||||
/**
|
||||
* Number of the Core on which the program is currently running.
|
||||
*
|
||||
* @return core number
|
||||
* Return: core number
|
||||
*/
|
||||
static inline unsigned int cvmx_get_core_num(void)
|
||||
{
|
||||
@ -392,7 +392,7 @@ static inline unsigned int cvmx_get_core_num(void)
|
||||
/**
|
||||
* Node-local number of the core on which the program is currently running.
|
||||
*
|
||||
* @return core number on local node
|
||||
* Return: core number on local node
|
||||
*/
|
||||
static inline unsigned int cvmx_get_local_core_num(void)
|
||||
{
|
||||
@ -411,7 +411,7 @@ static inline unsigned int cvmx_get_local_core_num(void)
|
||||
*
|
||||
* @param val 32 bit value to count set bits in
|
||||
*
|
||||
* @return Number of bits set
|
||||
* Return: Number of bits set
|
||||
*/
|
||||
static inline u32 cvmx_pop(u32 val)
|
||||
{
|
||||
|
||||
@ -23,7 +23,7 @@
|
||||
*
|
||||
* @param address byte address to read from
|
||||
*
|
||||
* @return value read
|
||||
* Return: value read
|
||||
*/
|
||||
static inline u8 cvmx_scratch_read8(u64 address)
|
||||
{
|
||||
@ -35,7 +35,7 @@ static inline u8 cvmx_scratch_read8(u64 address)
|
||||
*
|
||||
* @param address byte address to read from
|
||||
*
|
||||
* @return value read
|
||||
* Return: value read
|
||||
*/
|
||||
static inline u16 cvmx_scratch_read16(u64 address)
|
||||
{
|
||||
@ -47,7 +47,7 @@ static inline u16 cvmx_scratch_read16(u64 address)
|
||||
*
|
||||
* @param address byte address to read from
|
||||
*
|
||||
* @return value read
|
||||
* Return: value read
|
||||
*/
|
||||
static inline u32 cvmx_scratch_read32(u64 address)
|
||||
{
|
||||
@ -59,7 +59,7 @@ static inline u32 cvmx_scratch_read32(u64 address)
|
||||
*
|
||||
* @param address byte address to read from
|
||||
*
|
||||
* @return value read
|
||||
* Return: value read
|
||||
*/
|
||||
static inline u64 cvmx_scratch_read64(u64 address)
|
||||
{
|
||||
|
||||
@ -763,7 +763,7 @@ static inline void cvmx_wqe_set_len(cvmx_wqe_t *work, int len)
|
||||
*
|
||||
* @param work pointer to work queue entry
|
||||
*
|
||||
* @return 0 if packet had no error, non-zero to indicate error code.
|
||||
* Return: 0 if packet had no error, non-zero to indicate error code.
|
||||
*
|
||||
* Please refer to HRM for the specific model for full enumaration of error codes.
|
||||
* With Octeon1/Octeon2 models, the returned code indicates L1/L2 errors.
|
||||
@ -1042,7 +1042,7 @@ static inline int cvmx_wqe_is_l3_mcast(cvmx_wqe_t *work)
|
||||
* For older chips if PIP_GBL_CTL was proviosned to flag ip4_otions and
|
||||
* ipv6 extension, it will be flag them.
|
||||
* @param work pointer to work queue entry
|
||||
* @return 1 -- If IP error was found in packet
|
||||
* Return: 1 -- If IP error was found in packet
|
||||
* 0 -- If no IP error was found in packet.
|
||||
*/
|
||||
static inline int cvmx_wqe_is_ip_exception(cvmx_wqe_t *work)
|
||||
@ -1221,7 +1221,7 @@ static inline cvmx_buf_ptr_pki_t cvmx_wqe_get_pki_pkt_ptr(cvmx_wqe_t *work)
|
||||
/**
|
||||
* Set the buffer segment count for a packet.
|
||||
*
|
||||
* @return Returns the actual resulting value in the WQE fielda
|
||||
* Return: Returns the actual resulting value in the WQE fielda
|
||||
*
|
||||
*/
|
||||
static inline unsigned int cvmx_wqe_set_bufs(cvmx_wqe_t *work, unsigned int bufs)
|
||||
@ -1239,7 +1239,7 @@ static inline unsigned int cvmx_wqe_set_bufs(cvmx_wqe_t *work, unsigned int bufs
|
||||
* Get the offset of Layer-3 header,
|
||||
* only supported when Layer-3 protocol is IPv4 or IPv6.
|
||||
*
|
||||
* @return Returns the offset, or 0 if the offset is not known or unsupported.
|
||||
* Return: Returns the offset, or 0 if the offset is not known or unsupported.
|
||||
*
|
||||
* FIXME: Assuming word4 is present.
|
||||
*/
|
||||
@ -1263,7 +1263,7 @@ static inline unsigned int cvmx_wqe_get_l3_offset(cvmx_wqe_t *work)
|
||||
* or when the Layer-2 header length is modified, and
|
||||
* a subsequent recalculation of checksums is anticipated.
|
||||
*
|
||||
* @return Returns the actual value of the work entry offset field.
|
||||
* Return: Returns the actual value of the work entry offset field.
|
||||
*
|
||||
* FIXME: Assuming word4 is present.
|
||||
*/
|
||||
|
||||
@ -437,7 +437,7 @@ static inline int octeon_has_feature_OCTEON_FEATURE_PTP(void)
|
||||
/*
|
||||
* Answer ``Is the bit for feature set in the bitmap?''
|
||||
* @param feature
|
||||
* @return 1 when the feature is present and 0 otherwise, -1 in case of error.
|
||||
* Return: 1 when the feature is present and 0 otherwise, -1 in case of error.
|
||||
*/
|
||||
#define octeon_has_feature(feature_x) octeon_has_feature_##feature_x()
|
||||
|
||||
|
||||
@ -307,7 +307,7 @@ const char *octeon_model_get_string_buffer(u32 chip_id, char *buffer);
|
||||
/**
|
||||
* Return the octeon family, i.e., ProcessorID of the PrID register.
|
||||
*
|
||||
* @return the octeon family on success, ((u32)-1) on error.
|
||||
* Return: the octeon family on success, ((u32)-1) on error.
|
||||
*/
|
||||
static inline u32 cvmx_get_octeon_family(void)
|
||||
{
|
||||
|
||||
@ -115,7 +115,7 @@ void octeon_eth_register_phy_port_check(struct eth_device *dev,
|
||||
*
|
||||
* @param dev Ethernet device for phy
|
||||
*
|
||||
* @return 0 to continue, or -1 for error to stop setting up the phy
|
||||
* Return: 0 to continue, or -1 for error to stop setting up the phy
|
||||
*/
|
||||
int octeon_eth_board_post_setup_phy(struct eth_device *dev);
|
||||
|
||||
|
||||
@ -52,7 +52,7 @@ enum octeon_gpio_type {
|
||||
* reg = <0> then the interface will be renamed after this function to
|
||||
* interface@0.
|
||||
*
|
||||
* @return 0 for success.
|
||||
* Return: 0 for success.
|
||||
*/
|
||||
int octeon_fdt_patch_rename(void *fdt, const char *fdt_key, const char *trim_name, bool rename,
|
||||
void (*callback)(void *fdt, int offset, void *arg), void *cbarg);
|
||||
@ -85,7 +85,7 @@ int octeon_fdt_patch_rename(void *fdt, const char *fdt_key, const char *trim_nam
|
||||
* reg = <0> then the interface will be renamed after this function to
|
||||
* interface@0.
|
||||
*
|
||||
* @return 0 for success.
|
||||
* Return: 0 for success.
|
||||
*/
|
||||
int octeon_fdt_patch(void *fdt, const char *fdt_key, const char *trim_name);
|
||||
|
||||
@ -150,7 +150,7 @@ int octeon_fdt_compat_vendor(const void *fdt, int nodeoffset, const char *vendor
|
||||
* @param fdt pointer to flat device tree
|
||||
* @param nodeoffset node offset to get OCX node for
|
||||
*
|
||||
* @return the Octeon OCX node number
|
||||
* Return: the Octeon OCX node number
|
||||
*/
|
||||
int octeon_fdt_get_soc_node(const void *fdt, int nodeoffset);
|
||||
|
||||
@ -161,7 +161,7 @@ int octeon_fdt_get_soc_node(const void *fdt, int nodeoffset);
|
||||
* @param node_offset Node offset in device tree
|
||||
* @param[in] strlist Array of FDT devices to check, end must be NULL
|
||||
*
|
||||
* @return 0 if at least one device is compatible, 1 if not compatible.
|
||||
* Return: 0 if at least one device is compatible, 1 if not compatible.
|
||||
*/
|
||||
int octeon_fdt_node_check_compatible(const void *fdt, int node_offset, const char *const *strlist);
|
||||
/**
|
||||
@ -170,7 +170,7 @@ int octeon_fdt_node_check_compatible(const void *fdt, int node_offset, const cha
|
||||
* @param[in] fdt Pointer to flat device tree
|
||||
* @param node_offset Node offset in device tree
|
||||
*
|
||||
* @return i2c bus number or -1 if error
|
||||
* Return: i2c bus number or -1 if error
|
||||
*/
|
||||
int octeon_fdt_i2c_get_bus(const void *fdt, int node_offset);
|
||||
|
||||
@ -182,7 +182,7 @@ int octeon_fdt_i2c_get_bus(const void *fdt, int node_offset);
|
||||
* @param[out] bus i2c bus number of device
|
||||
* @param[out] addr address of device on i2c bus
|
||||
*
|
||||
* @return 0 for success, -1 on error
|
||||
* Return: 0 for success, -1 on error
|
||||
*/
|
||||
int octeon_fdt_get_i2c_bus_addr(const void *fdt, int node, int *bus, int *addr);
|
||||
|
||||
@ -194,7 +194,7 @@ int octeon_fdt_get_i2c_bus_addr(const void *fdt, int node, int *bus, int *addr);
|
||||
* @param phandle phandle of GPIO node
|
||||
* @param pin pin number to read
|
||||
*
|
||||
* @return 0 = pin is low, 1 = pin is high, -1 = error
|
||||
* Return: 0 = pin is low, 1 = pin is high, -1 = error
|
||||
*/
|
||||
int octeon_fdt_read_gpio(const void *fdt, int phandle, int pin);
|
||||
|
||||
@ -207,7 +207,7 @@ int octeon_fdt_read_gpio(const void *fdt, int phandle, int pin);
|
||||
* @param pin pin number to read
|
||||
* @param val value to write (1 = high, 0 = low)
|
||||
*
|
||||
* @return 0 = success, -1 = error
|
||||
* Return: 0 = success, -1 = error
|
||||
*/
|
||||
int octeon_fdt_set_gpio(const void *fdt, int phandle, int pin, int val);
|
||||
|
||||
@ -221,7 +221,7 @@ int octeon_fdt_set_gpio(const void *fdt, int phandle, int pin, int val);
|
||||
* @param[out] addr i2c address of SFP EEPROM
|
||||
* @param[out] mod_abs Set true if module is absent, false if present
|
||||
*
|
||||
* @return 0 for success, -1 if there are problems with the device tree
|
||||
* Return: 0 for success, -1 if there are problems with the device tree
|
||||
*/
|
||||
int octeon_fdt_get_sfp_eeprom(const void *fdt, int mac_node, int *bus, int *addr, bool *mod_abs);
|
||||
|
||||
@ -235,7 +235,7 @@ int octeon_fdt_get_sfp_eeprom(const void *fdt, int mac_node, int *bus, int *addr
|
||||
* @param[out] addr i2c address of SFP eeprom
|
||||
* @param[out] mod_abs Set true if module is absent, false if present
|
||||
*
|
||||
* @return 0 for success, -1 if there are problems with the device tree
|
||||
* Return: 0 for success, -1 if there are problems with the device tree
|
||||
*/
|
||||
int octeon_fdt_get_qsfp_eeprom(const void *fdt, int mac_node, int *bus, int *addr, bool *mod_abs);
|
||||
|
||||
@ -249,7 +249,7 @@ int octeon_fdt_get_qsfp_eeprom(const void *fdt, int mac_node, int *bus, int *add
|
||||
* @param[out] i2c_bus For i2c GPIO expanders, the i2c bus number
|
||||
* @param[out] i2c_addr For i2c GPIO expanders, the i2c address
|
||||
*
|
||||
* @return 0 for success, -1 for errors
|
||||
* Return: 0 for success, -1 for errors
|
||||
*
|
||||
* NOTE: It is up to the caller to determine the pin number.
|
||||
*/
|
||||
@ -262,7 +262,7 @@ int octeon_fdt_get_gpio_info(int fdt_node, enum octeon_gpio_type *type, int *i2c
|
||||
* @param fdt_node FDT node of phy
|
||||
* @param[out] type Type of GPIO
|
||||
*
|
||||
* @return pointer to phy device or NULL if no match found.
|
||||
* Return: pointer to phy device or NULL if no match found.
|
||||
*/
|
||||
struct phy_device *octeon_fdt_get_phy_gpio_info(int fdt_node, enum octeon_gpio_type *type);
|
||||
#endif /* __OCTEON_FDT_H__ */
|
||||
|
||||
@ -61,7 +61,7 @@ u32 octeon_pci_bus_to_phys(u32 bus);
|
||||
* @param pf - PCIe config space pf num
|
||||
* @param[out] id - override device and vendor ID
|
||||
*
|
||||
* @return 0 if override found, 1 if not found.
|
||||
* Return: 0 if override found, 1 if not found.
|
||||
*/
|
||||
int octeon_find_pcie_id_override(unsigned int address, unsigned int pf, u32 *id);
|
||||
|
||||
|
||||
@ -36,7 +36,7 @@
|
||||
* 1: QLMC_REF_CLK0
|
||||
* 2: QLMC_REF_CLK1
|
||||
*
|
||||
* @return Return 0 on success or -1.
|
||||
* Return: Return 0 on success or -1.
|
||||
*
|
||||
* @note When the 161MHz clock is used it can only be used for
|
||||
* XLAUI mode with a 6316 speed or XFI mode with a 103125 speed.
|
||||
|
||||
@ -121,7 +121,7 @@ static const char * const octeon_gpio_list[] = {
|
||||
* reg = <0> then the interface will be renamed after this function to
|
||||
* interface@0.
|
||||
*
|
||||
* @return 0 for success.
|
||||
* Return: 0 for success.
|
||||
*/
|
||||
int __octeon_fdt_patch(void *fdt, const char *fdt_key, const char *trim_name)
|
||||
{
|
||||
@ -164,7 +164,7 @@ int octeon_fdt_patch(void *fdt, const char *fdt_key, const char *trim_name)
|
||||
* reg = <0> then the interface will be renamed after this function to
|
||||
* interface@0.
|
||||
*
|
||||
* @return 0 for success.
|
||||
* Return: 0 for success.
|
||||
*/
|
||||
int octeon_fdt_patch_rename(void *fdt, const char *fdt_key,
|
||||
const char *trim_name, bool rename,
|
||||
@ -648,7 +648,7 @@ int octeon_fdt_compat_vendor(const void *fdt, int nodeoffset, const char *vendor
|
||||
* @param fdt pointer to flat device tree
|
||||
* @param nodeoffset node offset to get OCX node for
|
||||
*
|
||||
* @return the Octeon OCX node number
|
||||
* Return: the Octeon OCX node number
|
||||
*/
|
||||
int octeon_fdt_get_soc_node(const void *fdt, int nodeoffset)
|
||||
{
|
||||
@ -662,7 +662,7 @@ int octeon_fdt_get_soc_node(const void *fdt, int nodeoffset)
|
||||
* @param node_offset Node offset in device tree
|
||||
* @param[in] strlist Array of FDT devices to check, end must be NULL
|
||||
*
|
||||
* @return 0 if at least one device is compatible, 1 if not compatible.
|
||||
* Return: 0 if at least one device is compatible, 1 if not compatible.
|
||||
*/
|
||||
int octeon_fdt_node_check_compatible(const void *fdt, int node_offset,
|
||||
const char *const *strlist)
|
||||
@ -685,7 +685,7 @@ int octeon_fdt_node_check_compatible(const void *fdt, int node_offset,
|
||||
* @param[in] fdt Pointer to flat device tree
|
||||
* @param node_offset Node offset in device tree
|
||||
*
|
||||
* @return i2c bus number or -1 if error
|
||||
* Return: i2c bus number or -1 if error
|
||||
*/
|
||||
int octeon_fdt_i2c_get_bus(const void *fdt, int node_offset)
|
||||
{
|
||||
@ -742,7 +742,7 @@ int octeon_fdt_i2c_get_bus(const void *fdt, int node_offset)
|
||||
* @param[out] bus i2c bus number of device
|
||||
* @param[out] addr address of device on i2c bus
|
||||
*
|
||||
* @return 0 for success, -1 on error
|
||||
* Return: 0 for success, -1 on error
|
||||
*/
|
||||
int octeon_fdt_get_i2c_bus_addr(const void *fdt, int node, int *bus, int *addr)
|
||||
{
|
||||
@ -765,7 +765,7 @@ int octeon_fdt_get_i2c_bus_addr(const void *fdt, int node, int *bus, int *addr)
|
||||
* @param phandle phandle of GPIO node
|
||||
* @param pin pin number to read
|
||||
*
|
||||
* @return 0 = pin is low, 1 = pin is high, -1 = error
|
||||
* Return: 0 = pin is low, 1 = pin is high, -1 = error
|
||||
*/
|
||||
int octeon_fdt_read_gpio(const void *fdt, int phandle, int pin)
|
||||
{
|
||||
@ -847,7 +847,7 @@ int octeon_fdt_read_gpio(const void *fdt, int phandle, int pin)
|
||||
* @param pin pin number to read
|
||||
* @param val value to write (1 = high, 0 = low)
|
||||
*
|
||||
* @return 0 = success, -1 = error
|
||||
* Return: 0 = success, -1 = error
|
||||
*/
|
||||
int octeon_fdt_set_gpio(const void *fdt, int phandle, int pin, int val)
|
||||
{
|
||||
@ -918,7 +918,7 @@ int octeon_fdt_set_gpio(const void *fdt, int phandle, int pin, int val)
|
||||
* @param[out] i2c_bus For i2c GPIO expanders, the i2c bus number
|
||||
* @param[out] i2c_addr For i2c GPIO expanders, the i2c address
|
||||
*
|
||||
* @return 0 for success, -1 for errors
|
||||
* Return: 0 for success, -1 for errors
|
||||
*
|
||||
* NOTE: It is up to the caller to determine the pin number.
|
||||
*/
|
||||
@ -988,7 +988,7 @@ int octeon_fdt_get_gpio_info(int fdt_node, enum octeon_gpio_type *type,
|
||||
*
|
||||
* @param fdt_node FDT node in device tree
|
||||
*
|
||||
* @return pointer to PHY device or NULL if none found.
|
||||
* Return: pointer to PHY device or NULL if none found.
|
||||
*/
|
||||
static struct phy_device *octeon_fdt_get_phy_device_from_node(int fdt_node)
|
||||
{
|
||||
@ -1014,7 +1014,7 @@ static struct phy_device *octeon_fdt_get_phy_device_from_node(int fdt_node)
|
||||
* @param fdt_node FDT node of phy
|
||||
* @param[out] type Type of GPIO
|
||||
*
|
||||
* @return pointer to phy device or NULL if no match found.
|
||||
* Return: pointer to phy device or NULL if no match found.
|
||||
*/
|
||||
struct phy_device *octeon_fdt_get_phy_gpio_info(int fdt_node, enum octeon_gpio_type *type)
|
||||
{
|
||||
|
||||
@ -176,7 +176,7 @@ static void __set_qlm_pcie_mode_61xx(int pcie_port, int root_complex)
|
||||
* SPEED value is ignored in this mode. QLM_SPD is set based on
|
||||
* pcie2x1 value in this mode.
|
||||
*
|
||||
* @return Return 0 on success or -1.
|
||||
* Return: Return 0 on success or -1.
|
||||
*/
|
||||
static int octeon_configure_qlm_cn61xx(int qlm, int speed, int mode, int rc, int pcie2x1)
|
||||
{
|
||||
@ -1882,7 +1882,7 @@ static int __dlmx_setup_pcie_cn70xx(int qlm, enum cvmx_qlm_mode mode, int gen2,
|
||||
* @param ref_clk_input The reference-clock input to use to configure QLM
|
||||
* @param ref_clk_sel The reference-clock selection to use to configure QLM
|
||||
*
|
||||
* @return Return 0 on success or -1.
|
||||
* Return: Return 0 on success or -1.
|
||||
*/
|
||||
static int octeon_configure_qlm_cn70xx(int qlm, int speed, int mode, int rc, int gen2,
|
||||
int ref_clk_sel, int ref_clk_input)
|
||||
@ -2168,7 +2168,7 @@ void octeon_qlm_dfe_disable(int node, int qlm, int lane, int baud_mhz, int mode)
|
||||
* @param ctle_zero Equalizer Peaking control
|
||||
* @param agc_pre_ctle Pre-CTLE gain
|
||||
* @param agc_post_ctle Post-CTLE gain
|
||||
* @return Zero on success, negative on failure
|
||||
* Return: Zero on success, negative on failure
|
||||
*/
|
||||
|
||||
int octeon_qlm_dfe_disable_ctle_agc(int node, int qlm, int lane, int baud_mhz, int mode,
|
||||
@ -3278,7 +3278,7 @@ static const struct refclk_settings_cn78xx refclk_settings_cn78xx[R_NUM_LANE_MOD
|
||||
* @param ref_clk_sel 0 = 100MHz, 1 = 125MHz, 2 = 156.25MHz,
|
||||
* 3 = 161.1328125MHz
|
||||
*
|
||||
* @return 0 for success or -1 if the reference clock selector is not supported
|
||||
* Return: 0 for success or -1 if the reference clock selector is not supported
|
||||
*
|
||||
* NOTE: This must be called before __qlm_setup_pll_cn78xx.
|
||||
*/
|
||||
@ -3624,7 +3624,7 @@ static void __qlm_setup_pll_cn78xx(int node, int qlm)
|
||||
* @param[out] alt_pll_settings If non-NULL this will be set if non-default PLL
|
||||
* settings are required for the mode.
|
||||
*
|
||||
* @return lane mode to use or -1 on error
|
||||
* Return: lane mode to use or -1 on error
|
||||
*
|
||||
* NOTE: In some modes
|
||||
*/
|
||||
@ -4103,7 +4103,7 @@ static void __setup_pem_reset(int node, int pem, int is_endpoint)
|
||||
* 3 = REF_161MHZ
|
||||
* @param ref_clk_input The reference-clock input to use to configure QLM
|
||||
*
|
||||
* @return Return 0 on success or -1.
|
||||
* Return: Return 0 on success or -1.
|
||||
*/
|
||||
int octeon_configure_qlm_cn78xx(int node, int qlm, int baud_mhz, int mode, int rc, int gen3,
|
||||
int ref_clk_sel, int ref_clk_input)
|
||||
@ -4629,7 +4629,7 @@ static int __is_qlm_valid_bgx_cn73xx(int qlm)
|
||||
* 1 = common reference clock input 0
|
||||
* 2 = common reference clock input 1
|
||||
*
|
||||
* @return Return 0 on success or -1.
|
||||
* Return: Return 0 on success or -1.
|
||||
*/
|
||||
static int octeon_configure_qlm_cn73xx(int qlm, int baud_mhz, int mode, int rc, int gen3,
|
||||
int ref_clk_sel, int ref_clk_input)
|
||||
@ -5339,7 +5339,7 @@ static int __rmac_pll_config(int baud_mhz, int qlm, int mode)
|
||||
* 3 = REF_122MHZ
|
||||
* @param ref_clk_input The reference-clock input to use to configure QLM
|
||||
*
|
||||
* @return Return 0 on success or -1.
|
||||
* Return: Return 0 on success or -1.
|
||||
*/
|
||||
static int octeon_configure_qlm_cnf75xx(int qlm, int baud_mhz, int mode, int rc, int gen3,
|
||||
int ref_clk_sel, int ref_clk_input)
|
||||
@ -5788,7 +5788,7 @@ static int octeon_configure_qlm_cnf75xx(int qlm, int baud_mhz, int mode, int rc,
|
||||
* 1: QLMC_REF_CLK0
|
||||
* 2: QLMC_REF_CLK1
|
||||
*
|
||||
* @return Return 0 on success or -1.
|
||||
* Return: Return 0 on success or -1.
|
||||
*/
|
||||
int octeon_configure_qlm(int qlm, int speed, int mode, int rc, int pcie_mode, int ref_clk_sel,
|
||||
int ref_clk_input)
|
||||
|
||||
@ -70,7 +70,7 @@ static void pamu_setup_default_xfer_to_host_spaace(struct paace *spaace)
|
||||
then snoopid not defined
|
||||
* @param[in] subwin_cnt number of sub-windows
|
||||
*
|
||||
* @return Returns 0 upon success else error code < 0 returned
|
||||
* Return: Returns 0 upon success else error code < 0 returned
|
||||
*/
|
||||
static int pamu_config_ppaace(uint32_t liodn, uint64_t win_addr,
|
||||
uint64_t win_size, uint32_t omi,
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user