Commit 16df55ce authored by Randy Dunlap's avatar Randy Dunlap Committed by Thomas Bogendoerfer

mips: clean up (remove) kernel-doc in cavium-octeon/executive/

Remove all kernel-doc notation in arch/mips/cavium-octeon/executive/.
This removes dozens of kernel-doc warnings.

Most of these functions are static and don't need to be documented
with kernel-doc.
The function comments are still present for anyone who wants to read them.
These files are part of the OCTEON SDK so presumably they are documented
there as well.

   arch/mips/cavium-octeon/executive/cvmx-bootmem.c:61: warning: Function parameter or member 'addr' not described in 'CVMX_BOOTMEM_NAMED_GET_FIELD'
   arch/mips/cavium-octeon/executive/cvmx-bootmem.c:61: warning: Function parameter or member 'field' not described in 'CVMX_BOOTMEM_NAMED_GET_FIELD'
   arch/mips/cavium-octeon/executive/cvmx-bootmem.c:61: warning: expecting prototype for This macro returns a member of the(). Prototype was for CVMX_BOOTMEM_NAMED_GET_FIELD() instead
   arch/mips/cavium-octeon/executive/cvmx-bootmem.c:77: warning: Function parameter or member 'base' not described in '__cvmx_bootmem_desc_get'
   arch/mips/cavium-octeon/executive/cvmx-bootmem.c:77: warning: Function parameter or member 'offset' not described in '__cvmx_bootmem_desc_get'
   arch/mips/cavium-octeon/executive/cvmx-bootmem.c:77: warning: Function parameter or member 'size' not described in '__cvmx_bootmem_desc_get'
   arch/mips/cavium-octeon/executive/cvmx-bootmem.c:77: warning: expecting prototype for This function is the implementation of the get macros defined(). Prototype was for __cvmx_bootmem_desc_get() instead
   arch/mips/cavium-octeon/executive/cvmx-bootmem.c:133: warning: expecting prototype for Allocate a block of memory from the free list that was(). Prototype was for cvmx_bootmem_alloc_range() instead
   arch/mips/cavium-octeon/executive/cvmx-bootmem.c:554: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Finds a named memory block by name.
   arch/mips/cavium-octeon/executive/cvmx-bootmem.c:661: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Frees a named block.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   arch/mips/cavium-octeon/executive/cvmx-helper-board.c:64: warning: expecting prototype for Return the MII PHY address associated with the given IPD(). Prototype was for cvmx_helper_board_get_mii_address() instead
   arch/mips/cavium-octeon/executive/cvmx-helper-board.c:211: warning: expecting prototype for This function is the board specific method of determining an(). Prototype was for __cvmx_helper_board_link_get() instead
   arch/mips/cavium-octeon/executive/cvmx-helper-board.c:278: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * This function is called by cvmx_helper_interface_probe() after it
   arch/mips/cavium-octeon/executive/cvmx-helper-board.c:324: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Get the clock type used for the USB block based on board type.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   arch/mips/cavium-octeon/executive/cvmx-spi.c:77: warning: expecting prototype for Get current SPI4 initialization callbacks(). Prototype was for cvmx_spi_get_callbacks() instead
   arch/mips/cavium-octeon/executive/cvmx-spi.c:87: warning: expecting prototype for Set new SPI4 initialization callbacks(). Prototype was for cvmx_spi_set_callbacks() instead
   arch/mips/cavium-octeon/executive/cvmx-spi.c:92: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Initialize and start the SPI interface.
   arch/mips/cavium-octeon/executive/cvmx-spi.c:151: warning: expecting prototype for This routine restarts the SPI interface after it has lost synchronization(). Prototype was for cvmx_spi_restart_interface() instead
   arch/mips/cavium-octeon/executive/cvmx-spi.c:196: warning: expecting prototype for Callback to perform SPI4 reset(). Prototype was for cvmx_spi_reset_cb() instead
   arch/mips/cavium-octeon/executive/cvmx-spi.c:313: warning: expecting prototype for Callback to setup calendar and miscellaneous settings before clock detection(). Prototype was for cvmx_spi_calendar_setup_cb() instead
   arch/mips/cavium-octeon/executive/cvmx-spi.c:431: warning: expecting prototype for Callback to perform clock detection(). Prototype was for cvmx_spi_clock_detect_cb() instead
   arch/mips/cavium-octeon/executive/cvmx-spi.c:509: warning: expecting prototype for Callback to perform link training(). Prototype was for cvmx_spi_training_cb() instead
   arch/mips/cavium-octeon/executive/cvmx-spi.c:578: warning: expecting prototype for Callback to perform calendar data synchronization(). Prototype was for cvmx_spi_calendar_sync_cb() instead
   arch/mips/cavium-octeon/executive/cvmx-spi.c:634: warning: expecting prototype for Callback to handle interface up(). Prototype was for cvmx_spi_interface_up_cb() instead
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   arch/mips/cavium-octeon/executive/cvmx-helper-xaui.c:67: warning: expecting prototype for Probe a XAUI interface and determine the number of ports(). Prototype was for __cvmx_helper_xaui_probe() instead
   arch/mips/cavium-octeon/executive/cvmx-helper-xaui.c:106: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Bringup and enable a XAUI interface. After this call packet
   arch/mips/cavium-octeon/executive/cvmx-helper-xaui.c:253: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Return the link state of an IPD/PKO port as returned by
   arch/mips/cavium-octeon/executive/cvmx-helper-xaui.c:292: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Configure an IPD/PKO port for the specified link state. This
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   arch/mips/cavium-octeon/executive/cvmx-pko.c:43: warning: Function parameter or member 'interface' not described in '__cvmx_pko_int'
   arch/mips/cavium-octeon/executive/cvmx-pko.c:43: warning: Function parameter or member 'index' not described in '__cvmx_pko_int'
   arch/mips/cavium-octeon/executive/cvmx-pko.c:43: warning: expecting prototype for Internal state of packet output(). Prototype was for __cvmx_pko_int() instead
   arch/mips/cavium-octeon/executive/cvmx-pko.c:186: warning: expecting prototype for Call before any other calls to initialize the packet(). Prototype was for cvmx_pko_initialize_global() instead
   arch/mips/cavium-octeon/executive/cvmx-pko.c:241: warning: expecting prototype for This function does per(). Prototype was for cvmx_pko_initialize_local() instead
   arch/mips/cavium-octeon/executive/cvmx-pko.c:247: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Enables the packet output hardware. It must already be
   arch/mips/cavium-octeon/executive/cvmx-pko.c:270: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Disables the packet output. Does not affect any configuration.
   arch/mips/cavium-octeon/executive/cvmx-pko.c:282: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Reset the packet output.
   arch/mips/cavium-octeon/executive/cvmx-pko.c:293: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Shutdown and free resources required by packet output.
   arch/mips/cavium-octeon/executive/cvmx-pko.c:324: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Configure a output port and the associated queues for use.
   arch/mips/cavium-octeon/executive/cvmx-pko.c:555: warning: expecting prototype for Show map of ports(). Prototype was for cvmx_pko_show_queue_map() instead
   arch/mips/cavium-octeon/executive/cvmx-pko.c:577: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Rate limit a PKO port to a max packets/sec. This function is only
   arch/mips/cavium-octeon/executive/cvmx-pko.c:610: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Rate limit a PKO port to a max bits/sec. This function is only
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   arch/mips/cavium-octeon/executive/cvmx-cmd-queue.c:49: warning: cannot understand function prototype: '__cvmx_cmd_queue_all_state_t *__cvmx_cmd_queue_state_ptr; '
   arch/mips/cavium-octeon/executive/cvmx-cmd-queue.c:53: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Initialize the Global queue state pointer.
   arch/mips/cavium-octeon/executive/cvmx-cmd-queue.c:101: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Initialize a command queue for use. The initial FPA buffer is
   arch/mips/cavium-octeon/executive/cvmx-cmd-queue.c:199: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Shutdown a queue a free it's command buffers to the FPA. The
   arch/mips/cavium-octeon/executive/cvmx-cmd-queue.c:235: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Return the number of command words pending in the queue. This
   arch/mips/cavium-octeon/executive/cvmx-cmd-queue.c:291: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Return the command buffer to be written to. The purpose of this
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   arch/mips/cavium-octeon/executive/cvmx-helper-rgmii.c:53: warning: expecting prototype for Probe RGMII ports and determine the number present(). Prototype was for __cvmx_helper_rgmii_probe() instead
   arch/mips/cavium-octeon/executive/cvmx-helper-rgmii.c:92: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Put an RGMII interface in loopback mode. Internal packets sent
   arch/mips/cavium-octeon/executive/cvmx-helper-rgmii.c:135: warning: expecting prototype for Workaround ASX setup errata with CN38XX pass1(). Prototype was for __cvmx_helper_errata_asx_pass1() instead
   arch/mips/cavium-octeon/executive/cvmx-helper-rgmii.c:152: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Configure all of the ASX, GMX, and PKO registers required
   arch/mips/cavium-octeon/executive/cvmx-helper-rgmii.c:255: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Return the link state of an IPD/PKO port as returned by
   arch/mips/cavium-octeon/executive/cvmx-helper-rgmii.c:284: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Configure an IPD/PKO port for the specified link state. This
--
arch/mips/cavium-octeon/executive/cvmx-l2c.c:768: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Return log base 2 of the number of sets in the L2 cache
   arch/mips/cavium-octeon/executive/cvmx-l2c.c:861: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Flush a line from the L2 cache
Signed-off-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Reported-by: default avatarkernel test robot <lkp@intel.com>
Cc: Aditya Srivastava <yashsri421@gmail.com>
Cc: Thomas Bogendoerfer <tsbogend@alpha.franken.de>
Cc: linux-mips@vger.kernel.org
Signed-off-by: default avatarThomas Bogendoerfer <tsbogend@alpha.franken.de>
parent d656132d
...@@ -44,7 +44,7 @@ static struct cvmx_bootmem_desc *cvmx_bootmem_desc; ...@@ -44,7 +44,7 @@ static struct cvmx_bootmem_desc *cvmx_bootmem_desc;
/* See header file for descriptions of functions */ /* See header file for descriptions of functions */
/** /*
* This macro returns a member of the * This macro returns a member of the
* cvmx_bootmem_named_block_desc_t structure. These members can't * cvmx_bootmem_named_block_desc_t structure. These members can't
* be directly addressed as they might be in memory not directly * be directly addressed as they might be in memory not directly
...@@ -60,7 +60,7 @@ static struct cvmx_bootmem_desc *cvmx_bootmem_desc; ...@@ -60,7 +60,7 @@ static struct cvmx_bootmem_desc *cvmx_bootmem_desc;
offsetof(struct cvmx_bootmem_named_block_desc, field), \ offsetof(struct cvmx_bootmem_named_block_desc, field), \
sizeof_field(struct cvmx_bootmem_named_block_desc, field)) sizeof_field(struct cvmx_bootmem_named_block_desc, field))
/** /*
* This function is the implementation of the get macros defined * This function is the implementation of the get macros defined
* for individual structure members. The argument are generated * for individual structure members. The argument are generated
* by the macros inorder to read only the needed memory. * by the macros inorder to read only the needed memory.
...@@ -115,7 +115,7 @@ static uint64_t cvmx_bootmem_phy_get_next(uint64_t addr) ...@@ -115,7 +115,7 @@ static uint64_t cvmx_bootmem_phy_get_next(uint64_t addr)
return cvmx_read64_uint64((addr + NEXT_OFFSET) | (1ull << 63)); return cvmx_read64_uint64((addr + NEXT_OFFSET) | (1ull << 63));
} }
/** /*
* Allocate a block of memory from the free list that was * Allocate a block of memory from the free list that was
* passed to the application by the bootloader within a specified * passed to the application by the bootloader within a specified
* address range. This is an allocate-only algorithm, so * address range. This is an allocate-only algorithm, so
...@@ -550,7 +550,7 @@ int __cvmx_bootmem_phy_free(uint64_t phy_addr, uint64_t size, uint32_t flags) ...@@ -550,7 +550,7 @@ int __cvmx_bootmem_phy_free(uint64_t phy_addr, uint64_t size, uint32_t flags)
} }
/** /*
* Finds a named memory block by name. * Finds a named memory block by name.
* Also used for finding an unused entry in the named block table. * Also used for finding an unused entry in the named block table.
* *
...@@ -657,7 +657,7 @@ struct cvmx_bootmem_named_block_desc *cvmx_bootmem_find_named_block(char *name) ...@@ -657,7 +657,7 @@ struct cvmx_bootmem_named_block_desc *cvmx_bootmem_find_named_block(char *name)
} }
EXPORT_SYMBOL(cvmx_bootmem_find_named_block); EXPORT_SYMBOL(cvmx_bootmem_find_named_block);
/** /*
* Frees a named block. * Frees a named block.
* *
* @name: name of block to free * @name: name of block to free
......
...@@ -42,14 +42,14 @@ ...@@ -42,14 +42,14 @@
#include <asm/octeon/cvmx-pexp-defs.h> #include <asm/octeon/cvmx-pexp-defs.h>
#include <asm/octeon/cvmx-pko-defs.h> #include <asm/octeon/cvmx-pko-defs.h>
/** /*
* This application uses this pointer to access the global queue * This application uses this pointer to access the global queue
* state. It points to a bootmem named block. * state. It points to a bootmem named block.
*/ */
__cvmx_cmd_queue_all_state_t *__cvmx_cmd_queue_state_ptr; __cvmx_cmd_queue_all_state_t *__cvmx_cmd_queue_state_ptr;
EXPORT_SYMBOL_GPL(__cvmx_cmd_queue_state_ptr); EXPORT_SYMBOL_GPL(__cvmx_cmd_queue_state_ptr);
/** /*
* Initialize the Global queue state pointer. * Initialize the Global queue state pointer.
* *
* Returns CVMX_CMD_QUEUE_SUCCESS or a failure code * Returns CVMX_CMD_QUEUE_SUCCESS or a failure code
...@@ -84,7 +84,7 @@ static cvmx_cmd_queue_result_t __cvmx_cmd_queue_init_state_ptr(void) ...@@ -84,7 +84,7 @@ static cvmx_cmd_queue_result_t __cvmx_cmd_queue_init_state_ptr(void)
return CVMX_CMD_QUEUE_SUCCESS; return CVMX_CMD_QUEUE_SUCCESS;
} }
/** /*
* Initialize a command queue for use. The initial FPA buffer is * Initialize a command queue for use. The initial FPA buffer is
* allocated and the hardware unit is configured to point to the * allocated and the hardware unit is configured to point to the
* new command queue. * new command queue.
...@@ -182,7 +182,7 @@ cvmx_cmd_queue_result_t cvmx_cmd_queue_initialize(cvmx_cmd_queue_id_t queue_id, ...@@ -182,7 +182,7 @@ cvmx_cmd_queue_result_t cvmx_cmd_queue_initialize(cvmx_cmd_queue_id_t queue_id,
} }
} }
/** /*
* Shutdown a queue a free it's command buffers to the FPA. The * Shutdown a queue a free it's command buffers to the FPA. The
* hardware connected to the queue must be stopped before this * hardware connected to the queue must be stopped before this
* function is called. * function is called.
...@@ -218,7 +218,7 @@ cvmx_cmd_queue_result_t cvmx_cmd_queue_shutdown(cvmx_cmd_queue_id_t queue_id) ...@@ -218,7 +218,7 @@ cvmx_cmd_queue_result_t cvmx_cmd_queue_shutdown(cvmx_cmd_queue_id_t queue_id)
return CVMX_CMD_QUEUE_SUCCESS; return CVMX_CMD_QUEUE_SUCCESS;
} }
/** /*
* Return the number of command words pending in the queue. This * Return the number of command words pending in the queue. This
* function may be relatively slow for some hardware units. * function may be relatively slow for some hardware units.
* *
...@@ -274,7 +274,7 @@ int cvmx_cmd_queue_length(cvmx_cmd_queue_id_t queue_id) ...@@ -274,7 +274,7 @@ int cvmx_cmd_queue_length(cvmx_cmd_queue_id_t queue_id)
return CVMX_CMD_QUEUE_INVALID_PARAM; return CVMX_CMD_QUEUE_INVALID_PARAM;
} }
/** /*
* Return the command buffer to be written to. The purpose of this * Return the command buffer to be written to. The purpose of this
* function is to allow CVMX routine access t othe low level buffer * function is to allow CVMX routine access t othe low level buffer
* for initial hardware setup. User applications should not call this * for initial hardware setup. User applications should not call this
......
...@@ -44,7 +44,7 @@ ...@@ -44,7 +44,7 @@
#include <asm/octeon/cvmx-gmxx-defs.h> #include <asm/octeon/cvmx-gmxx-defs.h>
#include <asm/octeon/cvmx-asxx-defs.h> #include <asm/octeon/cvmx-asxx-defs.h>
/** /*
* Return the MII PHY address associated with the given IPD * Return the MII PHY address associated with the given IPD
* port. A result of -1 means there isn't a MII capable PHY * port. A result of -1 means there isn't a MII capable PHY
* connected to this port. On chips supporting multiple MII * connected to this port. On chips supporting multiple MII
...@@ -189,7 +189,7 @@ int cvmx_helper_board_get_mii_address(int ipd_port) ...@@ -189,7 +189,7 @@ int cvmx_helper_board_get_mii_address(int ipd_port)
return -1; return -1;
} }
/** /*
* This function is the board specific method of determining an * This function is the board specific method of determining an
* ethernet ports link speed. Most Octeon boards have Marvell PHYs * ethernet ports link speed. Most Octeon boards have Marvell PHYs
* and are handled by the fall through case. This function must be * and are handled by the fall through case. This function must be
...@@ -274,7 +274,7 @@ union cvmx_helper_link_info __cvmx_helper_board_link_get(int ipd_port) ...@@ -274,7 +274,7 @@ union cvmx_helper_link_info __cvmx_helper_board_link_get(int ipd_port)
return result; return result;
} }
/** /*
* This function is called by cvmx_helper_interface_probe() after it * This function is called by cvmx_helper_interface_probe() after it
* determines the number of ports Octeon can support on a specific * determines the number of ports Octeon can support on a specific
* interface. This function is the per board location to override * interface. This function is the per board location to override
...@@ -320,7 +320,7 @@ int __cvmx_helper_board_interface_probe(int interface, int supported_ports) ...@@ -320,7 +320,7 @@ int __cvmx_helper_board_interface_probe(int interface, int supported_ports)
return supported_ports; return supported_ports;
} }
/** /*
* Get the clock type used for the USB block based on board type. * Get the clock type used for the USB block based on board type.
* Used by the USB code for auto configuration of clock type. * Used by the USB code for auto configuration of clock type.
* *
......
...@@ -42,7 +42,7 @@ ...@@ -42,7 +42,7 @@
#include <asm/octeon/cvmx-asxx-defs.h> #include <asm/octeon/cvmx-asxx-defs.h>
#include <asm/octeon/cvmx-dbg-defs.h> #include <asm/octeon/cvmx-dbg-defs.h>
/** /*
* Probe RGMII ports and determine the number present * Probe RGMII ports and determine the number present
* *
* @interface: Interface to probe * @interface: Interface to probe
...@@ -88,7 +88,7 @@ int __cvmx_helper_rgmii_probe(int interface) ...@@ -88,7 +88,7 @@ int __cvmx_helper_rgmii_probe(int interface)
return num_ports; return num_ports;
} }
/** /*
* Put an RGMII interface in loopback mode. Internal packets sent * Put an RGMII interface in loopback mode. Internal packets sent
* out will be received back again on the same port. Externally * out will be received back again on the same port. Externally
* received packets will echo back out. * received packets will echo back out.
...@@ -120,7 +120,7 @@ void cvmx_helper_rgmii_internal_loopback(int port) ...@@ -120,7 +120,7 @@ void cvmx_helper_rgmii_internal_loopback(int port)
cvmx_write_csr(CVMX_GMXX_PRTX_CFG(index, interface), gmx_cfg.u64); cvmx_write_csr(CVMX_GMXX_PRTX_CFG(index, interface), gmx_cfg.u64);
} }
/** /*
* Workaround ASX setup errata with CN38XX pass1 * Workaround ASX setup errata with CN38XX pass1
* *
* @interface: Interface to setup * @interface: Interface to setup
...@@ -148,7 +148,7 @@ static int __cvmx_helper_errata_asx_pass1(int interface, int port, ...@@ -148,7 +148,7 @@ static int __cvmx_helper_errata_asx_pass1(int interface, int port,
return 0; return 0;
} }
/** /*
* Configure all of the ASX, GMX, and PKO registers required * Configure all of the ASX, GMX, and PKO registers required
* to get RGMII to function on the supplied interface. * to get RGMII to function on the supplied interface.
* *
...@@ -251,7 +251,7 @@ int __cvmx_helper_rgmii_enable(int interface) ...@@ -251,7 +251,7 @@ int __cvmx_helper_rgmii_enable(int interface)
return 0; return 0;
} }
/** /*
* Return the link state of an IPD/PKO port as returned by * Return the link state of an IPD/PKO port as returned by
* auto negotiation. The result of this function may not match * auto negotiation. The result of this function may not match
* Octeon's link config if auto negotiation has changed since * Octeon's link config if auto negotiation has changed since
...@@ -280,7 +280,7 @@ union cvmx_helper_link_info __cvmx_helper_rgmii_link_get(int ipd_port) ...@@ -280,7 +280,7 @@ union cvmx_helper_link_info __cvmx_helper_rgmii_link_get(int ipd_port)
return __cvmx_helper_board_link_get(ipd_port); return __cvmx_helper_board_link_get(ipd_port);
} }
/** /*
* Configure an IPD/PKO port for the specified link state. This * Configure an IPD/PKO port for the specified link state. This
* function does not influence auto negotiation at the PHY level. * function does not influence auto negotiation at the PHY level.
* The passed link state must always match the link state returned * The passed link state must always match the link state returned
......
...@@ -54,7 +54,7 @@ int __cvmx_helper_xaui_enumerate(int interface) ...@@ -54,7 +54,7 @@ int __cvmx_helper_xaui_enumerate(int interface)
return 1; return 1;
} }
/** /*
* Probe a XAUI interface and determine the number of ports * Probe a XAUI interface and determine the number of ports
* connected to it. The XAUI interface should still be down * connected to it. The XAUI interface should still be down
* after this call. * after this call.
...@@ -102,7 +102,7 @@ int __cvmx_helper_xaui_probe(int interface) ...@@ -102,7 +102,7 @@ int __cvmx_helper_xaui_probe(int interface)
return __cvmx_helper_xaui_enumerate(interface); return __cvmx_helper_xaui_enumerate(interface);
} }
/** /*
* Bringup and enable a XAUI interface. After this call packet * Bringup and enable a XAUI interface. After this call packet
* I/O should be fully functional. This is called with IPD * I/O should be fully functional. This is called with IPD
* enabled but PKO disabled. * enabled but PKO disabled.
...@@ -249,7 +249,7 @@ int __cvmx_helper_xaui_enable(int interface) ...@@ -249,7 +249,7 @@ int __cvmx_helper_xaui_enable(int interface)
return 0; return 0;
} }
/** /*
* Return the link state of an IPD/PKO port as returned by * Return the link state of an IPD/PKO port as returned by
* auto negotiation. The result of this function may not match * auto negotiation. The result of this function may not match
* Octeon's link config if auto negotiation has changed since * Octeon's link config if auto negotiation has changed since
...@@ -288,7 +288,7 @@ union cvmx_helper_link_info __cvmx_helper_xaui_link_get(int ipd_port) ...@@ -288,7 +288,7 @@ union cvmx_helper_link_info __cvmx_helper_xaui_link_get(int ipd_port)
return result; return result;
} }
/** /*
* Configure an IPD/PKO port for the specified link state. This * Configure an IPD/PKO port for the specified link state. This
* function does not influence auto negotiation at the PHY level. * function does not influence auto negotiation at the PHY level.
* The passed link state must always match the link state returned * The passed link state must always match the link state returned
......
...@@ -281,7 +281,7 @@ uint64_t cvmx_l2c_read_perf(uint32_t counter) ...@@ -281,7 +281,7 @@ uint64_t cvmx_l2c_read_perf(uint32_t counter)
} }
} }
/** /*
* @INTERNAL * @INTERNAL
* Helper function use to fault in cache lines for L2 cache locking * Helper function use to fault in cache lines for L2 cache locking
* *
...@@ -575,7 +575,7 @@ union __cvmx_l2c_tag { ...@@ -575,7 +575,7 @@ union __cvmx_l2c_tag {
}; };
/** /*
* @INTERNAL * @INTERNAL
* Function to read a L2C tag. This code make the current core * Function to read a L2C tag. This code make the current core
* the 'debug core' for the L2. This code must only be executed by * the 'debug core' for the L2. This code must only be executed by
...@@ -764,9 +764,8 @@ int cvmx_l2c_get_cache_size_bytes(void) ...@@ -764,9 +764,8 @@ int cvmx_l2c_get_cache_size_bytes(void)
CVMX_CACHE_LINE_SIZE; CVMX_CACHE_LINE_SIZE;
} }
/** /*
* Return log base 2 of the number of sets in the L2 cache * Return log base 2 of the number of sets in the L2 cache
* Returns
*/ */
int cvmx_l2c_get_set_bits(void) int cvmx_l2c_get_set_bits(void)
{ {
...@@ -857,7 +856,7 @@ int cvmx_l2c_get_num_assoc(void) ...@@ -857,7 +856,7 @@ int cvmx_l2c_get_num_assoc(void)
return l2_assoc; return l2_assoc;
} }
/** /*
* Flush a line from the L2 cache * Flush a line from the L2 cache
* This should only be called from one core at a time, as this routine * This should only be called from one core at a time, as this routine
* sets the core to the 'debug' core in order to flush the line. * sets the core to the 'debug' core in order to flush the line.
......
...@@ -35,7 +35,7 @@ ...@@ -35,7 +35,7 @@
#include <asm/octeon/cvmx-pko.h> #include <asm/octeon/cvmx-pko.h>
#include <asm/octeon/cvmx-helper.h> #include <asm/octeon/cvmx-helper.h>
/** /*
* Internal state of packet output * Internal state of packet output
*/ */
...@@ -176,7 +176,7 @@ static void __cvmx_pko_chip_init(void) ...@@ -176,7 +176,7 @@ static void __cvmx_pko_chip_init(void)
} }
} }
/** /*
* Call before any other calls to initialize the packet * Call before any other calls to initialize the packet
* output system. This does chip global config, and should only be * output system. This does chip global config, and should only be
* done by one core. * done by one core.
...@@ -229,7 +229,7 @@ void cvmx_pko_initialize_global(void) ...@@ -229,7 +229,7 @@ void cvmx_pko_initialize_global(void)
} }
} }
/** /*
* This function does per-core initialization required by the PKO routines. * This function does per-core initialization required by the PKO routines.
* This must be called on all cores that will do packet output, and must * This must be called on all cores that will do packet output, and must
* be called after the FPA has been initialized and filled with pages. * be called after the FPA has been initialized and filled with pages.
...@@ -243,7 +243,7 @@ int cvmx_pko_initialize_local(void) ...@@ -243,7 +243,7 @@ int cvmx_pko_initialize_local(void)
return 0; return 0;
} }
/** /*
* Enables the packet output hardware. It must already be * Enables the packet output hardware. It must already be
* configured. * configured.
*/ */
...@@ -266,7 +266,7 @@ void cvmx_pko_enable(void) ...@@ -266,7 +266,7 @@ void cvmx_pko_enable(void)
cvmx_write_csr(CVMX_PKO_REG_FLAGS, flags.u64); cvmx_write_csr(CVMX_PKO_REG_FLAGS, flags.u64);
} }
/** /*
* Disables the packet output. Does not affect any configuration. * Disables the packet output. Does not affect any configuration.
*/ */
void cvmx_pko_disable(void) void cvmx_pko_disable(void)
...@@ -278,7 +278,7 @@ void cvmx_pko_disable(void) ...@@ -278,7 +278,7 @@ void cvmx_pko_disable(void)
} }
EXPORT_SYMBOL_GPL(cvmx_pko_disable); EXPORT_SYMBOL_GPL(cvmx_pko_disable);
/** /*
* Reset the packet output. * Reset the packet output.
*/ */
static void __cvmx_pko_reset(void) static void __cvmx_pko_reset(void)
...@@ -289,7 +289,7 @@ static void __cvmx_pko_reset(void) ...@@ -289,7 +289,7 @@ static void __cvmx_pko_reset(void)
cvmx_write_csr(CVMX_PKO_REG_FLAGS, pko_reg_flags.u64); cvmx_write_csr(CVMX_PKO_REG_FLAGS, pko_reg_flags.u64);
} }
/** /*
* Shutdown and free resources required by packet output. * Shutdown and free resources required by packet output.
*/ */
void cvmx_pko_shutdown(void) void cvmx_pko_shutdown(void)
...@@ -320,7 +320,7 @@ void cvmx_pko_shutdown(void) ...@@ -320,7 +320,7 @@ void cvmx_pko_shutdown(void)
} }
EXPORT_SYMBOL_GPL(cvmx_pko_shutdown); EXPORT_SYMBOL_GPL(cvmx_pko_shutdown);
/** /*
* Configure a output port and the associated queues for use. * Configure a output port and the associated queues for use.
* *
* @port: Port to configure. * @port: Port to configure.
...@@ -548,7 +548,7 @@ cvmx_pko_status_t cvmx_pko_config_port(uint64_t port, uint64_t base_queue, ...@@ -548,7 +548,7 @@ cvmx_pko_status_t cvmx_pko_config_port(uint64_t port, uint64_t base_queue,
} }
#ifdef PKO_DEBUG #ifdef PKO_DEBUG
/** /*
* Show map of ports -> queues for different cores. * Show map of ports -> queues for different cores.
*/ */
void cvmx_pko_show_queue_map() void cvmx_pko_show_queue_map()
...@@ -573,7 +573,7 @@ void cvmx_pko_show_queue_map() ...@@ -573,7 +573,7 @@ void cvmx_pko_show_queue_map()
} }
#endif #endif
/** /*
* Rate limit a PKO port to a max packets/sec. This function is only * Rate limit a PKO port to a max packets/sec. This function is only
* supported on CN51XX and higher, excluding CN58XX. * supported on CN51XX and higher, excluding CN58XX.
* *
...@@ -606,7 +606,7 @@ int cvmx_pko_rate_limit_packets(int port, int packets_s, int burst) ...@@ -606,7 +606,7 @@ int cvmx_pko_rate_limit_packets(int port, int packets_s, int burst)
return 0; return 0;
} }
/** /*
* Rate limit a PKO port to a max bits/sec. This function is only * Rate limit a PKO port to a max bits/sec. This function is only
* supported on CN51XX and higher, excluding CN58XX. * supported on CN51XX and higher, excluding CN58XX.
* *
......
...@@ -66,7 +66,7 @@ static cvmx_spi_callbacks_t cvmx_spi_callbacks = { ...@@ -66,7 +66,7 @@ static cvmx_spi_callbacks_t cvmx_spi_callbacks = {
.interface_up_cb = cvmx_spi_interface_up_cb .interface_up_cb = cvmx_spi_interface_up_cb
}; };
/** /*
* Get current SPI4 initialization callbacks * Get current SPI4 initialization callbacks
* *
* @callbacks: Pointer to the callbacks structure.to fill * @callbacks: Pointer to the callbacks structure.to fill
...@@ -78,7 +78,7 @@ void cvmx_spi_get_callbacks(cvmx_spi_callbacks_t *callbacks) ...@@ -78,7 +78,7 @@ void cvmx_spi_get_callbacks(cvmx_spi_callbacks_t *callbacks)
memcpy(callbacks, &cvmx_spi_callbacks, sizeof(cvmx_spi_callbacks)); memcpy(callbacks, &cvmx_spi_callbacks, sizeof(cvmx_spi_callbacks));
} }
/** /*
* Set new SPI4 initialization callbacks * Set new SPI4 initialization callbacks
* *
* @new_callbacks: Pointer to an updated callbacks structure. * @new_callbacks: Pointer to an updated callbacks structure.
...@@ -88,7 +88,7 @@ void cvmx_spi_set_callbacks(cvmx_spi_callbacks_t *new_callbacks) ...@@ -88,7 +88,7 @@ void cvmx_spi_set_callbacks(cvmx_spi_callbacks_t *new_callbacks)
memcpy(&cvmx_spi_callbacks, new_callbacks, sizeof(cvmx_spi_callbacks)); memcpy(&cvmx_spi_callbacks, new_callbacks, sizeof(cvmx_spi_callbacks));
} }
/** /*
* Initialize and start the SPI interface. * Initialize and start the SPI interface.
* *
* @interface: The identifier of the packet interface to configure and * @interface: The identifier of the packet interface to configure and
...@@ -133,7 +133,7 @@ int cvmx_spi_start_interface(int interface, cvmx_spi_mode_t mode, int timeout, ...@@ -133,7 +133,7 @@ int cvmx_spi_start_interface(int interface, cvmx_spi_mode_t mode, int timeout,
return res; return res;
} }
/** /*
* This routine restarts the SPI interface after it has lost synchronization * This routine restarts the SPI interface after it has lost synchronization
* with its correspondent system. * with its correspondent system.
* *
...@@ -179,7 +179,7 @@ int cvmx_spi_restart_interface(int interface, cvmx_spi_mode_t mode, int timeout) ...@@ -179,7 +179,7 @@ int cvmx_spi_restart_interface(int interface, cvmx_spi_mode_t mode, int timeout)
} }
EXPORT_SYMBOL_GPL(cvmx_spi_restart_interface); EXPORT_SYMBOL_GPL(cvmx_spi_restart_interface);
/** /*
* Callback to perform SPI4 reset * Callback to perform SPI4 reset
* *
* @interface: The identifier of the packet interface to configure and * @interface: The identifier of the packet interface to configure and
...@@ -294,7 +294,7 @@ int cvmx_spi_reset_cb(int interface, cvmx_spi_mode_t mode) ...@@ -294,7 +294,7 @@ int cvmx_spi_reset_cb(int interface, cvmx_spi_mode_t mode)
return 0; return 0;
} }
/** /*
* Callback to setup calendar and miscellaneous settings before clock detection * Callback to setup calendar and miscellaneous settings before clock detection
* *
* @interface: The identifier of the packet interface to configure and * @interface: The identifier of the packet interface to configure and
...@@ -413,7 +413,7 @@ int cvmx_spi_calendar_setup_cb(int interface, cvmx_spi_mode_t mode, ...@@ -413,7 +413,7 @@ int cvmx_spi_calendar_setup_cb(int interface, cvmx_spi_mode_t mode,
return 0; return 0;
} }
/** /*
* Callback to perform clock detection * Callback to perform clock detection
* *
* @interface: The identifier of the packet interface to configure and * @interface: The identifier of the packet interface to configure and
...@@ -491,7 +491,7 @@ int cvmx_spi_clock_detect_cb(int interface, cvmx_spi_mode_t mode, int timeout) ...@@ -491,7 +491,7 @@ int cvmx_spi_clock_detect_cb(int interface, cvmx_spi_mode_t mode, int timeout)
return 0; return 0;
} }
/** /*
* Callback to perform link training * Callback to perform link training
* *
* @interface: The identifier of the packet interface to configure and * @interface: The identifier of the packet interface to configure and
...@@ -560,7 +560,7 @@ int cvmx_spi_training_cb(int interface, cvmx_spi_mode_t mode, int timeout) ...@@ -560,7 +560,7 @@ int cvmx_spi_training_cb(int interface, cvmx_spi_mode_t mode, int timeout)
return 0; return 0;
} }
/** /*
* Callback to perform calendar data synchronization * Callback to perform calendar data synchronization
* *
* @interface: The identifier of the packet interface to configure and * @interface: The identifier of the packet interface to configure and
...@@ -617,7 +617,7 @@ int cvmx_spi_calendar_sync_cb(int interface, cvmx_spi_mode_t mode, int timeout) ...@@ -617,7 +617,7 @@ int cvmx_spi_calendar_sync_cb(int interface, cvmx_spi_mode_t mode, int timeout)
return 0; return 0;
} }
/** /*
* Callback to handle interface up * Callback to handle interface up
* *
* @interface: The identifier of the packet interface to configure and * @interface: The identifier of the packet interface to configure and
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment