michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doxygen: RETURNS: -> @return

Browse source 
Previous comment style used RETRURNS:, use @return to comply
with javadoc style.

Change-Id: Ib1dffd92da1d97d60063ec5309b08049828f6661
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This commit is contained in:
Anas Nashif 2015-07-01 17:29:04 -04:00
commit 1362e3c162
212 changed files with 1126 additions and 1126 deletions
Download patch file Download diff file Expand all files Collapse all files

10
drivers/pci/pci.c
View file

@ -171,7 +171,7 @@ static struct lookup_data __noinit lookup;
*
* pci_get_bar_config - return the configuration for the specified BAR
*
* RETURNS: 0 if BAR is implemented, -1 if not.
* @return 0 if BAR is implemented, -1 if not.
*/
static inline int pci_bar_config_get(union pci_addr_reg pci_ctrl_addr,
@ -216,7 +216,7 @@ static inline int pci_bar_config_get(union pci_addr_reg pci_ctrl_addr,
*
* pci_bar_params_get - retrieve the I/O address and IRQ of the specified BAR
*
* RETURNS: -1 on error, 0 if 32 bit BAR retrieved or 1 if 64 bit BAR retrieved
* @return -1 on error, 0 if 32 bit BAR retrieved or 1 if 64 bit BAR retrieved
*
* NOTE: Routine does not set up parameters for 64 bit BARS, they are ignored.
*
@ -267,7 +267,7 @@ static inline int pci_bar_params_get(union pci_addr_reg pci_ctrl_addr,
*
* pci_dev_scan - scan the specified PCI device for all sub functions
*
* RETURNS: 1 if a device has been found, 0 otherwise.
* @return 1 if a device has been found, 0 otherwise.
*
* \NOMANUAL
*/
@ -382,7 +382,7 @@ void pci_bus_scan_init(void)
* given dev_info at first call. Which criterias can be class and/or
* vendor_id/device_id.
*
* RETURNS: 1 on success, 0 otherwise. On success, dev_info is filled in with
* @return 1 on success, 0 otherwise. On success, dev_info is filled in with
* currently found device information
*
* \NOMANUAL
@ -434,7 +434,7 @@ int pci_bus_scan(struct pci_dev_info *dev_info)
*
* Shows the PCI device found provided as parameter.
*
* RETURNS: N/A
* @return N/A
*/
void pci_show(struct pci_dev_info *dev_info)

14
drivers/pci/pci_config.c
View file

@ -62,7 +62,7 @@ This module implements the PCI config space access functions
* @param offset Offset into the configuration space.
* @param data Data written to the offset.
*
* RETURNS: N/A
* @return N/A
*/
void pci_config_out_long(uint32_t bus_no, uint32_t device_no, uint32_t func_no,
uint32_t offset, uint32_t data)
@ -92,7 +92,7 @@ void pci_config_out_long(uint32_t bus_no, uint32_t device_no, uint32_t func_no,
* @param offset Offset into the configuration space.
* @param data Data written to the offset.
*
* RETURNS: N/A
* @return N/A
*/
void pci_config_out_word(uint32_t bus_no, uint32_t device_no, uint32_t func_no,
uint32_t offset, uint16_t data)
@ -122,7 +122,7 @@ void pci_config_out_word(uint32_t bus_no, uint32_t device_no, uint32_t func_no,
* @param offset Offset into the configuration space.
* @param data Data written to the offset.
*
* RETURNS: N/A
* @return N/A
*/
void pci_config_out_byte(uint32_t bus_no, uint32_t device_no, uint32_t func_no,
uint32_t offset, uint8_t data)
@ -152,7 +152,7 @@ void pci_config_out_byte(uint32_t bus_no, uint32_t device_no, uint32_t func_no,
* @param offset Offset into the configuration space.
* @param data Data read from the offset.
*
* RETURNS: N/A
* @return N/A
*
*/
void pci_config_in_long(uint32_t bus_no, uint32_t device_no, uint32_t func_no,
@ -183,7 +183,7 @@ void pci_config_in_long(uint32_t bus_no, uint32_t device_no, uint32_t func_no,
* @param offset Offset into the configuration space.
* @param data Data read from the offset.
*
* RETURNS: N/A
* @return N/A
*
*/
@ -220,7 +220,7 @@ void pci_config_in_word(uint32_t bus_no, uint32_t device_no, uint32_t func_no,
* @param offset Offset into the configuration space.
* @param data Data read from the offset.
*
* RETURNS: N/A
* @return N/A
*
*/
@ -261,7 +261,7 @@ void pci_config_in_byte(uint32_t bus_no, uint32_t device_no, uint32_t func_no,
* @param function PCI function number.
* @param p_offset Returned config space offset.
*
* RETURNS: 0 if Extended Capability found, -1 otherwise
* @return 0 if Extended Capability found, -1 otherwise
*
*/

16
drivers/pci/pci_interface.c
View file

@ -59,7 +59,7 @@ This module implements the PCI H/W access functions.
* This routine reads the specified register from the PCI controller and
* places the data into the provided buffer.
*
* RETURNS: N/A
* @return N/A
*
*/
@ -93,7 +93,7 @@ static void pci_ctrl_read(uint32_t reg, /* PCI register to read */
* This routine writes the provided data to the specified register in the PCI
* controller.
*
* RETURNS: N/A
* @return N/A
*
*/
@ -127,7 +127,7 @@ static void pci_ctrl_write(uint32_t reg, /* PCI register to write */
*
* This routine reads the data register of the specified PCI controller.
*
* RETURNS: 0 or -1
* @return 0 or -1
*
*/
@ -154,7 +154,7 @@ static int pci_ctrl_data_read(uint32_t controller, /* controller number */
* This routine writes the provided data to the data register of the
* specified PCI controller.
*
* RETURNS: 0 or -1
* @return 0 or -1
*
*/
@ -181,7 +181,7 @@ static int pci_ctrl_data_write(uint32_t controller, /* controller number */
* This routine writes the provided data to the address register of the
* specified PCI controller.
*
* RETURNS: 0 or -1
* @return 0 or -1
*
*/
@ -243,7 +243,7 @@ static int pci_ctrl_addr_write(uint32_t controller, /* controller number */
* Reading of PCI data must be performed as an atomic operation. It is up to
* the caller to enforce this.
*
* RETURNS: N/A
* @return N/A
*
*/
@ -333,7 +333,7 @@ void pci_read(uint32_t controller, /* PCI controller to use */
* the caller to enforce this.
*
*
* RETURNS: N/A
* @return N/A
*
*/
@ -386,7 +386,7 @@ void pci_write(uint32_t controller, /* controller to use */
* This routine reads the PCI header for the specified device and puts the
* result in the supplied header structure.
*
* RETURNS: N/A
* @return N/A
*/
void pci_header_get(uint32_t controller,