ROHM-Open-Developers / WlanBP3595AP

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of WlanBP3595AP by Rohm

Embed: (wiki syntax)

« Back to documentation index

WlanBP3595.h File Reference
Data Structures | Typedefs | Functions

WlanBP3595.h File Reference

WlanBP3595 library. More...

Go to the source code of this file.

Data Structures

struct  GRP_WLD_BYTE_ARRAY_T
 Byte array structure. More...
struct  GRP_WLD_DEV_STRINGS_T
 Device strings structure. More...
struct  GRP_WLD_SITE_SURVEY_RESULT_T
 Site survey result structure. More...
struct  GRP_WLD_SITE_SURVEY_RESULT_ARRAY_T
 Site survey result array structure. More...
struct  GRP_WLD_WPS_CRED_T
 WPS cred list structure. More...
struct  GRP_WLD_WPS_CRED_LIST_T
 WPS cred list structure. More...
struct  GRP_WLD_STA_JOIN_INFO_T
 STA join information. More...
struct  GRP_WLD_CONNECTED_STA_LIST_INFO_T
 Connected Sta list information. More...

Typedefs

typedef struct GRP_WLD_BYTE_ARRAY_T grp_wld_byte_array
 Byte array structure.
typedef struct
GRP_WLD_DEV_STRINGS_T 		grp_wld_dev_strings
 Device strings structure.
typedef struct
GRP_WLD_SITE_SURVEY_RESULT_T 		grp_wld_site_survey_result
 Site survey result structure.
typedef struct
GRP_WLD_SITE_SURVEY_RESULT_ARRAY_T 		grp_wld_site_survey_result_array
 Site survey result array structure.
typedef struct GRP_WLD_WPS_CRED_T grp_wld_wps_cred
 WPS cred list structure.
typedef struct
GRP_WLD_WPS_CRED_LIST_T 		grp_wld_wps_cred_list
 WPS cred list structure.
typedef struct
GRP_WLD_STA_JOIN_INFO_T 		grp_wld_sta_join_info
 STA join information.
typedef struct
GRP_WLD_CONNECTED_STA_LIST_INFO_T 		grp_wld_connected_sta_list_info
 Connected Sta list information.

Functions

int WlanBP3595_Init (void(*pfnWlanInfoNotication)(uint8_t, uint16_t, uint16_t, uint8_t *))
 Initialize WlanBP3595.
uint32_t WlanBP3595_GetWlanSts (void)
 Get the status of WlanBP3595.
int WlanBP3595_Ioctl (uint32_t ulFunc, void *pvParam)
 Execute WID function.
int WlanBP3595_Output (struct pbuf *p)
 Output an ethernet frame.
void WlanBP3595_RecvEnable (void)
 Enable receiving.
void WlanBP3595_RecvDisable (void)
 Disable receiving.

Detailed Description

WlanBP3595 library.

This library only works with GR-PEACH.

Note:
Please refer to ROHM's "Software Development Specs" for the information of WID.

Definition in file WlanBP3595.h.

Typedef Documentation

typedef struct GRP_WLD_BYTE_ARRAY_T grp_wld_byte_array

Byte array structure.

typedef struct GRP_WLD_CONNECTED_STA_LIST_INFO_T grp_wld_connected_sta_list_info

Connected Sta list information.

typedef struct GRP_WLD_DEV_STRINGS_T grp_wld_dev_strings

Device strings structure.

typedef struct GRP_WLD_SITE_SURVEY_RESULT_T grp_wld_site_survey_result

Site survey result structure.

typedef struct GRP_WLD_SITE_SURVEY_RESULT_ARRAY_T grp_wld_site_survey_result_array

Site survey result array structure.

typedef struct GRP_WLD_STA_JOIN_INFO_T grp_wld_sta_join_info

STA join information.

typedef struct GRP_WLD_WPS_CRED_T grp_wld_wps_cred

WPS cred list structure.

typedef struct GRP_WLD_WPS_CRED_LIST_T grp_wld_wps_cred_list

WPS cred list structure.

Function Documentation

uint32_t WlanBP3595_GetWlanSts ( void   )

Get the status of WlanBP3595.

Return values:
WLAN_BP3595_NONEBP3595 is not connected, or the firmware is not downloaded
WLAN_BP3595_FW_DLThe firmware is being downloaded
WLAN_BP3595_STARTThe firmware was downloaded and is working
int WlanBP3595_Init ( void(*)(uint8_t, uint16_t, uint16_t, uint8_t *)  pfnWlanInfoNotication )

Initialize WlanBP3595.

Note:
After executing this function, please wait until the state becomes WLAN_BP3595_START. You can get the status by WlanBP3595_GetWlanSts().
Parameters:
pfnWlanInfoNoticationThe information callback function

  • 1st param : The message type ('I' or 'N')
  • 2nd param : WID number
  • 3rd param : The data size
  • 4th param : The data buffer
Return values:
0Success
The othersFailure
int WlanBP3595_Ioctl ( uint32_t  ulFunc,
void *  pvParam 
)

Execute WID function.

Parameters:
ulFuncA function number
pvParamThe data buffer (the parameter)
Return values:
0Success
The othersFailure
int WlanBP3595_Output ( struct pbuf *  p )

Output an ethernet frame.

Note:
This function is used in EthernetInterface driver.
Parameters:
pA pbuf to output
Return values:
0Success
The othersFailure
void WlanBP3595_RecvDisable ( void   )

Disable receiving.

Note:
This function is used in EthernetInterface driver.
void WlanBP3595_RecvEnable ( void   )

Enable receiving.

Note:
This function is used in EthernetInterface driver.
Generated on Wed Jul 13 2022 05:45:33 by  doxygen 1.7.2