Commit 862d3f2c authored by Alex Elder's avatar Alex Elder Committed by David S. Miller

net: ipa: fix all kernel-doc warnings

Fix all warnings produced when running:
  scripts/kernel-doc -none drivers/net/ipa/*.[ch]
Signed-off-by: default avatarAlex Elder <elder@linaro.org>
Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parent 9d036544
...@@ -100,7 +100,7 @@ void gsi_channel_doorbell(struct gsi_channel *channel); ...@@ -100,7 +100,7 @@ void gsi_channel_doorbell(struct gsi_channel *channel);
/** /**
* gsi_ring_virt() - Return virtual address for a ring entry * gsi_ring_virt() - Return virtual address for a ring entry
* @ring: Ring whose address is to be translated * @ring: Ring whose address is to be translated
* @addr: Index (slot number) of entry * @index: Index (slot number) of entry
*/ */
void *gsi_ring_virt(struct gsi_ring *ring, u32 index); void *gsi_ring_virt(struct gsi_ring *ring, u32 index);
......
...@@ -71,7 +71,7 @@ struct gsi_trans { ...@@ -71,7 +71,7 @@ struct gsi_trans {
/** /**
* gsi_trans_pool_init() - Initialize a pool of structures for transactions * gsi_trans_pool_init() - Initialize a pool of structures for transactions
* @gsi: GSI pointer * @pool: GSI transaction poll pointer
* @size: Size of elements in the pool * @size: Size of elements in the pool
* @count: Minimum number of elements in the pool * @count: Minimum number of elements in the pool
* @max_alloc: Maximum number of elements allocated at a time from pool * @max_alloc: Maximum number of elements allocated at a time from pool
...@@ -123,7 +123,8 @@ int gsi_trans_pool_init_dma(struct device *dev, struct gsi_trans_pool *pool, ...@@ -123,7 +123,8 @@ int gsi_trans_pool_init_dma(struct device *dev, struct gsi_trans_pool *pool,
void *gsi_trans_pool_alloc_dma(struct gsi_trans_pool *pool, dma_addr_t *addr); void *gsi_trans_pool_alloc_dma(struct gsi_trans_pool *pool, dma_addr_t *addr);
/** /**
* gsi_trans_pool_exit() - Inverse of gsi_trans_pool_init() * gsi_trans_pool_exit_dma() - Inverse of gsi_trans_pool_init_dma()
* @dev: Device used for DMA
* @pool: Pool pointer * @pool: Pool pointer
*/ */
void gsi_trans_pool_exit_dma(struct device *dev, struct gsi_trans_pool *pool); void gsi_trans_pool_exit_dma(struct device *dev, struct gsi_trans_pool *pool);
......
...@@ -44,6 +44,8 @@ enum ipa_flag { ...@@ -44,6 +44,8 @@ enum ipa_flag {
* @version: IPA hardware version * @version: IPA hardware version
* @pdev: Platform device * @pdev: Platform device
* @completion: Used to signal pipeline clear transfer complete * @completion: Used to signal pipeline clear transfer complete
* @nb: Notifier block used for remoteproc SSR
* @notifier: Remoteproc SSR notifier
* @smp2p: SMP2P information * @smp2p: SMP2P information
* @clock: IPA clocking information * @clock: IPA clocking information
* @table_addr: DMA address of filter/route table content * @table_addr: DMA address of filter/route table content
...@@ -58,13 +60,12 @@ enum ipa_flag { ...@@ -58,13 +60,12 @@ enum ipa_flag {
* @mem_size: Total size (bytes) of memory at @mem_virt * @mem_size: Total size (bytes) of memory at @mem_virt
* @mem: Array of IPA-local memory region descriptors * @mem: Array of IPA-local memory region descriptors
* @imem_iova: I/O virtual address of IPA region in IMEM * @imem_iova: I/O virtual address of IPA region in IMEM
* @imem_size; Size of IMEM region * @imem_size: Size of IMEM region
* @smem_iova: I/O virtual address of IPA region in SMEM * @smem_iova: I/O virtual address of IPA region in SMEM
* @smem_size; Size of SMEM region * @smem_size: Size of SMEM region
* @zero_addr: DMA address of preallocated zero-filled memory * @zero_addr: DMA address of preallocated zero-filled memory
* @zero_virt: Virtual address of preallocated zero-filled memory * @zero_virt: Virtual address of preallocated zero-filled memory
* @zero_size: Size (bytes) of preallocated zero-filled memory * @zero_size: Size (bytes) of preallocated zero-filled memory
* @wakeup_source: Wakeup source information
* @available: Bit mask indicating endpoints hardware supports * @available: Bit mask indicating endpoints hardware supports
* @filter_map: Bit mask indicating endpoints that support filtering * @filter_map: Bit mask indicating endpoints that support filtering
* @initialized: Bit mask indicating endpoints initialized * @initialized: Bit mask indicating endpoints initialized
......
...@@ -20,11 +20,18 @@ struct gsi_channel; ...@@ -20,11 +20,18 @@ struct gsi_channel;
/** /**
* enum ipa_cmd_opcode: IPA immediate commands * enum ipa_cmd_opcode: IPA immediate commands
* *
* All immediate commands are issued using the AP command TX endpoint. * @IPA_CMD_IP_V4_FILTER_INIT: Initialize IPv4 filter table
* The numeric values here are the opcodes for IPA v3.5.1 hardware. * @IPA_CMD_IP_V6_FILTER_INIT: Initialize IPv6 filter table
* @IPA_CMD_IP_V4_ROUTING_INIT: Initialize IPv4 routing table
* @IPA_CMD_IP_V6_ROUTING_INIT: Initialize IPv6 routing table
* @IPA_CMD_HDR_INIT_LOCAL: Initialize IPA-local header memory
* @IPA_CMD_REGISTER_WRITE: Register write performed by IPA
* @IPA_CMD_IP_PACKET_INIT: Set up next packet's destination endpoint
* @IPA_CMD_DMA_SHARED_MEM: DMA command performed by IPA
* @IPA_CMD_IP_PACKET_TAG_STATUS: Have next packet generate tag * status
* @IPA_CMD_NONE: Special (invalid) "not a command" value
* *
* IPA_CMD_NONE is a special (invalid) value that's used to indicate * All immediate commands are issued using the AP command TX endpoint.
* a request is *not* an immediate command.
*/ */
enum ipa_cmd_opcode { enum ipa_cmd_opcode {
IPA_CMD_NONE = 0x0, IPA_CMD_NONE = 0x0,
...@@ -96,7 +103,7 @@ static inline bool ipa_cmd_data_valid(struct ipa *ipa) ...@@ -96,7 +103,7 @@ static inline bool ipa_cmd_data_valid(struct ipa *ipa)
* *
* Return: 0 if successful, or a negative error code * Return: 0 if successful, or a negative error code
*/ */
int ipa_cmd_pool_init(struct gsi_channel *gsi_channel, u32 tre_count); int ipa_cmd_pool_init(struct gsi_channel *channel, u32 tre_count);
/** /**
* ipa_cmd_pool_exit() - Inverse of ipa_cmd_pool_init() * ipa_cmd_pool_exit() - Inverse of ipa_cmd_pool_init()
...@@ -124,7 +131,7 @@ void ipa_cmd_table_init_add(struct gsi_trans *trans, enum ipa_cmd_opcode opcode, ...@@ -124,7 +131,7 @@ void ipa_cmd_table_init_add(struct gsi_trans *trans, enum ipa_cmd_opcode opcode,
/** /**
* ipa_cmd_hdr_init_local_add() - Add a header init command to a transaction * ipa_cmd_hdr_init_local_add() - Add a header init command to a transaction
* @ipa: IPA structure * @trans: GSI transaction
* @offset: Offset of header memory in IPA local space * @offset: Offset of header memory in IPA local space
* @size: Size of header memory * @size: Size of header memory
* @addr: DMA address of buffer to be written from * @addr: DMA address of buffer to be written from
......
...@@ -41,8 +41,20 @@ enum ipa_endpoint_name { ...@@ -41,8 +41,20 @@ enum ipa_endpoint_name {
/** /**
* struct ipa_endpoint - IPA endpoint information * struct ipa_endpoint - IPA endpoint information
* @channel_id: EP's GSI channel * @ipa: IPA pointer
* @evt_ring_id: EP's GSI channel event ring * @ee_id: Execution environmnent endpoint is associated with
* @channel_id: GSI channel used by the endpoint
* @endpoint_id: IPA endpoint number
* @toward_ipa: Endpoint direction (true = TX, false = RX)
* @data: Endpoint configuration data
* @trans_tre_max: Maximum number of TRE descriptors per transaction
* @evt_ring_id: GSI event ring used by the endpoint
* @netdev: Network device pointer, if endpoint uses one
* @replenish_enabled: Whether receive buffer replenishing is enabled
* @replenish_ready: Number of replenish transactions without doorbell
* @replenish_saved: Replenish requests held while disabled
* @replenish_backlog: Number of buffers needed to fill hardware queue
* @replenish_work: Work item used for repeated replenish failures
*/ */
struct ipa_endpoint { struct ipa_endpoint {
struct ipa *ipa; struct ipa *ipa;
...@@ -52,7 +64,7 @@ struct ipa_endpoint { ...@@ -52,7 +64,7 @@ struct ipa_endpoint {
bool toward_ipa; bool toward_ipa;
const struct ipa_endpoint_config_data *data; const struct ipa_endpoint_config_data *data;
u32 trans_tre_max; /* maximum descriptors per transaction */ u32 trans_tre_max;
u32 evt_ring_id; u32 evt_ring_id;
/* Net device this endpoint is associated with, if any */ /* Net device this endpoint is associated with, if any */
......
...@@ -24,6 +24,7 @@ typedef void (*ipa_irq_handler_t)(struct ipa *ipa, enum ipa_irq_id irq_id); ...@@ -24,6 +24,7 @@ typedef void (*ipa_irq_handler_t)(struct ipa *ipa, enum ipa_irq_id irq_id);
/** /**
* ipa_interrupt_add() - Register a handler for an IPA interrupt type * ipa_interrupt_add() - Register a handler for an IPA interrupt type
* @interrupt: IPA interrupt structure
* @irq_id: IPA interrupt type * @irq_id: IPA interrupt type
* @handler: Handler function for the interrupt * @handler: Handler function for the interrupt
* *
......
...@@ -77,7 +77,7 @@ enum ipa_mem_id { ...@@ -77,7 +77,7 @@ enum ipa_mem_id {
* struct ipa_mem - IPA local memory region description * struct ipa_mem - IPA local memory region description
* @offset: offset in IPA memory space to base of the region * @offset: offset in IPA memory space to base of the region
* @size: size in bytes base of the region * @size: size in bytes base of the region
* @canary_count # 32-bit "canary" values that precede region * @canary_count: Number of 32-bit "canary" values that precede region
*/ */
struct ipa_mem { struct ipa_mem {
u32 offset; u32 offset;
......
...@@ -13,11 +13,15 @@ struct ipa; ...@@ -13,11 +13,15 @@ struct ipa;
/** /**
* struct ipa_qmi - QMI state associated with an IPA * struct ipa_qmi - QMI state associated with an IPA
* @client_handle - used to send an QMI requests to the modem * @client_handle: Used to send an QMI requests to the modem
* @server_handle - used to handle QMI requests from the modem * @server_handle: Used to handle QMI requests from the modem
* @initialized - whether QMI initialization has completed * @modem_sq: QMAP socket address for the modem QMI server
* @indication_register_received - tracks modem request receipt * @init_driver_work: Work structure used for INIT_DRIVER message handling
* @init_driver_response_received - tracks modem response receipt * @initial_boot: True if first boot has not yet completed
* @uc_ready: True once DRIVER_INIT_COMPLETE request received
* @modem_ready: True when INIT_DRIVER response received
* @indication_requested: True when INDICATION_REGISTER request received
* @indication_sent: True when INIT_COMPLETE indication sent
*/ */
struct ipa_qmi { struct ipa_qmi {
struct qmi_handle client_handle; struct qmi_handle client_handle;
......
...@@ -28,7 +28,7 @@ void ipa_smp2p_exit(struct ipa *ipa); ...@@ -28,7 +28,7 @@ void ipa_smp2p_exit(struct ipa *ipa);
/** /**
* ipa_smp2p_disable() - Prevent "ipa-setup-ready" interrupt handling * ipa_smp2p_disable() - Prevent "ipa-setup-ready" interrupt handling
* @IPA: IPA pointer * @ipa: IPA pointer
* *
* Prevent handling of the "setup ready" interrupt from the modem. * Prevent handling of the "setup ready" interrupt from the modem.
* This is used before initiating shutdown of the driver. * This is used before initiating shutdown of the driver.
......
...@@ -24,7 +24,7 @@ struct ipa; ...@@ -24,7 +24,7 @@ struct ipa;
/** /**
* ipa_table_valid() - Validate route and filter table memory regions * ipa_table_valid() - Validate route and filter table memory regions
* @ipa: IPA pointer * @ipa: IPA pointer
*
* Return: true if all regions are valid, false otherwise * Return: true if all regions are valid, false otherwise
*/ */
bool ipa_table_valid(struct ipa *ipa); bool ipa_table_valid(struct ipa *ipa);
...@@ -32,6 +32,7 @@ bool ipa_table_valid(struct ipa *ipa); ...@@ -32,6 +32,7 @@ bool ipa_table_valid(struct ipa *ipa);
/** /**
* ipa_filter_map_valid() - Validate a filter table endpoint bitmap * ipa_filter_map_valid() - Validate a filter table endpoint bitmap
* @ipa: IPA pointer * @ipa: IPA pointer
* @filter_mask: Filter table endpoint bitmap to check
* *
* Return: true if all regions are valid, false otherwise * Return: true if all regions are valid, false otherwise
*/ */
......
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