MT7681 Io T WIFI Firmware Programming Guide V1.0

User Manual:

Open the PDF directly: View PDF .
Page Count: 32





























Version:1.0

Releasedate:2014‐8‐8





©2014MediaTekInc.

ThisdocumentcontainsinformationthatisproprietarytoMediaTekInc.

Unauthorizedreproductionordisclosureofthisinformationinwholeorinpartisstrictlyprohibited.



Specificationsaresubjecttochangewithoutnotice.



MT7681IoTWi‐FiFirmware

ProgrammingGuide

Mediatek Confidential



RevisionHistory

DateRevisionAuthorDescription

01.03.2014Firstv0.01JinchuanInitialdraftforMT7681IoTFirmwareProgrammingGuide.

01.16.2014v0.02JiayiUpdateFlashLayoutandFlashAPI

UpdateFolderStructure

01.24.2014v0.03JinchuanUpdateFlashLayoutandFlashAPI：spi_flash_write()

AddSection:ATCommandUsage

03.22.2014v0.04Jinchuan

Jerry

AddFIRMWAREbootUPflow

AddCustomerHookFunction

AddFlashsettingsLoad/Storage

AddTimerAPIs

ModifyInterfaeAPIs

ModifyFlashPartitions

04.15.2014v0.05Jinchuan

Jerry

ModifyFileStructure

ModifyGPIOInterfaceDescriptionandGPIO/PinModeSet

ModifyFlashPartitions

AddNewPWMAPI

AddCustomerUART‐TO‐WIFIFunction

AddCustomerHookFunctionforSmartConnection

05.16.2014v0.07JinchuanAddIoT_gpio_read()

AddIoT_Cust_Set_GPIINT_MODE();

IoT_Cust_Get_GPIINT_MODE();

IoT_Cust_GPIINT_Hdlr()

AddGetMsTimer()

AddSecurityAPI

UpdateFirmwareBootUpFlow

UpdateCustomerHootkFunctioin

UpdateFileStructure

UpdateIoT_led_pwm():led_numrangeinsoftpwmmode

DeleteATCmdaboutTCP/UDP

05.30.2014v0.08JinchuanAddAPIsforRxfiltercontrol

AddSetchannelAPI

AddRxPacketAPI:STARxDoneInterruptHandle

AddTxPacketAPI:mt76xx_dev_send

AddAPIsforMD5:RT_MD5()…

07.09.2014v0.09JinchuanAddWifiStateMachineFlowchart

UpdateRxfilterAPI’sNotes

UpdateIoT_Cmd_Set_ChannelAPI’schannelrange

UpdateATCmdChannelSwitch:AT#Channel‐b0‐c6

AddATcmdforSmartConnectionentry:AT#Smnt

Addspi_flash_write_func()description

Updatespi_flash_write()descriptionandAdddesignflow

AddHWTimer1InterruptFunction

8.8.2014V1.0JinchuanUpdateRxFilterDescription

CorrectAPInameas:RT_AES_Decrypt,RT_AES_Encrypt

Mediatek Confidential

AddSamplecodedescriptforAESECB/CBCDecrypt/Encrypt

AddIoT_send_udp_directly()APItosendudppacket

AddAsicSetChannel()API

AddSPICmdtableinthesectionof“FlashDriver”





Contents

1Introduction...................................................................................................................................................................5

1.1FlowChartSymbols..........................................................................................................................................5

1.2Keywords..........................................................................................................................................................5

2SWStructure.................................................................................................................................................................6

2.1Flowchart.........................................................................................................................................................6

3FileStructure.................................................................................................................................................................6

4FIRMWAREbootUPflow..............................................................................................................................................7

5WifiConnectionStateMachineFlow............................................................................................................................7

6CustomerHookFunction...............................................................................................................................................8

7CustomerUART‐TO‐WIFIFunction................................................................................................................................9

8FlashsettingsLoad/Storage........................................................................................................................................10

9ATCommand...............................................................................................................................................................13

9.1Flowchart:......................................................................................................................................................13

9.2FunctionDescription.......................................................................................................................................13

9.3HowtoaddanewATcommand.....................................................................................................................14

10DataCommand............................................................................................................................................................14

10.1Flowchart:......................................................................................................................................................14

10.2FunctionDescription.......................................................................................................................................15

10.3HowtoaddanewDatacommand.................................................................................................................15

11WIFIMACAPIS.............................................................................................................................................................16

11.1RxFilterControl..............................................................................................................................................16

11.2MACControl...................................................................................................................................................16

Mediatek Confidential

12SecurityAPIS................................................................................................................................................................18

13TimerAPIs....................................................................................................................................................................20

13.1SWTimerAPIs.................................................................................................................................................20

13.2HWtimer1interruptfunction.........................................................................................................................21

14InterfaeAPIs................................................................................................................................................................21

14.1FlashDriver.....................................................................................................................................................21

14.2UART...............................................................................................................................................................23

14.3LED/PWM......................................................................................................................................................24

14.4GPIO................................................................................................................................................................25

14.5GPIO/PinModeSet.........................................................................................................................................27

15FlashPartitions............................................................................................................................................................28

16CompilerSetup............................................................................................................................................................30

17ATCommandUsage....................................................................................................................................................31

17.1Displayversion................................................................................................................................................31

17.2Rebootthesystem..........................................................................................................................................31

17.3SetDefault......................................................................................................................................................31

17.4Switchchannel................................................................................................................................................31

17.5ConfigureUARTinterface...............................................................................................................................31

17.6UpdateFirmwarefromUart...........................................................................................................................31

17.7EnterintoSmartConnectionState.................................................................................................................31

17.8EnterintoDeepsleepmode...........................................................................................................................32







Mediatek Confidential



1 INTRODUCTION

The7681IoTWi‐Fistructurecouldbedividedintotwolayers(HWlayer,FirmwareLayer);

Thisdocumentaimstohelptheprogrammersunderstandthe7681Wi‐FiFirmwarearchitectureandhowtodothe

customization,suchasATcommandorDatacommand



1.1 FlowChartSymbols





1.2 Keywords

BBP: BaseBandProcessor

SEC:   SecurityEngine

PBF: PacketBuffer

PDMA: ProgrammableDirectMemoryAccess

FCE: FrameControlEngine



Mediatek Confidential



2 SWSTRUCTURE

2.1 Flowchart



HWinit:initializetheHWregisterstoenableHWinterfacesandWi‐Fifunction

Wi‐FiStatemachine:asinglelooptocontrolWi‐FiTx,Rx,andprocesstheDatacommand,ATcommand

DataCommandhandler:handletheDatacommandwhichreceivedfromWi‐Fi

ATCommandhandler:handletheATcommandwhichreceivedfromUART

3 FILESTRUCTURE



\cust\main_pub.c,Mainentry

\cust\wifi_task_pub.c,WifiTaskFunction

\cust\rtmp_data_pub.c,RxHandler

\cust\iot_customer.c,TheInitialHookandsettingload/storage

\cust\iot_at_cmd.c,handletheATcommandwhichreceivedfromUART

\cust\iot_at_cmd_utility.c,thecommonapiforATcommandusage

\cust\iot_parse.c,handletheDatacommandwhichreceivedfromWi‐Fi

\cust\tcpip\*.c,thesourcecodeandsamplecodeforTCPUDP



\mak\MT7681\,storetheconfigurationforcompilerorlinker

\mak\MT7681\flags_sta.mk,storethemacrosforallstationmodesourcecode

\mak\MT7681\flags_ap.mk,storethemacrosforallAPmodesourcecode

\out\,storethefileswhichcreatedbycompiler

\out\build.log,thecompilinglog

\out\MT7681.bin,thetargetbinaryfile



\src\include,theheaderfiles

libandessta.a,libraryforMT7681StationMode

libandesap.a,libraryforMT7681APMode



MT7681_all.bin,TheImageforFWupgradebyFlashwriter

(includeLoader.bin,EEPROM.bin,RecoveryFW.bin,

StationFW.bin,APFW.bin)

Mediatek Confidential

4 FIRMWAREBOOTUPFLOW



TheBootupflowis:LoaderÆRecoveryModeÆLoaderÆSTA/APFW



5 WIFICONNECTIONSTATEMACHINEFLOW

STAModev1.40:

*WhenScan,Auth,Assoc,4Way,DHCPfail,notbacktosmartconnectionstate

*SmartConnectionstateisonlytriggeredbyfollowingmethods:

1:ThereisnovalidcontentinFlashStaConfigregion

2:7681receiveATCmd:AT#Smnt



Customermaybechangethisprocess,tomakesmntstatecanbeenteredwithothermethod

bycontrolATSetSmntflag

Mediatek Confidential



6 CUSTOMERHOOKFUNCTION

Iot_customer.c



IoT_Cust_Ops()isusedtoregistercallbackfunction,whichcouldbecalledbyWifimainfunction

Whenandwherethiscallbackfunctionwillbeused,pleaseseenextpictureforthedetails

Mediatek Confidential



7 CUSTOMERUART‐TO‐WIFIFUNCTION

Iot_customer_uart2wifi.c





Mediatek Confidential

IoT_Cust_uart2wifi_data_handler():

Itisthekeyfunctionforuart‐to‐wifitransmission.

ItisthebridgebetweenuartmoduleandTCP/IPmoduleofWiFi.

Inthesamplecode,uip_send()iscalledtosenddatafromuarttowifi.

IoT_Cust_uart2wifi_init():

Youcanuseittoconfigureuart‐to‐wifitimerintervalanduarttriggercount.

Inthesamplecode,every300ms,orwhentheuartrxcontentislargerthan10,

auart‐to‐wifitransmissionjudgmentwillbetriggered.

IoT_Cust_uart2wifi_detect_gpio_input_change():

Youcanuseittodefineyourowninputstatuschange.

Inthesamplecode,whentheinputofgpio2ishigh,uartrxisswitchedtopuredatamode;

otherwise,itisswitchedtoATcmdmode.

Note:

Uart‐to‐wififunctioncollideswithdataparseruartrxfunction,

soyoumustsetDATAPARSING_UARTRX_SUPPORTto0first.

Whenandwherethesefunctionswillbeused,pleaseseenextpictureforthedetails



8 FLASHSETTINGSLOAD/STORAGE

Iot_customer.c

ThedefaultsettingsonUser/Commonconfigblockoftheflash,ifthereisnocontentorthecontentisinvalid,

systemshallusedthesedefaultsettings,thedetailimplementationisontheiot_customer.c

Mediatek Confidential



Therearetwostructures:IOT_COM_CFG,IOT_USR_CFG

IOT_COM_CFG:Pleasedonotmodifythisstructure,becausetheWi‐Fimaintask/TCPIPwillusethisstructurefor

moduleinitializationoroperation

IOT_USR_CFG:Canbecustomized,becauseonlyiot_parser.c,iot_custom.cwillusethisstructure

Notice：BothofabovetwostructuresaremappingwithFlashLayout,andthesettingsload/resetisoptimizedforcode

sizeslimbymacro“FLASH_STRUCT_MAPPING1”withthiscondition.

IfthestructureisnotmappingwithFlashLayout,“FLASH_STRUCT_MAPPING”shouldbesetas0

Mediatek Confidential



ExampleA:ModifyIOTServerIPto{172.133.125.12}

Method1:Change#defineDEFAULT_IOT_SERVER_IP{182.148.129.91}to{172.133.125.12}

Method2:notmodifyDEFAULT_IOT_SERVER_IP,butuseFLASHAPItowritethenewvaluetorelated

positionoftheFLASH,thus,whileMT7681rebootorpoweronagain,thenewsettingsonflashwillbeload



ExampleB:AddaUart2WifiLengthparametertoUserConfigBlock

Step1：addnewmacroinflash_mapping.htoindicateUart2Wifipositionontheflash,

Step2：AddnewmemberonIOT_USR_CFGstructure

Step3:Addadefaultvaluemacro,justlike:#defineDEFAULT_IOT_SERVER_IP{182.148.129.91}

Step4:Addload/resetimplementationforUart2Wifionload_usr_cfg(),rest_usr_cfg()





Mediatek Confidential

9 ATCOMMAND

9.1 Flowchart:





9.2 FunctionDescription

z INT32IoT_parse_ATcommand(PUCHARcmd_buf,INT32at_cmd_len);

Description:ThisfunctionparsesATcommandfromtheUartport.Itclassifiesthecommandsandcallrespective

functionstoparsethecommands.



Paramters：

[IN]：cmd_buf     ‐‐‐‐PointertoATcommandbuffer

[IN]：at_cmd_len   ‐‐‐‐LengthoftheATcommand.

ReturnValues：Returnnegativeiferroroccurs.Returnzero,otherwise.

Remarks：Thecommandheader“AT#”isremovedbeforeenteringthisfunction.



z INT32IoT_exec_ATcommand_uart(PUCHARcmd_buf,INT32at_cmd_len)

Description：ThisfunctionparsesuartATcommand.



Paramters：

[IN]：cmd_buf‐‐‐‐PointertouartATcommandbuffer

[IN]：at_cmd_len‐‐‐‐LengthoftheuartATcommand.

ReturnValue：Returnnegativeiferroroccurs.Returnzero,otherwise.

Remark：None.



z INT32IoT_exec_ATcommand_netmode(PUCHARcmd_buf,INT32at_cmd_len)

Description：ThisfunctionparsesnetmodeATcommand.



Paramters：

[IN]：cmd_buf‐‐‐‐PointertonetmodeATcommandbuffer

[IN]：at_cmd_len‐‐‐‐LengthofthenetmodeATcommand.

ReturnValue：Returnnegativeiferroroccurs.Returnzero,otherwise.

Remark： None.





Mediatek Confidential

9.3 HowtoaddanewATcommand

1) Addanewelse/ifbranchforthenewATcommandtypeinthefunctionIoT_parse_ATcommand.



2)Addanewparsingfunctionforthenewtype.IoT_exec_ATcommand_netmodecanbeatemplate.



10 DATACOMMAND

10.1 Flowchart:







  



Mediatek Confidential

10.2 FunctionDescription

z INT32IoT_proc_app_packet(UCHARsock_num,PUCHARpacket,UINT16rawpacketlength);

Description:Thisfunctionparsescontrolprotocolpacketintheapplicationlayer.

Itremovesprotocolheaderandcallrespectivefunctionstoparsethedataheaderanddatacontent.



Parameters

[OUT]:sock_num‐‐‐‐socketnumberofthecurrentTCP/UDPtransmission

[OUT]:packet‐‐‐‐Pointertoprotocolheader

[OUT]:rawpacketlength  ‐‐‐‐Lengthofthepacket

ReturnValue:Returnzero.

Remark:sock_numisusedtodistinguishdifferentTCP/UDPtransmission



z INT32IoT_proc_app_func_pkt(DataHeader*DataHeader,UINT16FuncType,

IoTPacketInfo*PacketInfo);

Description:Thisfunctionparsescontrolprotocolpacketofthefunctiontype.



Parameters

[OUT]:DataHeader‐‐‐‐Pointertodataheader

[OUT]:FuncType‐‐‐‐thefunctioncommandtype

[OUT]:PacketInfo‐‐‐‐packetinformationthatisusedwhensendingtheresponse.

ReturnValue:Returnzero.

Remark:None.



z INT32IoT_proc_app_mgt_pkt(DataHeader*Dataheader,UINT16MgtType,

IoTPacketInfo*PacketInfo);

Description:Thisfunctionparsescontrolprotocolpacketofthemanagementtype.



Parameters

[OUT]:Dataheader       ‐‐‐‐Pointertodataheader

[OUT]:MgtType          ‐‐‐‐themanagementcommandtype

[OUT]:PacketInfo         ‐‐‐‐packetinformationthatisusedwhensendingtheresponse.

ReturnValue:Returnzero.

Remark:None.



10.3 HowtoaddanewDatacommand

1. functionrelatedcommand

1)Addnewcommandinthestructuret_FunctionCommand.

2)Addanewselect/casebranchinthefunctionIoT_proc_app_func_pkt



2. managementrelatedcommand

1)Addnewcommandinthestructuret_ManagementCommand.

2)Addanewselect/casebranchinthefunctionIoT_proc_app_mgt_pkt



3. commandofotherclass

1)Addnewtypeinthestructuret_CommandType.

2)Addnewparsingfunctionforthenewtype.IoT_proc_app_func_pktcanbeatemplate.

Mediatek Confidential

3)AddanewtypeanditsparsingfunctioninthefunctionIoT_proc_app_pkt

11 WIFIMACAPIS

11.1 RxFilterControl

z UINT16IoT_Get_RxFilter(VOID)

Description:GetRxfilteraboutframereceive

ParametersNone

Returnvalue：Rxfiltervalue,thedefinitionofthesettingasblowtable





z UINT16IoT_Set_RxFilter(UINT16Value)

Description:SetRxfilteraboutframereceive

Parameters

[IN]：Value     ‐‐‐‐TheRxFiltervalue,thesettingsreferstoabovetable

Returnvalue：thevalueactuallywritetoRxFilter,itshouldsameasInputParameter



Notes:whenbit5=1,bothBC/MCpacketshallbedropped,evenifbit6=0.



Notes:RxFiltershallberesetto0x7f97whenWifiStateChangebyfunctionwifi_state_chg()



11.2 MACControl

z IoT_Cmd_Set_Channel(UINT8Channel)

Description:switchCurrentChannel

Parameters

[IN]：Channel‐‐‐‐Thenewchannelshallbeswitchedto,ChannelRange[1~14]

Returnvalue：None



z INTAsicSetChannel(UCHARch,UCHARbw,UCHARext_ch)

Description:switchCurrentChannel,bandwidthandchannelsetting

Parameters

[IN]：ch,Channelnumber,      ‐‐‐‐   [1~14]if'bw'isBW_40,'ch'isCenterchannel

[IN]：bw,Bandwidth‐‐‐‐   [BW_20,BW40]

Mediatek Confidential

[IN]：ext_ch,11nbandwidthsetting   ‐‐‐‐   [EXTCHA_NONE,EXTCHA_ABOVE,EXTCHA_BELOW]

Returnvalue：0



Remark: 

if'bw'=BW_20,'ext_ch'shouldbeEXTCHA_NONEorEXTCHA_ABOVE,thesetwooptionshavethesameeffect

forBW_20.

if'bw'=BW_20,'ext_ch'shouldnotbeEXTCHA_BELOW



Example:

AsicSetChannel(8,BW_40,EXTCHA_ABOVE)

Itmeans:7681willchangetoCenterchannel8,andbandwidth40with40MHzabovemode

Inthiscase,primarychannelis6



Ifyourwanttoscanallprimarychannels[1~13]in802.11nmode,itispossibletostartscanwiththebelowinputs

AsicSetChannel(n,BW_40,EXTCHA_ABOVE)    ‐‐‐‐n=[3~11]

AsicSetChannel(m,BW_40,EXTCHA_BELOW)   ‐‐‐‐m=[8‐11]







z INTrtmp_bbp_set_bw(UINT8bw)

Description:switchCurrentBandwidth

Parameters

[IN]：bw‐‐‐‐Thenewbandwidthshallbeswitchedto,bandwidthRange[0:BW20,1:BW40]

Returnvalue：AlwaysTRUE

Mediatek Confidential



z BOOLEANSTARxDoneInterruptHandle(pBD_tpBufDesc)

Description:WifiMACRxpackethandler

Parameters

[IN]：pBufDesc‐‐‐‐ThereceivedRxdescriptor,includeRxMACcontentandRxInfo

Returnvalue：FALSEiftheRxpacketisinvalid,TRUEiftheRxpacketisvalid



z VOIDmt76xx_dev_send(void)

Description:SenduipTxpacket

ParametersNone

Returnvalue：None

Notes:Thisfunctionwillcopydatafrom“uip_buf”toTxDescriptorandsendittowireless



z INT32IoT_send_udp_directly(uip_ipaddr_t*DstAddr,

PUCHARDstMAC,

UINT16SrcPort,

UINT16DstPort,

PUCHARpPayload

UINT16PayloadLen)

Description:ThisfunctionisusedtosendpacketwithUDPformatdirectly

Parameters

[IN]：DstAddr        ‐‐‐‐ThepointerofdestinationIPaddress

[IN]：DstMAC        ‐‐‐‐ThepointerofdestinationMACaddress

[IN]：SrcPort         ‐‐‐‐Theudpportofsource

[IN]：DstPort         ‐‐‐‐Theudpportofdestination

[IN]：pPayload        ‐‐‐‐Thepointerofpayloadwhichshallbesendtodestination

[IN]：PayloadLen      ‐‐‐‐Thelengthofpayloadwhichshallbesendtodestination



Returnvalue：0=successful,1=inputparameterisinvalid2=allocatefreequeuebufferfail



12 SECURITYAPIS

z VOIDRT_AES_Decrypt(UINT8CipherBlock[].UINTCipherBlockSize,UINT8Key[],

UINTKeyLen,UINT8PlainBlock[],UINT*PlainBlockSize);

Description:ThisfunctionisusedtodecryptdatawithAESalgorithm

Parameters

[IN]：CipherBlock[]‐‐‐‐Theblockofciphertext,16Bytes(128bit)eachblock

[IN]：CipherBlockSize    ‐‐‐‐Thelengthofblockofciphertextinbytes

[IN]：Key[]‐‐‐‐Cipherkey,itmaybe16,24or32bytes

[IN]：KeyLen‐‐‐‐Thelengthcipherkeyinbytes

[IN]:PlanBlockSize     ‐‐‐‐  Thelengthofallocatedplainblockinbytes



[OUT]:PlanBlock[]      ‐‐‐‐  Plainblocktostoreplaintext

[OUT]:PlanBlockSize    ‐‐‐‐  Thelengthofrealusedplainblockinbytes

Returnvalue：None



z VOIDRT_AES_Encrypt(UINT8PlainBlock[],UINT*PlainBlockSize,UINT8Key[],

Mediatek Confidential

UINTKeyLen,UINT8CipherBlock[].UINTCipherBlockSize);

Description:ThisfunctionisusedtoDecryptdatawithAESalgorithm

Parameters

[IN]:PlanBlock[]‐‐‐‐TheblockofPlaintext,16bytes(128bit)eachblock

[IN]:PlanBlockSize     ‐‐‐‐  Thelengthofblockofplaintextinbytes

[IN]：Key[]‐‐‐‐Cipherkey,itmaybe16,24or32bytes

[IN]：KeyLen‐‐‐‐Thelengthcipherkeyinbytes

[IN]：CipherBlockSize    ‐‐‐‐Thelengthofallocatedcipherblockinbytes



[OUT]：CipherBlock[]‐‐‐‐ciptertext

[OUT]：CipherBlockSize‐‐‐‐Thelengthofrealusedcipherblockinbytes

Returnvalue：None



RT_AES_Decrypt(),RT_AES_Encrypt()areonly16Bytesinput16BytesoutputforPlainBlockandCipherBlock

Therearesomesamplecodesiniot_aes_pub.c,theentryofAESECB,CBCsamplecodeisAES_Sample()



z INT32RtmpPasswordHash(PSTRINGpassword,PUCHARssid,INT32ssid_lenPUCHARoutput);

Description:ThisfunctionisusedtocalculatethePMK

Parameters

[IN]:password          ‐‐‐‐  ASCLLstringupto63charactersinlength

[IN]:ssid               ‐‐‐‐  octectstringupto32octects

[IN]：ssid_len            ‐‐‐‐  lengthofssidinoctects

[OUT]：output‐‐‐‐  mustbe40octectsinlengthand0~32octects(256bits)isthekey

Returnvalue：None



z VOID__romtextRT_MD5(constUINT8Message[],UINTMessageLen,UINT8DigestMessage[])

Description:MD5algorithm

Parameters

[IN]：message           ‐‐‐‐  Messagecontext

[IN]：messageLen‐‐‐‐  Thelengthofmessageinbytes

[OUT]：digestMessage‐‐‐‐Digestmessage



ReturnValue:None

 



z VOID__romtextRT_MD5_Init(MD5_CTX_STRUC*pMD5_CTX)

Description:InitialMd5_CTX_STRUC

Parameters

[IN]：pMD5_CTXPointertoMd5_CTX_STRUC



Mediatek Confidential

ReturnValue:None



z VOID__romtextRT_MD5_Append(MD5_CTX_STRUC*pMD5_CTX,

constUINT8Message[],

UINTMessageLen)

Description:Themessageisappendedtoblock.Ifblocksize>64bytes,theMD5_Hashwillbecalled.

Parameters:

pMD5_CTXPointertoMD5_CTX_STRUC

MessageMessagecontext

MessageLenThelengthofmessageinbytes



ReturnValue:None



z VOID__romtextRT_MD5_End(MD5_CTX_STRUC*pMD5_CTX,UINT8DigestMessage[])

Description:

1.Appendbit1toendofthemessage

2.Appendthelengthofmessageinrightmost64bits

3.TransformtheHashValuetodigestmessage

Parameters

[IN]pMD5_CTXPointertoMD5_CTX_STRUC

[OUT]digestMessageDigestmessage

ReturnValue:None



13 TIMERAPIS

13.1 SWTimerAPIs.

z VOIDcnmTimerInitTimer(INP_TIMER_TprTimer,

INPFN_MGMT_TIMEOUT_FUNCpfFunc,

INUINT_32u4Data

INUINT_32u4Data2)

Description:Thisfunctionisusedtoinitializeatimer

Parameters

[IN]：prTimer       ‐‐‐‐Pointertoatimerstructure

[IN]：pfFunc        ‐‐‐‐Pointertothecallbackfunction

[IN]：u4Data        ‐‐‐‐parameterforcallbackfunction

[IN]：u4Data2       ‐‐‐‐parameterforcallbackfunction

Returnvalue：None



z VOIDcnmTimerStartTimer(INP_TIMER_TprTimer,INUINT_32u4TimeoutMs)

Description:Thisfunctionisusedtostartatimer

Parameters

[IN]：prTimer       ‐‐‐‐Pointertoatimerstructure

[IN]：u4TimeoutMs  ‐‐‐‐Timeouttoissuethetimerandcallbackfunction(unit:ms)

Returnvalue：None



z VOIDcnmTimerStopTimer(INP_TIMER_TprTimer)

Description:Thisfunctionisusedtostopatimer

Mediatek Confidential

Parameters

[IN]：prTimer       ‐‐‐‐Pointertoatimerstructure

Returnvalue：None



ThereisaexampleonIoT_customer.c



z UINT32GetMsTimer(VOID)

Description:Getthetimefromsystemstart(Unit:1ms)

Parameters

Returnvalue：thecountervalue

13.2 HWtimer1interruptfunction

TheFrequencyforhardwaretimer1interrupt,Range[1~10]

#defineTICK_HZ_HWTIMER110/*T=1/TICK_HZ_HWTIEMR1*/



Aboveexample:IoT_Cust_HW_Timer1_Hdlrwillbetriggeredevery100ms(ThatisT=1/10)



14 INTERFAEAPIS

14.1 FlashDriver

z voidspi_flash_erase_SE(uint32address)

Description:Thisfunctionisusedtoerasethesectorinwhichtheaddressspecifies.

Parameters

[IN]：addr‐‐‐‐theaddressinflashtobeerased

Returnvalue:None



z voidspi_flash_erase_BE(uint32address)

Description:Thisfunctionisusedtoerasetheblockinwhichtheaddressspecifies.

Parameters

[IN]：addr‐‐‐‐theaddressinflashtobeerased

Returnvalue:None

Note:

1.Duetothecharacteristicofflash,erasethesector/blockwheredataistobewrittenismandatorybeforewrite

anythingtoflash.

2.Thesizeofsector/blockofoneflashisdifferent.Pleasecheckthedatasheetofusingflash.

Mediatek Confidential

3.abovetwoAPIswilleraseasectororablock,pleaseconsideriftherearesomedatashouldnotbeerasedinone

sector/blockbeforeusingthosetwoAPIs

.

z int32spi_flash_read(uint32addr,uint8*data,uint16len)

Description:Thisfunctionisusedtoreadspecifieddatafromflash

Parameters

[IN]：addr‐‐‐‐Theoffsetwhichthereadingdatastoredontheflash

[IN]：len‐‐‐‐Thedatalengthneedtoread

[OUT]：data    ‐‐‐‐Thepointerindicatethereadingdata

Returnvalue：0meanssuccessful,non‐zeromeansfail



z int32spi_flash_read_m2(uint32addr,uint8*data,uint16len)

Description:ThisfunctionisusedtoreadspecifieddatafromflashwithSPIcommandmethod

Thefunctionhasthesameeffectwithspi_flash_read()



z int32spi_flash_write_func(uint32addr,uint8*data,uint16len)

Description:Thisfunctionisusedtowritespecifieddatatoflash

Parameters

[IN]：addr‐‐‐‐Theoffsetwhichthedatawillbewriteontheflash

[IN]：len‐‐‐‐Thedatalengthneedtowrite

[IN]：data‐‐‐‐Thepointerindicatethewritingdata

Returnvalue:0meanssuccessful,non‐zeromeansfail

Notes：ThisAPIwillwritedatatoflashoffset“addr”directly,

Iftheflashsectorwhichthe“addr”belongstoisnotbeerasedfirst,ThisAPIwillwritedatatoflashunsuccessful



z int32spi_flash_write(uint32addr,uint8*data,uint16len)

Description:Thisfunctionisusedtowritespecifieddatatoflash

Parameters

[IN]：addr‐‐‐‐Theoffsetwhichthedatawillbewriteontheflash

[IN]：len‐‐‐‐Thedatalengthneedtowrite

[IN]：data‐‐‐‐Thepointerindicatethewritingdata

Returnvalue:0meanssuccessful,non‐zeromeansfail

Notes：AstheRAMlimitation,thelenmust<=FLASH_OFFESET_WRITE_BUF(4KB)

ThisAPIwilleraseSectorfirstthenÆstoreoriginaldataÆmergethemodifieddataÆwritebacktosector

Thus,1:ifyouwanttowritesomedatatoflash,pleasedonotcallspi_flash_erase_SE()orspi_flash_erase_BE()to

eraseflashagain,butjustcallspi_flash_write().

2:AsthisAPIwillerasesector,thus,needavoidcallingthisAPIwithHighFrequency

Mediatek Confidential

 



SPICommanddescription





14.2 UART

z INT32IoT_uart_input(UINT_8*msg,INT32count);

Description:Thisfunctionreadsagivenlengthofdatafromtheuartport.

Parameters

[IN]：msg  ‐‐‐‐Pointertoauartrxbuffer

[OUT]：count‐‐‐‐  Lengthofdatatoread

ReturnValue：Returnzero.

Remark：None.



z INT32IoT_uart_output(UINT_8*msg,INT32count);

Description：Thisfunctionwritesagivenlengthofdatatotheuartport.

Parameters

[OUT]：msg    ‐‐‐‐  Pointertoauarttxbuffer

[OUT]：count   ‐‐‐‐  Lengthofdatatowrite

ReturnValue：Returnzero.

Mediatek Confidential

Remark：None.



14.3 LED/PWM

z INT32IoT_led_pwm(INT32led_num,INT32brightness);

Description：Thisfunctionconfiguresthebrightnessofaled.

Parameters

[OUT]：led_num    ‐‐‐‐Inhardwarepwmmode,led_numisledcontrollernumber,range(1~3)..

[Ex:Led_num=1,usePin26asLed/PWM

Led_num=2,usepin31asLed/PWM

Led_num=3,usepin30asLed/PWM]

Insoftwarepwmmode,led_numisgpionumber,range(0~4).

[Ex:Led_num=0,usePin31asLed/PWM

Led_num=1,usepin30asLed/PWM

Led_num=2,usepin29asLed/PWM

Led_num=3,usepin28asLed/PWM

Led_num=4,usepin27asLed/PWM]



[OUT]：brightness   ‐‐‐Brightnesslevelofled.

Inhardwarepwmmode,range(0~5)

Insoftwarepwmmode,range(0~20).



ReturnValue:Return‐1ifled_numisinvalid.Return0,otherwise.

Remark

1) Twopwmmodeissupported.

IfIOT_PWM_TYPE==1,hardwarepwmmodeisused.

IfIOT_PWM_TYPE==2(defaulttype),softwarepwmmodeisused.

2) Level0isoff.Level5isthebrightestinhardwarepwmmode.

Level0isoff.Level20isthebrightestinsoftwarepwmmode.

3) SoftwarepwmmodeconsumesmoreCPUresources.

However,ithashighfrequencyandmorebrightnesslevels.

4) InHardwarePWMmode,

ifyouwanttocancelPWMmodeforpin26,31,30andsetthemasGPIOmode

needcallIoT_gpio_output(5,0),IoT_gpio_output(0,0),IoT_gpio_output(1,0)

ThepinandGPIOrelationship,pleaserefertosection:“GPIO/PinModeSet”



z VOIDIoT_software_pwm_addset(INT32led_num,INT32brightness)

Description：Thisfunctionconfiguresagpiopintosoftwarepwmmodeandsetthebrightnesslevel.

ItabsolutesameasIoT_led_pwm()insoftPWMmode

Parameters

[OUT]：led_num    ‐‐‐‐Specifythegpionumberwhichistobeconfiguredtosoftwarepwmmode.

Shouldberangedfrom0to4

[OUT]：brightness   ‐‐‐Brightnesslevelofled.

AvailableonlyInsoftwarepwmmode,shouldberangedfrom0to20.

ReturnValue:Return‐1ifled_numisinvalid.Return0,otherwise.

Remark

1)ThisAPIisavailable.onlyifsoftwarepwmmodeisused

2)Level0isoff.Level20isthebrightestinsoftwarepwmmode.

Mediatek Confidential



z INT32IoT_software_pwm_del(INT32led_num)

Description：Thisfunctionchangesagpiopinfromsoftwarepwmmodebacktogpiomode

Parameters

[OUT]：led_num    ‐‐‐‐Specifythegpionumberwhichistobechanged.Shouldberangedfrom0to4



ReturnValue:Return‐1ifled_numisinvalid.Return0,otherwise.

Remark

1)ThisAPIisavailable.onlyifsoftwarepwmmodeisused



14.4 GPIO

z INT32IoT_gpio_read(INT32gpio_num,UINT8*pVal,UINT8*pPolarity);

Description：ThisfunctionsettheGPIOasinputmode,andreadit’sinputvalue

Parameters

[IN]:gpio_num‐‐‐‐Specifythegpionumber.Shouldberangedfrom0to6.

[OUT]:pPolarity  ‐‐‐‐readthegpiopolarity,0=OutputMode,1=InputMode

[OUT]:pVal     ‐‐‐‐readthegpiostatus,0=low,1=High



ReturnValue:none

Remarks:

TheGPIO/PinModeSetpleaserefertosection:“GPIO/PinModeSet”



WecansetonespecificGPIO’smode/valueatonetimewithfollowingAPIs

z INT32IoT_gpio_input(INT32gpio_num,UINT32*input);

Description：ThisfunctionsettheGPIOasinputmode,andreadit’sinputvalue

Parameters

[IN]:gpio_num   ‐‐‐‐Specifythegpionumber.Shouldberangedfrom0to6

[OUT]:input   ‐‐‐‐theinputstatusofthegivengpionumber.0islow.1ishigh.

ReturnValue:Return‐1ifgpio_numisinvalid.

Return‐2ifinputisinvalid.

Returnzero,Otherwise.

Remarks:

TheGPIO/PinModeSetpleaserefertosection:“GPIO/PinModeSet”



z INT32IoT_gpio_output(INT32gpio_num,INT32output);

Description:Thisfunctionconfigurestheoutputstatusofagpio.

Parameters

[IN]:gpio_num   ‐‐‐‐Specifythegpionumber.Shouldberangedfrom0to6

[OUT]:output      ‐‐‐‐theoutputstatusofthegivengpionumber.0islow.1ishigh.

ReturnValues:Return‐1ifgpio_numisinvalid.Return‐2ifoutputisinvalid.Return0,otherwise.

Remarks:

TheGPIO/PinModeSetpleaserefertosection:“GPIO/PinModeSet”



WecansetseveralGPIOsmode/valueatonetimewithfollowingAPIs

z INT32IoT_gpio_batch_modify_mode(INT32output_bitmap);

Description:Thisfunctionconfiguresabatchofgpiopinstooutputmode

Parameters

Mediatek Confidential

[OUT]:output_bitmap  ‐‐‐‐Specifythegpiooutputmodebitmap.

Bit(i)standsforgpio(i).Shouldberangedfrom00000Bto11111B

ReturnValues:Return0

Remarks:

1.TheGPIO/PinModeSetpleaserefertosection:“GPIO/PinModeSet”

2.Ifoutput_bitmapis10001B,gpio0andgpio4willbesettooutputmode





z INT32IoT_gpio_batch_modify_output_value(INT32output_bitmap,INT32value_bitmap);

Description:Thisfunctionconfiguresabatchofgpiopinstooutputhigh.

Parameters

[OUT]:output_bitmap‐‐‐‐Specifythegpiooutputmodebitmap.

Bit(i)standsforgpio(i).Shouldberangedfrom00000Bto11111B.

[OUT]:value_bitmap  ‐‐‐‐Specifythegpiooutputstatusbitmap.

Bit(i)standsforgpio(i).Shouldberangedfrom00000Bto11111B.

ReturnValues:Return0

Remarks:

1.TheGPIO/PinModeSetpleaserefertosection:“GPIO/PinModeSet”

2.Thisfunctiondoesnotchangegpiopinstooutputmode.Itmodifiestheoutputvalueonly

3.Ifoutput_bitmapis10001B,andvalue_bitmapis10000B,

gpio0willbesettolow,andgpio4willbesettohigh







z UINT8IoT_Cust_Set_GPIINT_MODE(INUINT8GPIO_Num,INUINT8Val)

Description:SetGPIOinterruptmode

Parameters

[IN]:GPIO_Num‐‐‐‐[0~6].

[IN]:Val‐‐‐‐[0~4]

0:notrigger,1:fallingedgetrigger

2:risingedgetrigger3:bothfallingadnrisingedgetrigger

ReturnValues:0‐Success,1‐invalidinput



z UINT8IoT_Cust_Get_GPIINT_MODE(OUTUINT16*pGPI_INT_MODE)

Description:SetGPIOinterruptmode

Mediatek Confidential

Parameters

[OUT]:GPI_STS

[1:0]:GPIO1Interruptmode

[3:2]:GPIO0Interruptmode

[5:4]:GPIO2Interruptmode

[7:6]:GPIO3Interruptmode

[9:8]:GPIO4Interruptmode

[11:10]:GPIO5Interruptmode

[13:12]:GPIO6Interruptmode

ForeachGPIO'sinterruptmode

0:notrigger,1:fallingedgetrigger

2:risingedgetrigger3:bothfallingadnrisingedgetrigger

ReturnValues:None



z VOIDIoT_Cust_GPIINT_Hdlr(INUINT8GPI_STS);

Description:ThisHandlershallbecalledasanyGPIOInterrputbetriggered

Parameters

[IN]:GPIO_Num‐‐‐‐[0~6].GPIO0~6Interruptstatus

ReturnValues:0‐Success,1‐invalidinput





14.5 GPIO/PinModeSet

Current,WeuseIOT_PWM_TYPE=2,TheGPIOlistasbelow:

IOT_PWM_TYPE

CHIPPin01

(HWPWMMode)

2

(SWPWMMode)

Pin31GPIO0PWM2GPIO0/PWM1

Pin30GPIO1PWM3GPIO1/PWM2

Pin29GPIO2GPIO2GPIO2/PWM3

Pin28GPIO3GPIO3GPIO3/PWM4

Pin27 GPIO4GPIO4GPIO4/PWM5

Pin26 UartTxPWM1/UartTx UartTx

Pin25 UartRxUartRxUartRx

Remark PWM:20Hz,Level(0~5)

Level0=off

Level5=brightest

PWM:50Hz,Level(0~20)

Level0=off

Level20=brightest





















Mediatek Confidential













15 FLASHPARTITIONS





Mediatek Confidential







Mediatek Confidential



Note:1.AsthelimitationofRAMsize,whiledoflashread/writeatatime,

only256BofdatacanbereadfromFLASHtoRAM,(useIoTpAd.flash_rw_buf[256])

Thenrewritethedatatocorrespondingplaceafterbeingmodified.



16 COMPILERSETUP

PleaserefertodescriptionontheAndesweb

http://forum.andestech.com/viewtopic.php?f=23&t=576&p=672

http://forum.andestech.com/viewtopic.php?f=23&t=587

Mediatek Confidential



17 ATCOMMANDUSAGE

17.1 Displayversion

Command:Ver

ArgumentDescriptions:None

Example:AT#Ver+enter

17.2 Rebootthesystem

Command:Reboot

ArgumentDescriptions:None

Example:AT#Reboot+enter

17.3 SetDefault

Command:Default

ArgumentDescriptions:‐s<channelnumber>

Example:AT#Default+enter



17.4 Switchchannel

Command:Channel

ArgumentDescriptions:‐b<Bandwidth>(0forBW_20,1forBW_40)

‐c<channelnumber>(1~14)

Example:AT#Channel‐b0‐c6+enter

Remarks:whenset1to‐b,the‐cmeanscentralchannelforBW40

17.5 ConfigureUARTinterface

Command:Uart

ArgumentDescriptions:

‐b<baudrate>(57600,115200,230400,…)

‐w<databits>(5,6,7,8)

‐p<parity>(0fornoparity,1forodd,2foreven)

‐s<stopbits>(1for1bit,2for2bits,3for1.5bits)

Example:AT#Uart‐b57600‐w7‐p1‐s1+enter

Remarks:dlr=round(systemclock/(16*baudrate),0)

actualbaudrate=systemclock/(16*dlr)

Youcanfindmoresupportedbaudrateforyoursystemaccordingtheformulaandexperiment

17.6 UpdateFirmwarefromUart

Command:UpdateFW

ArgumentDescriptions:‐t<flashareatype>

Example:AT#UpdateFW+enter

Remarks:shouldbeenabledonRecoverymode,X‐modemshallbestartupafterimplementthiscommand

17.7 EnterintoSmartConnectionState

Command:Smnt

ArgumentDescriptions:

Mediatek Confidential

Example:AT#Smnt+enter

Remarks:whenthiscmdbeinputto7681,7681needchangestatemachinetoSmntstate,andstarttolisten

packetintheairtodosmartconnection

17.8 EnterintoDeepsleepmode

Command:PowerSaving

ArgumentDescriptions:

‐l<PowerSavingLevel>(1~5)

‐t<PowerSleepTime>(0~0xFFFFFF(unit::us))

‐r<readPowerSavingLevel>

Example:AT#PowerSaving‐l1‐t0xFFFFFF+enter

AT#PowerSaving‐r<Space>+enter

Remarks:7681willgotosleepwhengetcmd”AT#PowerSaving‐l1‐t0xFFFFFF”,andawakeafter0xFFFFFF(us)

(ThePowerSavingmodeisalsoinimproving,soturnthisCmdoffbydefaulttemporary,ifcustomerwanttotest

powersavinginpresent,theycanturnthisCmdoninMT7681_sta.mk)

Mediatek Confidential