Home

M16C/6S DATA LINK LAYER LIBRARY D2DLL USER`S MANUAL

1. 7 32253 hop icale eonun ir re Eiern n i rii rea tear 7 3 2 1 4 Fragmentation and Reassembly 0ooccccccccnnnononnncnnnonananano 8 3 2 1 5 Transmission tate wai iiri ndi aeri ir ca Fer tea ERE e AB ER ana CREE coded snes na FR 8 3 2 2 Lo Ju 8 3 2 2 1 Network Node D aieo tnn e de itio ta io n ne un deat dena aoa lana aaa daa 8 3 2 2 2 Device Serial Number DSN dais 9 3 2 2 3 Port ID Application registration eese nennen enne nnne nnn nnns 9 3 224 Protocol number ierit tied reir nier 9 3 2 3 Media Access Control e er e dede a bae Rea e venae tios 9 3 2 4 Virtual Jamming Imposter node detection feature esee een 9 327 EEBROM Control features PR RE Re d gene 10 4 APLOVERVIEW as 11 4 1 Initialization and termination function 1 11 42 Transmission function APT 12 4 3 Reception function APL dd is 13 44 EEPROM access ien di 15 45 Parameter Control AP naci a
2. 46 7592 ON 51 7 3 1 Influence of the D2DL task and its interrupt process on the user 51 7 3 2 Notes om thesinterrupt 51 7 3 3 Notes on the debut oeri r i Ee rtr kn dera RE 51 7 3 4 Notes on the m lti task Ad 51 8 Description of the example program iinis nene n 53 A MEE uu P 53 8 2 Generalflowchart NO 53 8 5 Details of the eee erede ve enn n Ue E 54 8 3 1 Main function WorkerThread sese 54 BBL Flowchart 54 831 2 Details of the functiOn E mae entente rx 54 8 3 2 UserA pplication MOCHON eiie EATEN ES MATERNO CE ERR 56 8 321 IO IIR CE 56 8 322 of he ci 57 8 3 3 Tt User Send function s ess au e 58 8 3 2 1 eget ERN ER E E ERE RUE UR 58 8 3 3 2 Details Of the FUNCION nem pee AAA RdA E de 58 8 3 4 User SendResult CB function merece srra 59 834 1 Delto the TU
3. Rus tk cru Fai 59 8 3 5 It User function ete ad A a OY RR 60 REOS ME ETC Et 60 8 3 5 2 Details of 60 8 3 6 User Receive CB nana nanir cnn ae nara nana nar da assa dada aa aa aane da 61 8 3 6 1 Details of the f nctiOn ciiin merger Fan AER en RASA add tees 61 8 3 7 CB RXDEDOon f fction tien ad a 61 833 721 61 8 3 8 D2DEE CB RXLEDoOoff function 61 8 3 8 1 Details of the function iieri iaa cn 61 9 Development environment 2 ceca tait int n nter aaa 62 91 Development for using the simple debugger 0 62 9 2 Development for using the emulator debugger PD30F 63 D2DL USER S MANUAL 1 Introduction This document is the User s Manual of communication interface library hereafter called the D2DL for Renesas Technology s PLC Power Line Communication microcomputer M16C 6S The D2DL achieves the function of the Physical Layer the first layer and the Data Link Layer the second layer in the OSI network reference model This document provides the necessary information which helps you understand and use the D2DL From section 1 to 3 it describes the D2DL overview and the basic information After section
4. 14 name _sl 47 D2DL USER S MANUAL semaphore The definition of the semaphore name _52 for the D2DL initial count xg Do not change the configuration y and the order semaphore name 53 kell xxi y semaphore name 54 aleacion semaphore name MATS initial count Ex Alp semaphore name _s6 alcala COUINE 106 semaphore name SES EN Corine semaphore name _s8 0 Gouin semaphore name 89 21 Aa ip semaphore name 810 ua JLp semaphore name gun al 106 semaphore name A semaphore name _s13 aliubi aer GOVE ES dE semaphore name 514 Ex dle semaphore 14 user me name uartTx lock The definition of the semaphore for the initial count Eds user application Please make sure to define after the D2DL semaphore definition 48 D2DL USER S MANUAL Interrupt Handler interrupt vector 8 81 04 entry address DZCULIL ayi JUS ISIN 0 2 os_int YES interrupt 18 UARTO Rx user entry address _DebugPort_ReadByte_a30 os_int YES y interrupt_vector 2114 Qu M entry a
5. 18 Is time E 7 2 1 4 The example of using the callback function There are two methods to pass the transmission and reception result to the user task by using the callback function By using the MR30 functions The callback function passes the transmission and reception result on to the user task which is waiting for the indication by using the task feature sleep and wake up mail feature waiting the reception and the transmission or event flag feature wait and set the flag The following example uses the task operation sleep and wake up The sleep task feature can be replaced by the mail reception feature or the waiting for the event flag and the wake up task feature can be replaced by the mail transmission feature or setting the event flag User task process void UserTaskl void errStatus D2DLL Send amp sndParam Transmission request using the callback function E if errStatus D2DLL E OK wait CB slp tsk Waiting for the indication of the callback function _ Check the result of the callback function if sendStatus D2DLL 39 D2DL USER S MANUAL Callback function process void SendResult CB uintl6 sessionTag sint16 sndResult sendStatus sndResult Get the transmission result wup_tsk ID_UserTask1 Wakeup the user task By using the global variable The
6. 9 Development environment 9 1 Development for using the simple debugger KD30 The following shows a list of essential item to develop the user application using the simple debugger KD30 Item Name Description Recommended Ver No C Compiler Package M3T NC30WA This package includes the C compiler assembler and linker Ver 5 30 Release 02 Or Ver 5 40 Release 00 High performance Embedded Workshop HEW The D2DL example program is provided as HEW project environment The development based on this program is recommended The HEW is included in the NC30WA package Ver 4 Simple Debugger KD30 It communicates with the monitor program on the chip so provides the debug environment on PC You can download it from the RENESAS web site for free Monitor program for 16 65 This program is written in the chip for debug by KD30 Flash Programmer M3A 0806 The included cable Ten Nine cable is used for connecting for debug D2DL Library This product M16C 6S module This is the target board Note You can also use the M3A 0665 FoUSB for writing to the flash memory The development environment using the KD30 is shown as follows 62 D2DL USER S MANUAL 9 Development for using the emulator debugger PD30F The following shows a list of essential item to develop the user application using the simple debugger PD30 Item Name Description Recommended
7. High performance Embedded Workshop 2 20 Compartmentalization between the Single Task Edition and the Multi Task Edition The D2DL consists of the following three tasks Therefore the software is the Multi Task based program Work Task Itis the main process for PLC communication This task is invoked periodically Reception Task It processes the received PLC data Transmission Task It processes the transmitting PLC data from the user application To operate the three tasks mentioned above independently the RTOS is required If you use the RTOS you can get not only these communication processes but also your application program as Multi Task based program This means you can divide your application program into some tasks if you want However some users don t want to divide their application program into some tasks because they prefer Single Task based programming In the Single Task based programming the users only create one main loop some sub functions which is called from main loop and some interrupt service routines For such users providing RTOS is not welcome because it causes additional costs and time for the RTOS which is needed only for the D2DL This D2DL Single Task Edition is provided to solve this problem If you use D2DL Single Task Edition you do not need to get the RTOS because the edition includes the dedicated mini RTOS hereafter called MiniRTOS and you can program your application as Single Task b
8. sintl6 sndResult sendStatus sndResult Xp bIs SendFinished TRUE pi N Store the transmission result to sendStatus 2 Set the transmission complete flag bIs SendFinished to TRUE 59 D2DL USER S MANUAL 8 3 5 User recept function 8 3 5 1 Flowchart Output the initial message for reception Complete the reception Clear the reception complete flag Is the received data normal YES Count up the number of the received packets Is any key pressed YES Output the number of the received packets 8 3 5 2 Details of the function Static void It User recept void RxParam rx param uintl6 pren n uart buff uchar str 8 printf Counting Received Packet printf Enter any key to stop counting n n oW rx param m total cnt 0 while pren n uart buff 2 if bIs ReceiveFinished TRUE 3 bIs ReceiveFinished FALSE sae q if 0 CmpRcvDat TxData urbuf rcvBuffSize E if rcvBuffSize SNDLEN rx param m total 6 Main_pEventIpcRequest FALSE n_uart_buff 0 printf printf Sd Packets ReceivedYn rx_param m_total_cnt printf Output the initial message for reception Wait until any key is pressed 3 Check the reception complete flag bIs ReceiveFinished The reception complete flag bIs ReceiveFinished is set to
9. the function which is registered in each application is called back in case of the packet reception callback function However in case of the D2DLL function it cannot distribute the received packet to each destination application If you use the D2DLL Recv function in the multiple application environment please implement the assignment process for each application by checking the dstPortId destination port ID in the received data 7 2 1 3 Restrictions on using the reception function 38 D2DL USER S MANUAL When the user application receives the packet by the packet reception function D2DLL not the callback function the D2DLL_Recv function should be called at short intervals as the following Region Maximum call interval U S A FCC 50ms Japan ARIB 90ms Europe CENELEC A B 120ms The timeout interval which is set in the argument rcvTimeout of the D2DLL Recv function is not included in times shown above An example when timeout is one second is shown as below Please implement the following A interval not to exceed the maximum call interval which is shown in the table above The function exits The function exits The function exits The function exits y j by the packet by the timeout by the timeout reception by the timeout Calling the Calling the Calling the Calling the D2DLL Recv D2DLL Recv D2DLL Recv D2DLL Recv function function function function i gt 18
10. 2 gt gt LWORD SYS DMY INH svector11 In case of WDT interrupt Please set each interrupt function as the same as the following gray shaded lines lt lt 1 gt gt and lt lt 2 gt gt lt lt 1 gt gt Please define the interrupt function name to Interrupt Function Name is not necessary The is not necessary for the function name and please attach _ at top of the name lt lt 2 gt gt Please change the dummy function name __SYS_DMY_INH on line for vector 252 to the Interrupt Function Name is not necessary 29 D2DL USER S MANUAL 4 sal mr30 vector table A SECTION INTERRUPT VECTOR GLB 5 8 D2dll PhyUsartISR INTOS 8 EQU 1 GLB _D2dll_PhyRx_PhyUsartISR GLB Interrupt Function Name lt lt 1 gt gt LWORD SYS DMY INH vector250 LWORD SYS DMY INH vector251 LWORD Interrupt Function Name vector252 lt lt 2 gt gt LWORD SYS DMY INH vector253 6 2 3 Configuration of the D2DL Heap Area The D2DL area in thi uses RAM area for the transmission and reception packet buffer and other usages This area is called the heap s document The size of the heap area is configurable by the user and the allocation is as follows RAM Transmission and reception packet buffer Area only for D2DL Heap Area received packet Mapping data area for the transmissio
11. 6 3 1 Influence of the D2DL task and its interrupt process on the user application 33 6 32 MNotes on theinterr pt 22 id C Det od Eee ead deg tende 33 6 3 3 Notes on the debi Ee e HER P E ERE PUR 33 7 Development of the User Application Multi Task Edition eene 34 7 1 Example program organization esses rana rr 34 D2DL USER S MANUAL 42 Implementation method 35 7 2 1 Transmission and Reception Sequence 35 7 2 1 1 Getting the packet transmission 1 35 7 2 1 2 Getting the received packet tir aie Ia er ERR ae ERR Rer ORE 37 7 2 1 3 Restrictions on using the reception function nn nn cnn cnn rr nr cnn nana 38 7 2 1 4 The example of using the callback enm emen 39 7 2 1 5 Example of the action by the multiple user tasks eene 40 7 22 Addition of the Interrupt Handler enne 43 7 2 3 Configuration of the D2DLHeap Artaso ceneni iani ann a aai A 43 7 2 4 Modification of Configuration 1
12. 9 define ID 510 10 define ID 511 11 define ID 512 T2 define ID 513 13 50 D2DL USER S MANUAL define 514 14 Hereafter your semaphore IDs are defined gt gt 7 3 Notes 7 3 1 Influence of the D2DL task and its interrupt process on the user application During the main function Main_WorkerThread of the user application or the new interrupt functions which are added by the user is running the interrupt process for the D2DL may start up and then the tasks the D2DL library run circumstantially In this case the user application pauses and the process of the D2DL library starts to run The occurrence frequency of this D2DL interrupt process which includes the D2DL task process depends on the amount of the packets on the PLC 7 3 2 Notes on the interrupt If the processing time of the interrupt process of the user application meets one of the following conditions we recommend enabling the multiple interrupt which priority level is 3 or more If you do not enable it you may miss some packets Condition the processing time per one interrupt process of the user application is 100 us or more and its interrupt may occurs 2 4 ms interval or less Condition 2 the processing time of one interrupt process of the user application is longer than 500 us The interrupt processing time of the D2DL and its occurrence timing are as follows Trigger of the Function name Processing ti
13. A B 120ms The timeout interval which is set in the argument rcvTimeout of the D2DLL function 15 not included in times shown above example when timeout is one second is shown as below Please implement the following A interval not to exceed the maximum call interval which is shown in the table above The function exits The function exits The function exits The function exits by the packet by the timeout by the timeout reception by the timeout Calling the Calling the Calling the Calling the D2DLL D2DLL_Recv D2DLL_Recv D2DLL_Recv function function function function M 9 gt gt 15 15 18 time lt gt i 7 7 6 2 22 Addition of the Interrupt Handler The function for interrupt service routine can be written in C The method of addition is different between Watchdog Timer hereafter called WDT interrupt and others So please refer to the following Note that it is not available to use the D2DL API in the interrupt process function Addition of the interrupt process function Please declare the return value and the argument as void Do not declare as static Please describe the following at top of the file which defines the interrupt function 28 D2DL USER S MANUAL In case of interrupt excluding WDT asm MR IntEntry MACRO n ENDM pragma INTHANDLER Interrupt Function Name In case of
14. Packet 3 Packet 1 MM BE Packet 3 Hop count It doesn t send if it receives the packet 2 32 1 4 Fragmentation and Reassembly The D2DL implements a mechanism of fragmentation and reassembly The maximum D2DL payload is 110 bytes When the user application requests the transmission of a packet which size is above 110 bytes the D2DL fragments it and sends the fragmented data The D2DL in the receiving node reassembles the received fragmented packets and passes it on to the user application The D2DL supports 16 fragments of 110 bytes for a message length of 1760 bytes as a maximum of a long packet 3 2 1 5 Transmission rate The IT800PHY supports three transmission modes as follows Note In Europe it supports two modes N America and Europe regional Japanese regional settings settings Standard Mode SM 7 5Kbps Robust Mode RM 5 0Kbps 2 5Kbps Extremely Robust Mode ERM 1 25Kbps 0 625Kbps Additionally the D2DL has the data rate control algorithm which can monitor the communication status of each destination node and select optimal transmission mode automatically You can select the fixed three mode transmission mentioned above or the auto rate control mode transmission 3 2 22 Addressing 3 2 2 1 Network ID and Node ID The D2DL uses the network ID 10 bit and the node ID 11 bit for the address of each node for general communication The network ID is assigned to each logical
15. TRUE in the callback function because the User Receive CB function is NR 60 D2DL USER S MANUAL called when the D2DL finishes the reception The reception complete flag bIs ReceiveFinished is set to FALSE to clear it Verify the received data with the transmission data of this example program Count up the number of received packets Output the number of received packets UU 8 3 6 User Receive CB function 8 3 6 1 Details of the function This is a reception callback function It is called when the D2DL finishes the reception static void User Receive CB d2dll rcvParam rcvParam sintl16 i rcvBuffSize rcvParam rcvDataLen ges t data transfer for i 0 4 lt rovBuffSize i 4 2 urbuf i rcvParam gt rcvData i blIs ReceiveFinished TRUE 3 Store the size of the received packet in rcvBuffSize Copy the received packet to the buffer The reception complete flag bIs ReceiveFinished is set to TRUE 8 3 7 D2DLL RxLEDon function 8 3 7 1 Details of the function This function makes the LED on void D2DLL_CB_RxLEDon void PD8_1 1 aoe P8_1 1 fhe 1 Set the port 81 direction register output 2 Set the port 81 on 8 3 8 D2DLL_CB_RxLEDoff function 8 3 8 1 Details of the function This function makes the LED off void D2DLL CB RxLEDoff void P8_1 0 1 Set the port 81 off 61 D2DL USER S MANUAL
16. Vector The above gray shaded lines of the interrupt vector ID number in Figure 1 are the definition of the interrupt vector used in the D2DL Do not change all lines Please define the interrupt vector used in the user application with setting the vector number If it is the Watchdog Timer interrupt you should set NO to the OS dependent interrupt handler int and if it is the other interrupt you should set YES Please note that it is not available to call the D2DL API in the interrupt handler The configurator cfg30 makes id h with the configuration file The cfg30 is executed in the HEW Please verify the generated id h with the following define definition when you add the tasks event flags or semaphore for the user application id h description define ID Main WorkerThreadl1 define ID D2dll Work 2 define ID 2011 3 define ID D2dll Send 4 Hereafter your task IDs are defined gt gt define ID f1 1 define ID f2 2 define ID_ f3 3 define ID_ f4 4 define ID_ f5 5 define ID_ f6 6 define ID_ f7 7 lt lt Hereafter your flag IDs are defined gt gt define ID s1 1 define 52 2 define ID s3 3 define ID 54 4 define ID 55 5 define ID s6 6 define ID s7 7 define ID s8 8 define ID 59
17. WDT pragma INTERRUPT Interrupt Function Name Example of description for interrupt excluding WDT _asm __MR_IntEntry MACRO n ENDM pragma INTHANDLER inthand void inthand void process If you enable the multiple interrupt please add E after INTHANDLER or INTERRUPT Addition to mrtable a30 Add your interrupt process function to the interrupt vector It can be set below line number 171 of mrtable a30 In case of interrupt excluding WDT Please set each vector as the same as the following gray shaded lines lt lt 1 gt gt and lt lt 2 gt gt Please add the following 3 lines Add the vector number to Vector Number and the interrupt function name to Interrupt Function Name is not necessary The is not necessary for function name and please attach _ at top of the name lt lt 2 gt gt Please change the dummy function name __SYS_DMY_INH to the Interrupt Function Name is not necessary SSECTION INTERRUPT VECTOR GLB 5 8 D2dll PhyRx PhyUsartISR INTOS 8 EQU 1 GLB D2dll PhyUsartISR GLB _ INTOS Vector Number Interrupt Function Name lt lt 1 gt gt INTOS Vector Number EQU 1 GLB Interrupt Function Name LWORD SYS DMY INH vector7 LWORD _D2dll_PhyRx_PhyUsartISR vector8 LWORD SYS DMY INH vector9 LWORD Interrupt Function Name vector Vector Number
18. between the D2DL and the ITS00PHY INTO D2dll Phy ISR The event from the IT800PHY TAO D2dll Timer ISR The timer for the PHY layer TA1 D2dll Timer1 ISR The timer for the DLL layer D2DL USER S MANUAL 3 Description of the D2DL 3 1 API The API functions are defined in the D2DL as the interface with the upper layer the user application The next table shows the main features of the API functions and their descriptions Feature Description Initialization It initializes and starts the D2DL Register an application It registers an application On multiple application system the D2DL can identify each upper application and communicate with each application Transmission It sends a packet When you check the transmission result you can select between two methods One is the method using the callback function The other is the method that the application waits for the determined transmission result in the transmission function and refers the return value Reception It receives a packet When you get the received packet you can select between two methods The first method is using the callback function and the second one initates the upper layer to call the reception function EEPROM access It accesses the user area of the EEPROM Parameter control It accesses the parameter that the D2DL use For details please refer to the section 4 and the D2DL API SPECIFICATION 3 0 PLC comm
19. following folders are created on your PC Folder Name Description d2dllApp s This is a work space folder There is a HEW work space file hws If you open and use this file on HEW you can develop your program based one the example program D2dllApp_Vxxxs Note This is a project folder The information about this project is stored under this folder Debug There is debug configuration information The configuration includes build option information etc Output file is also stored here after build process Release Not used SIC There are some source files of the example program app See below eeprom inc lib Note xxx is a version number Following table shows each file in src folder Please develop your application by modifying UserMain c This is an example source file for the User Application Program The function named Main WorkerThread is like a function main in a C program In your application programming please modify this function and add your sub functions mrtable a30 This is a file for interrupt vector table ASM Yes When you add your own interrupt service routine please add the interrupt vectors in this file stack a30 This is a file for the stack Please define stack size for user application ic Yes main routine and interrupt startup r30 is a module file for starting up 16 is a file fo
20. recommend value of the index D2DLL E SYS This function can be called after calling the D2DLL RegApp function D2DLL GetVer version Version of the D2DL Normal D2DLL E OK This function returns the version of the D2DL uint32 version Error D2DLL E PARAM This function can be called when the PLC D2DLL E TIMING communication is enabled by the DZDLL Online D2DLL E SYS function D2DLL_SetAddrs netId Network ID for my device Normal D2DLL E OK This function sets own network ID and own node uint16 nodeld Node ID for my device Error D2DLL_E PARAM ID uint16 nodeld D2DLL_E_TIMING D2DLL E SYS The address is also able to be set by the D2DLL Start function The D2DL has a capability to store the network ID and the node ID to EEPROM But this function does not store these values to EEPROM It changes only the data in RAM If you want to store them to EEPROM you have to call the D2DLL SaveParam function after calling this function 16 D2DL USER S MANUAL This function can be called when the PLC communication is enabled by the DZDLL Online function D2DLL GetAddrs netId Network ID for my device Normal D2DLL E OK This function returns own network ID and own uint16 nodeld Node ID for my device Error D2DLL_E_PARAM node ID uintl16 nodeld D2DLL E TIMING This function can be called after calling the D2DLL E SYS D2DLL RegApp fun
21. send errStatus D2DLL Send amp sndParam 3 if errStatus D2DLL E OK 4 while bIs SendFinished TRUE 5 bIs_SendFinished FALSE 6 if sendStatus D2DLL E OK printf Failed d n sendStatus Soe 7 else printf d i 10 8 else printf Send Error n RE 9 printf Complete Yn I 10 Set the transmission parameter Loop iteration which is the specific times of the number of the packets Send a packet with the D2DLL Send API function Check if the D2DLL Send API function exits successfully or not Loop iteration until it has transmitted The transmission complete flag bIs SendFinished is set to TRUE in the callback function because the User SendResult CB function is called when the D2DL finishes the transmission 6 The transmission complete flag bIs SendFinished is set to FALSE to clear it 7 Output the error message if the transmission result is not normal 8 Output the count log of the transmission packet if the transmission result is not normal 9 1 Qn de ah Output the error message if D2DLL_Send API function does not terminate normally 0 Output the completion message after loop iteration which is the specific times of the number of the packets 8 3 4 User SendResult CB function 8 3 4 1 Details of the function This is a callback function It is called when the D2DL finishes the transmission Static void User SendResult CB uintl16 sessionTag
22. specific area for the received packet Please refer 6 2 3 and 1 2 3 for details The handling of the internal parameters for the D2DL is as follows Calling the D2DLL Init The D2DL accesses the parameter area of the EEPROM If there are valid data they are checked with checksum etc the D2DL copies them to the RAM table If there are no valid data for example the EEPROM is blank the D2DL copies the default data which is stored in the ROM to the table of the RAM and the EEPROM In this case the default values are the parameters for FCC U S A RAM There are valid data y in the EEPROM a LITE a a ana There aren t any valid data in the EEPROM Parameter Calling the D2DLL Start EEPROM Parameter storage area The D2DL sets the parameters which are indicated by the arguments i e selecting network ID node ID received packet type region device serial number and repeater function ON OFF to the RAM table and the EEPROM If the region is set from 0 to 3 the default values of the region are loaded and then the other parameters are set 19 D2DL USER S MANUAL The setting values of the arguments of the D2DLL Start EEPROM storage area 7 SEES When the e region is from 0 to AU Calling the D2DLL SetAddrs the DZDLL SendOption and the D2DLL_SetParam The par
23. task callback functions should be entry_address D2dll Recv added to the stack size of stack size 180 D2dll_Work 160 because the 18 callback functions are called by D2dll_Work Task Sane 180 46 D2DL USER S MANUAL seal 2 iimalic start task entry address stack size priority 95 initial_start y task entry address stack size priority Zoi initial start y task entry address Stack size priority ms initial start y OFF Stsk port1 180 OFF Stsk port2 180 OFF RecvTask 180 OFF The definition for the user application task If you add the task please make sure to define it after the D2DL task definition The definition of the event flag for Do not change the configuration and The definition of the event flag for the user application Please make sure to define after the D2DL event flag definition comba Flag Configuration Flag name the D2DL flag name 1529 the order Flag name flag name _f4 flag name ORSA flag name _f6 flag name E flag UARTO Receive name Main pEventIpcRequest Flag name UserTaskState Semaphore Configuration Ld semaphore
24. task which calls the D2DLL Recv function has been in the sleep status As mentioned above for D2DLL INFINITE OxFFFF in this period the other task runs When the packet is received or the time out is indicated the user task runs again The priority of the user task should be lower than the internal tasks of the D2DL If the multiple tasks call the reception function at the same time it is the same sequence If there is a received packet when User the function is called it returns Application soon D2DLL The specific period which is set in rcvTimeout return Time Out Get the reception result It returns if there is a received packet in this period Case The 2nd argument of the D2ZDLL_RegApp is not NULL The received packet is passed to the user application by the callback function from the D2DL In this case the D2DLL_Recv function is not needed You can pass the reception result on to the multiple tasks by devising the packet reception callback function For example when a callback function is used by the different port numbers for the packet reception you can identify the user task to pass the reception result by using the member dstPortId of the structure for the reception API User Application Callback function When the packet is received the Get the reception result D2DL calls the callback function In the environment in which there are some application port on the D2DL
25. the user application If you do not want to use this callback function set the argument fpOnTransmitted of D2DLL_RegApp function to NULL and get the result as the return value of packet transmission function This function is enabled when the PLC communication is enabled by the DZDLL Online function 4 3 Reception function API API name Parameter Return value Description D2DLL Recv rcvParam rcvPcktType Type of the Normal Positive value Size of This function is for data reception If you get d2dll rcvParam received packet the receive data the received data using the callback function rcvParam 0 There is no data this function is unnecessary for you The return srcNetId Source Network ID Error D2DLL E PARAM timing from this function depends on the D2DLL E TIMING specified receive time out In the case of the sreNodeld Source Node ID D2DLL E SYS 4 egt tasks p call E srcPortId Port ID of the source D2DLL E TMOUT voeon SAnS ume tas application function is running to receive the function dstNodeld Destination called later is set to WAIT state internally by the Node ID semaphore function Pond Port ID of the This function can be called when the PLC 13 D2DL USER S MANUAL destination application rcvData Start address of the user receive buffer for the D2DLL_Recv function Start address of the D2DL receive buffer for the r
26. 4 it describes the necessary information when you develop some programs with the D2DL The M16C 6S integrates IT800 PLC modem technology developed by Yitran Communications Ltd which enables extremely robust PLC communication The D2DL is a communication library which optimized for IT800 The D2DL provides some API functions for the interface with the upper layer You can make some PLC communication programs easily to use these API functions The D2DL runs on the real time OS hereafter called the RTOS and we provide two types of edition Single Task Edition and Multi Task Edition for each user s usage You can use the Single Task Edition for your system development that needs only one task i e it doesn t need multiple tasks If you develop a system that needs multiple tasks you have to use the Multi Task Edition This document gives a description both of Single Task Edition and Multi Task Edition The following table shows some documents about the D2DL and their descriptions Document Name Description D2DL USER S MANUAL This document has information which helps you understand and use the D2DL We recommend you read this document first D2DL QUICK START GUIDE It describes the operation to run the example program attached to the D2DL D2DL API SPECIFICATION It gives a detailed description of the API functions for D2DL D2DL EEPROM I F The D2DL provides the basic function which accesses the SPECIFICATION mi
27. D2DLL Start you can call D2DLL_RegApp at any time if you want register several applications Please make sure to do the following steps between the D2DLL Start and the D2DLL Online Call the D2DLL SizeEep to notify the EEPROM size to the D2DL Call the D2DLL SetParam to notify the RAM area size which available for the D2DL Please refer 6 2 3 and 7 2 3 for details After calling the D2DLL Online the PLC communication transmission and reception is available 18 D2DL USER S MANUAL 5 2 Handling the internal parameters for the D2DL The D2DL stores the internal main parameter to EEPROM and manages them When the D2DL starts up it lays out these data to the table on the RAM If the D2DL refers them it accesses the data on the RAM table The use application can access the following 12 disclosed parameters The disclosed parameters may be added for the future Parameter Default value Network ID 0 Node ID 1 Received packet type packet types are disabled it does not receive any packets Region FCC N America Device Serial Number zero Selection of the repeater function ON OFF ON The retransmission number of ACK service 3 The retransmission number of UNACK service 0 Protocol number 1 Transmission rate Buffer size of the transmission and reception packet Please refer 6 2 3 and 1 2 3 for details The size of the
28. DLL Send MH d2 sndParam The same as The same as The same The same as This function enables the multiple hop broadcast dll sndParam D2DLL Send D2DLL Send as D2DLL Send packet transmission The multiple hop feature sndParam sndMHent Hop counter D2DLL Se allows for repeating hopping of the received uint16 sndMHent nd multihop broadcast packet 12 D2DL USER S MANUAL Note The same as D2DLL Send D2DLL Send CNC d 2dll sndParam sndParam uint16 sndMHoent sndParam The same as D2DLL Send The same as D2DLL Send sndMHent Hop counter The same as D2DLL_Se nd The same as D2DLL_Send This function enables the CNC Control Network Channel packet type packet broadcast transmission This type of the packet is used to broadcast messages to all the connected nodes regardless of their network ID if they don t have their network ID The CNC service is useful for introducing a new node to a network The CNC packet contains the DSN of the source node Note The same as D2DLL_Send d2dll_fpOnTxResCb t sint16 sessionTag sint16 sndResult sessionTag Packet ID sndResult Result of Transmission This function is a callback function so this function has to be implemented in a user application When the D2DL completed the transmission sequence this function will be called for giving the result of transmission to
29. Everywhere you imagine ad E N ESAS REJ11B0006 0102 M16C 6S DATA LINK LAYER LIBRARY D2DL USER S MANUAL RENESAS SINGLE CHIP MICROCOMPUTER MI6C Family M16C 6S Group Rev 1 02 Jun 30 2006 Renesas Technology WWW renesas com D2DL USER S MANUAL Contents Introductions ee eec e oe eee ep ER ER EO RR aie 3 27 DDL 5 icc A vive ERR ERR 4 24 D2DLfeat re 2r ete ed reete i de esee de qr de a ER heu 4 2 2 Compartmentalization between the Single Task Edition and the Multi Task Edition 4 2 3 Block erc er ee ton e Peer EXE 4 2 3 1 The Internal Block Diagram of the D2DL Single Task Edition een 4 2 3 2 The Internal Block Diagram of the D2DL Multi Task Edition eee 5 24 The resources forthe D2DL rn EU 6 3 Description of the DD ists ern iiec tern abd adie cus cai ated Sa FERE ken ERE Rua ERA 7 3 1 O s 7 32 PEC COMMUNICATION fe t te A En cote see neu 7 3 2 1 Packet delivery ServICe oer eene repente ean ede Bere e bra 7 32 L1 ACK UNAGCK SetVICe iiie i iain cach nca E eR a sea 7 3 2 12
30. L E PARAM Each application has a different port ID fpOnRxPktCb t ed will be called back when the D2DLL E TIMING This function can be called after the D2DLL Init fpOnReceived D2DL receive a packet D2DLL E SYS function and has to be called at least once before 2 fpOnTxResCb t PONT Pointer to the functi hich the D2DLL_Start function After calling the pOnTrans ointer to the function whic fpOnTransmitted mtted will be called back when the D2DLL Start function you can call this function D2DL has transmitted a packet atany for this application D2DLL Online void void Normal D2DLL E OK This function enables the use of the PLC Error D2DLL E TIMING communication D2DLL E SYS This function can be called after calling the D2DLL Start function or the D2DLL Offline function and has to be called before starting the PLC communication D2DLL Offline void void Normal D2DLL E OK This function terminates the PLC communication 11 D2DL USER S MANUAL Error D2DLL E TIMING functions in transmit waiting state and receive D2DLL E SYS waiting state will be terminated compellingly with the retun value D2DLL E SYS This function can be called when the PLC communication is enabled by the D2DLL Online function If you want to enable the PLC communication again the D2DLL Online function must be called 4 2 Transmi
31. Ver No C Compiler Package M3T NC30WA This package includes the C compiler assembler and linker Ver 5 30 Release 02 Or Ver 5 40 Release 00 High performance Embedded Workshop HEW The D2DL example program is provided as HEW project environment The development based on this program is recommended The HEW is included in the NC30WA package Ver 4 1 Emulator Debugger PC7501 Emulation Probe M3062PT2 EPB Emulator Debugger PC4701U Emulation Pod M3062PT3 RPD E These are the emulator system Please use a set either 1 or 2 Emulator Debugger PD30F This is attached to the emulator Signal Converter Board for M16C 6S Group 30650 This is connected to the tip of the pod or the probe It converts the signal for M16C 6S Flash Programmer M3A 0806 It is used for writing to the flash memory D2DL Library This product M16C 6S module This is the target board Notes socket should be set on the M16C 6S Please refer the M306S0T PRB User s Manual for details It can be downloaded from the RENESAS web site Note You can also use the M3A 0665 FoUSB for writing to the flash memory The development environment using the Emulator Debugger is shown as follows M3T NC30WA HEW PD30F M306SOT PRB PC7501 M3062PT2 EPB or or PC4701U M3062PT3 RPD E 63 16 65 DATA LINK LAYER LIBRARY D2DL USER S MANUAL Publicat
32. ameter values of the RAM can be changed These functions don t change the data of the EEPROM If you want to store the data of the RAM table please call the D2DLL_SaveParam as follows Setting values of the arguments for the D2DLL_SetAddrs the D2DLL_SendOption and the D2DLL_SetParam EEPROM Parameter storage area RAM A 71 Parameter table area Calling the D2DLL SaveParam It copies the data of the RAM table to the EEPROM RAM EEPROM wow 74 Parameter Parameter storage area UN D2DL USER S MANUAL If you want to judge whether you load the default data to the EEPROM or use the valid data of the EEPROM before calling the D2DLL Start you can judge it by the address values node ID and network ID D2DLL Init D2DLL RegApp D2DLL GetAddrs Is network ID or node ID the default value Set the specific data from 0 to 3 to the Set 1 to the argument region and call argument region and the the D2DLL Start ie It uses the D2DLL Start i e It lays out each region EEPROM data default configuration to the RAM table If you have any cases except the address just feel free to contact us 21 D2DL USER S MANUAL 5 3 EEPROM interface process The D2DL opens the source code for EEPROM I F therefore you can use any EEPROM By default an example program which supports the ATMEL AT24C128 and AT24C16 EEPROM is included It uses SCL2 pin no 18 and SDA2 p
33. are the configurations for the D2DL Do not change the lines which do not have any comments The description of the MR30 configuration file t k k k k RRA RR ARA RRA RR RAR ARA RRA k k k k COPYRIGHT C 2005 RENESAS TECHNOLOGY CORPORATION AND RENESAS SOLUTIONS CORPORATION ALL OS Configuration File for 16 65 DLL RIGHTS RESERVED J RRR KR RK kk k kkk k k kk k k kck ck kckck kck ck k k k System Configuration system Stack size 330 The definition about the system ose ste abe B and the clock for the D2DL system 7 Do no changes except the system message size 16 stack size stack size and the timeout YES maximum value of the task task pause NO priority priority clara mpu clock 193 timer A2 IPL 6 unit time lms initial time 0 task entry_address stack_size Task Configuration task entry_address Main_WorkerThread stack_size 280 priority 4 The definition of the task for initial start the DZDL m Do not change the configuration task and the order entry address D2dll Work Main WorkerThread is the stack size 160 user task Main Task so it is priority available to change the stack initial start OFF size fo And maximum stack size of
34. ased program To get a Multi Task based application you should use the D2DL Multi Task Edition In this case you have to prepare our recommended RTOS MR30 developed by RENESAS because D2DL Multi Task Edition does not include the RTOS 2 3 The Internal Block Diagram This section describes the internal block diagram of the D2DL Single Task Edition and the D2DL Multi Task Edition The meshed blocks indicate the block the user has to make or prepare 2 3 1 The Internal Block Diagram of the D2DL Single Task Edition The Internal Block Diagram of the D2DL Single Task Edition is as follows D2DL USER S MANUAL User Application Program Main Task D2DL API Layer D2DL Communication Process Reception Transmission EEPROM I F Task Task p The User Application Program block is a task in the D2DL Single Task Edition But user does not need to care about Multi Task based programming with the RTOS Therefore the user can program the User Application which includes a main loop some interrupt service routines and some sub functions which are called by them The user cannot use the features of MiniRTOS from User Application Program 2 3 2 The Internal Block Diagram of the D2DL Multi Task Edition The Internal Block Diagram of the D2DL Multi Task Edition is as follows User Application D2DL API Layer DLL Communication Process Reception Transmission Task Task EPROM UF The user can develop the User Application Program by
35. assigns an address to a new node The CNC packet has a DSN Device Serial Number of the source node When the D2DL on the received side node receives a CNC packet it passes the received information which includes the source DSN to the user application 3 2 1 3 Multi hop feature The D2DL has a multi hop feature which repeats hops the received broadcast packets When the distance between nodes is too far or the communication environment is bad and the signal does not reach directly this feature is effective The router nodes relay the packet so the packet can be reached to the destination node The number of times of relay hop count is set by the user application of the source node and included in the packet The relay node decrements the hop count set it in the packet and transmit it If the hop count is 1 the D2DL USER S MANUAL received node does not relay it When a node which relays a packet does receive the same packet again i e it receives the packet which is relayed by the other node it doesn t relay it again The D2DL relays the packet internally so the user application does not need to care about it NodeA NodeB NodeC NodeD Stepl Step2 Step3 Step4 Send the multi hop Receive the Receivethe Receivethe packet 1 hop count packet 1 packet 2 packet 3 and not 3 decrement the decrement the send because the hop count and hop count and hop count 15 1 send the packet 2 send the packet 3 Packet 1 Packet 2
36. ation from the D2DL by using either one of both methods This section describes each method Notes When you use the single task edition we recommend using the callback functions If the user application does not use the callback function and it calls the API function by the method which takes wait time the process waits in the function and it does not return until when the communication is completed 6 2 1 1 Getting the packet transmission result The method to get the transmission result is determined by the 3rd argument of D2DLL_RegApp function Case The 3rd argument of DZDLL RegApp is NULL The transmission result is passed by the return value of the packet transmission request API function i e the D2DLL Send etc Therefore the transmission function does not return until the transmission result has determined It takes dozens of milliseconds up to several seconds to determine the transmission result according to the condition of the line and the destination node The task which calls the D2DLL Send function has been in the sleep status until the transmission result has determined In this period the other task runs in the Multi Task Edition but in the Single Task Edition the user task stops User Application D2DLL Send Receive the transmission request Execute the transmission process Wait the transmission result Get the transmission result Wait in the condition of task sleep From dozen
37. callback function passes the transmission and reception result on to the user task which is waiting for the indication by using the global variable The callback function sets the value to the global variable and the user task refers to it The following example uses the global variable Global variable unsigned int rcv stat 0 Reception result indication flag User task process void UserTask2 void wait while rcv stat 0 Waiting for the indication of the callback function tslp tsk 1000 Sleep for lsec rcv stat 0 Clear the indication flag if rcvBuffSize 0 Check the result of the callback function Callback function process void Receive CB d2dll rcvParam rcvParam rcvBuffSize rcvParam rcvDataLen Set the size of the received data for 0 i lt rcvBuffSize i Copy the received data urbuf i rcvParam rcvData ti rcv stat 1 Set the indication flag Notes for using the callback function It takes dozens of milliseconds up to several seconds for the packet transmission and reception If the callback process spends more than this time the D2DL may fail the transmission and reception Additionally if multiple tasks share the buffer etc you should take care to overwrite the data and to change the status of variable 7 2 1 5 Example of the action by the multiple user tas
38. crocomputer hardware and controls the EEPROM for EEPROM I F therefore you can use any EEPROM The document describes the specification about the functions and the example program attached to the D2DL D2DL SPECIFICATION It describes the communication feature of the D2DL D2DL USER S MANUAL 2 D2DL Overview 21 D2DL feature The D2DL features are described as follows gt IT800 PLC modem technology developed by Yitran Communications Ltd enables extremely robust PLC communication The D2DL is a communication library which optimized for IT800 If you use the D2DL you can get the communication which uses the IT800 feature and the unique identity at a maximum and also keep the coexistence with the other IT800 module gt all achieved by the interfaces with the upper layer user application such as the transmit receive packet passing and the parameter setting by the API functions and callback functions You can develop the communication application program easily by these API functions gt D2DL runs on RTOS We provide two types of edition Single Task Edition and Multi Task Edition For more details please refer to the next section gt You can achieve one chip solution using the available resource area of microcomputer which the D2DL does not use and create the system at low cost gt You can create the debug environment at once and debug efficiently using the project format of the RENESAS HEW
39. ction 4 6 Error Code Error codes in the API functions for the D2DL are shown as follows Name Value Description D2DLL E OK 0 Normal end D2DLL E PARAM 1 Parametric error D2DLL E TIMING 2 Invalid call D2DLL E SYS 3 System error i e internal system error in OS etc D2DLL E NOACK 10 No ACK response D2DLL E BLCKD 11 Outgoing packet is blocked for congestion D2DLL E NORESRC 12 No resource currently not enough available memory to accept packet D2DLL E TMOUT 20 Time out 17 D2DL USER S MANUAL 5 Development of the User Application For both edition This section describes the necessary information that is common to the Single Task Edition and the Multi Task Edition to develop the user application 5 1 Initialize Sequence The following 6 API functions are used for the D2DL initialize and startup sequence Description Function name D2DLL Init Initialize the RTOS parameter for the D2DL D2DLL Start Start the D2DL for setting the address and the received packet type etc D2DLL RegApp Register the application D2DLL Online Enable the PLC communication function D2DLL_SizeEep Notify the size of your EEPROM D2DLL_SetParam Set the D2DL parameter Please call functions above in the given order to initialize and to start the D2DL The D2DLL_RegApp can be called after the D2DLL Init and has to be called at least once before the D2DLL Start After calling the
40. ddress DACIL mess P The definition of the Wu interrupt vector for the IS E 4 D2DL interrupt 22 fii WAL Do not change the entry_address D2dll Timerl ISR A configuration OS sine YES y interrupt_vector 29 INTO entry_address DZELIL Jy IJ Sm 5 interrupt 10 BCN entry address sis int os int YES y interrupt vector 15 S2T entry address sit int os int YES y interrupt_vector 16 S2R entry address sir int os int YES y End of Configuration Lf Figure 1 The example of the MR30 configuration file System Timer It isn t available to change except the system stack size stack size and the maximum priority of the task priority Please calculate the system stack size with the stack size calculation program StkViewer for example If you don t add any interrupt handlers the size is 330 Please set the maximum value of the priority for the user task to the maximum value of the task priority If you don t add the user task the value is 4 System Clock item cannot be changed Task The above gray shaded lines of the task in Figure 1 are the definition of the task used in the D2DL and the main task Main WorkerThread of the user application Do not change the line except the stack size of the user main task and D2dll Work task and t
41. e method to change the stack size is as follows The configuration of the stack size is in the stack a30 file Please calculate each stack size for example by the stack size calculation program StkViewer and set them to the following gray shaded lines lt lt 1 gt gt lt lt 2 gt gt lt lt 1 gt gt Set the system stack size in hexadecimal The interrupt process of the user application also uses the system stack Do not set smaller value than the default lt lt 2 gt gt Set the stack size which is used by the main routine Main_WorkerThread O of the user application in hexadecimal Do no changes except these values in this file GLB SYS STACK 517 Main stack Sys Sp SYS STACK SIZ EQU 014aH lt lt 1 gt gt Main stack EQU 0118H lt lt 2 gt gt Stack Area section stack DATA ALIGN BLKB SYS STACK SIZ align Sys Sp BLKB Main stack BLKB 0208H END 32 D2DL USER S MANUAL 6 3 Notes 6 3 1 Influence of the D2DL task and its interrupt process on the user application During the main function Main_WorkerThread of the user application or the new interrupt functions which are added by the user is running the interrupt process for the D2DL may start up and then the tasks in the D2DL library run circumstantially In this case the user application pauses and the process of the D2DL library s
42. eceive callback function rcvDataLen Size of the user receive buffer for the D2DLL_Recv function Size of the receive buffer for the receive callback function rcvTimeout Setting receive time out Unit 1 msec rcvSQuality Signal Quality r option Option parameter r extnsn Future reserved communication is enabled by the D2DLL_Online function d2dll fpOnRxPkt Cb 0 d2dll rcvParam rcvParam rcvParam The same as D2DLL_Recv The same as D2DLL_Recv This function is a callback function so this function has to be implemented in a user program When the D2DL has received the packet from the power line this function will be called for the data reception If you do not want to use this callback function set the argument fpOnReceived of the D2DLL_RegApp function to NULL and get the received data using the D2DLL function This function is enabled when the PLC communication is enabled by the D2DLL Online function 14 D2DL USER S MANUAL 4 4 EEPROM access API API name Parameter Return value Description D2DLL_SizeEep size Memory size of your EEPROM Normal D2DLL E OK This function passes the size of your EEPROM to uint16 size byte Error D2DLL E PARAM the D2DL Please refer to D2DL EEPROM I F SPECIFICATION for details This function ca
43. ection 4 1 Initialization and termination function API API name Parameter Return value Description D2DLL Init void rsc Resource information in the Normal D2DLL E OK This function initializes the RTOS function for the D2DL Error D2DLL E PARAM D2DL with information specified by the argument D2DLL E TIMING D2DLL E SYS Please set rsc to NULL regardless of the single task edition or the multi task edition This function has to be called once after power is on Other functions can not be used until this function is called D2DLL Start Network ID for my device Normal D2DLL E OK This function initializes and starts the D2DL uint16 netId nodeld Node ID for my device Error D2DLL_E_PARAM Each valid value which is set by the argument of uint16 nodeld rxPktType Receive data type D2DLL_E_TIMING this function is saved to EEPROM in this function sint16 rxPktType region Area configuration D2DLL_E_SYS This function can be called after the D2DLL_Init sint16 region dsn Device Serial Number 16byte function and the D2DLL RegApp function and uchar dsn value for my device before DZDLL Online function j sint16 enableRep enableRep Enable Disable repeater function D2DLL RegApp portld Port ID of the application Normal D2DLL E OK This function registers the current application uint16 portld fpOnReceiv Pointer to the function which Error D2DL
44. er application You can use the source code of the example program without any changes The function for getting the start point unsigned HALMemMngS_GetFreeRAMStart void The function for getting the end point unsigned HALMemMngS GetFreeRAMEnd void Next it describes the configuration by the function D2DLL SetParam Please set the size of your heap area by the following argument of the function D2DLL_SetParam The first argument The second argument D2DLL DLL MEMORY 71 The size of the transmission and reception packet buffer bytes D2DLL IDX RXRES MEMORY 77 The size of the area only for received packet bytes The example source code is as follows d2dllResult D2DLL_SetParam D2DLL IDX DLL MEMORY 916 if d2dllResult DZDLL E OK while 1 31 D2DL USER S MANUAL d2dllResult D2DLL_SetParam D2DLL IDX RXRES MEMORY 458 if d2dllResult DZDLL E OK while 1 Note These configurations should be set between calling the D2DLL Start and the D2DLL Online in the D2DL initialization sequence Please refer to the example program for more detailed implementations 6 2 4 Configuration of the stack size The default stack size of the D2DL is as follows The system stack which is used by the MiniRTOS and the interrupt routine in the D2DL is 330 bytes The stack of the user application main loop is 280 bytes It is used by the example program Th
45. er mapping is calculated as follows The transmission and reception packet buffer size bytes 32 30 D2DL USER S MANUAL Note Round up the remainder For other usage area is fixed 284 bytes You should allocate the total size of the area which is added to each RAM area and set the size to the D2DL The method of setting is as follows The heap area size is set by the following two methods parameter which is written in dll heap a30 The parameters which are set by the function D2DLL_SetParam Both of them should be set First it describes the configuration by heap a30 Please set the size of your heap area to the following gray shaded line in dll_heap a30 in hexadecimal Do not change other item except this value in this file GLB D2DLL HEAP AREA __ 4241 heap top D2DLL HEAP AREA EQU 600H 1 5K GLB _g d2dll StartOfHeap GLB 4241 EndOfHeap section d2dll heap DATA ALIGN _g d2dll StartOfHeap 1 _g d2dll EndOfHeap BLKW 1 d2dll heap top BLKB D2DLL HEAP AREA END In the start up file startup r30 the d2dll StartOfHeap is set to the top address of the heap area and the g d2dll EndOfHeap is set to the end address of the heap area automatically These values are passed to the D2DL as the return value of the function HALMemMngS_GetFreeRAMStart and HALMemMngS_GetFreeR AMEnd Therefore you should implement these functions in the us
46. etFreeRAMStart void The function for getting the end point unsigned 5 GetFreeRAMEnd void Next step describes the configuration by the function D2DLL_SetParam 44 D2DL USER S MANUAL Please set the size of your heap area by the The first argument following argument of the function D2DLL_SetParam The second argument D2DLL IDX DLL 71 The size of the transmission and reception packet buffer bytes The example source code is as follows D2DLL IDX RXRES MEMORY 77 The size of the area only for received packet byte d2dllResult D2DLL SetParam D2DLL IDX DLL MEMORY 916 if d2dllResult while 1 D2DLL E OK d2dllResult D2DLL SetParam D2DLL IDX RXRES MEMORY 458 if d2dllResult while 1 D2DLL E OK Note These configurations should be set between calling the D2DLL_Start and the D2DLL Online in the D2DL initialization sequence Please refer to the example program for more implementation details 45 D2DL USER S MANUAL 7 2 4 Modification of the MR30 Configuration File When the user application uses the MR30 feature you should modify the MR30 configuration file CFG file Please add the feature after referring under description because there are some items which are not available to change and have restriction to add The following gray shaded lines in Figure 1
47. function if you do not use the echonet 10 Set the size of the sent received buffer of the D2DL by the D2DLL_SetParam API function 11 Set the size of the special area for the received packet of the D2DL 12 Enable the PLC communication by the D2DLL_Online API function 13 Set the transmission parameter by D2DLL_SendOption API function 14 Call the UserApplication function for the main loop process It describes later SON Rh 8 3 2 UserApplication function 8 3 2 1 Flowchart Output the PLC TEST MENU Select the mode The mode n Data transmission process Unicast NE P Data transmission process Broadcast Data reception process 56 D2DL USER S MANUAL 8 3 2 2 Details of the function static bool v UserApplication void uchar str 17 uint16 command while TRUE n z printf printf PLC TEST MENU Yp printf 1 Transmit 100packets by UniCast 40byte printf 2 Transmit 100packets by BroadCast 40byte printf 3 Transmit 500packets by UniCast 40byte n printf 4 Transmit 500packets by BroadCast 40byte n printf 5 Count Received PacketsYn printf Select Mode gt UartStrGet str printf command str2DN str switch command case 1 case 3 It User Send dst Nodeld command 1 break case 2 case 4 It User Send 0 command 1 break case 5 It User recept brea
48. has returned the resource to the semaphore which obtains at above process 1 at the end of the reception function 10 The process of the User Task E and the User Task F have done 7 2 2 Addition of the Interrupt Handler The interrupt process function is written in C It is registered in the configuration file CFG file for using on the RTOS MR30 system Please refer to the MR30 manual for the method of the interrupt process function definition and CFG file definition Note that it is not available to use the D2DL API in the interrupt process function 7 2 3 Configuration of the DZDLHeap Area The D2DL uses RAM area for the transmission and reception packet buffer and other usages This area is called the heap area in this document The size of the heap area is configurable by the user and the allocation is as follows RAM Transmission and reception packet buffer Area only for D2DL Heap Area received packet Mapping data area for the transmission and reception The packets which are requested to be transmitted by the user application and the packets which are received by PHY are temporarily stored in the transmission and reception packet buffer If the upper layer requests transmission continuously for example the transmission waiting packet occupies the buffer so the user application cannot receive any packets Therefore the area only for received packet is the area which is always allocated in the transmission and recept
49. he interrupt enable flag I flag and the processor interrupt priority level IPL Please make sure to use the interrupt disabling and enabling in pairs II Change the interrupt priority level from ILVL2 to 0 to disable Please clear the I flag before and after the operation of the interrupt priority level from ILVL2 to 0 The D2DL reserves the interrupt number from 32 to 47 of the INT instruction Please use the interrupt number except from 32 to 47 when you use the software interrupt in the user application Register Bank Usage It is not available to change the register bank 6 3 3 Notes on the debug You can set the breakpoints up to two at the same time in case of using the KD30 Donotuse the DBC interrupt because it is the specific interrupt for the developer support tool Itis notavailable to show the source code of the startup file startup r30 during debugging by means of the KD30 or the PD30 because it is provided only in r30 format 33 D2DL USER S MANUAL 7 Development of the User Application Multi Task Edition This section describes the necessary information to develop the user application using the multi task edition of the D2DL 7 1 Example program organization It is recommended that to develop the user application program based on the D2DL example program The project of the example program corresponds with the RENESAS HEW High performance Embedded Workshop When executing the D2DL set
50. he multi task The D2DL APIs can be called only in the task They cannot be called in the interrupt handler If you call the API in the interrupt handler it becomes the indefinite semantics When you make the application program with this library you should set the user task priority which is used by the application to value 4 or above and lower than the internal tasks of the D2DL Do not wake up the user task while the D2DL does it in sleep state by the user application If you wake it it causes illegal semantics 51 D2DL USER S MANUAL You have to use the RENESAS RTOS MR30 for using the D2DL multi task edition library Please install the MR30 in the same directory with the NC30WA When you upgrade the NC30 you should install it in the same directory with the previous version and you should not install it in the default directory of the NC30 installer If the install directory is different between NC30WA and MR30 it will cause build errors 52 D2DL USER S MANUAL 8 Description of the example program This section describes the outline of the example program 8 1 Overview Itisasimple program for communication test Connect each node of the M16C 6S target board to your PC via RS 232C cable crossover cable and launch a terminal software for example HyperTerminal The following menu is shown on the terminal window If you select the mode from 1 to 5 you can confirm the communication statu
51. he priority of the user main task Do not change the order of the configuration The user main task Main WorkerThread is a task which is waked up at first after power on Please 49 D2DL USER S MANUAL define the D2DL initialization the user application initialization and wake up the other task etc Calculate the stack size stack size with the stack size calculation program StkViewer for example and set the task priority priority the value 4 and above When you add the task used by the user application add it after the definition of the task using in the D2DL and the user main task The method of configuration of the stack size and the priority are the same as the method for the user main task Do not set the ID number in of the task Eventflag The gray shaded lines of the flag in Figure 1 are the definition of the event flag used in the D2DL Do not change all lines When the user application uses the event flag feature please add it after the definition of the event flag used in the D2DL Do not set the ID number in of the flag Semaphore The above gray shaded lines of the semaphore in Figure 1 are the definition of the semaphore used in the D2DL Do not change all lines When the user application uses the semaphore feature please add it after the definition of the semaphore used in the D2DL Do not set the ID number in of the semaphore Interrupt
52. in no 19 for communication between EEPROM and M16C 6S Therefore if you use the same specific hardware you will be able to use the example EEPROM I F without modification Note Please set the compile option EEP 128K 16K according to your EEPROM For more details please follow the specification described in D2DL EEPROM I F SPECIFICATION In other cases if you use the different hardware please modify the EEPROM I F to be fitted to your EEPROM and the communication I O specification of M16C 6S following the DZDL EEPROM I F Specification 5 4 Configuration of the protocol number The D2DL keeps the coexistence of any products which implements different upper protocols by using the protocol number The nodes using the same protocol number can communicate with each other but the nodes which use different protocol number cannot For example when there are two nodes which have the same address network ID and node ID on the line they can keep the coexistence if each of them uses a different protocol number If you want to use this feature you should set the following protocol number according to your protocol Upper protocol Protocol number Echonet 0x01 User specific protocol 0x3B Please contact the following address if you want to use other standard protocol E mail address plcsupport renesas com You can set the protocol number by calling the D2DLL SetParam function with the following arguments The fir
53. ion User TaskE User TaskF D2DL process WAIT state Transmission Time From dozens of ad I to several seconds 1 2 3 7 8 9 10 1 Wake up the User Task E Call the reception function obtain one resource from the semaphore for reception in the function and then move to the D2DL process 2 Start the reception process of the D2DL Then move to the WAIT state to get the reception result 3 Wake up the User Task F It calls the transmission function obtain one resource from the semaphore for transmission in the function and then move to the D2DL process 42 D2DL USER S MANUAL 4 Start the transmission process of D2DL Then move to the WAIT state to get the transmission result 5 Both of the User Task E and F are in the WAIT state in the D2DL function They wait for the reception result or the transmission result 6 The transmission result is determined and the D2DL wakes up the User Task F 7 User Task F gets the transmission result as the return value of the transmission function its process has done and exits It has returned the resource to the semaphore which obtains at above process 3 at the end of the transmission function 8 The D2DL receives the data creates the reception information and wakes up the User Task E 9 The User Task E gets the reception information by the argument of the reception function its process has done and exits It
54. ion Date Jun 30 2006 Rev 1 02 Sales Strategic Planning Div bus Renesas Technology Corp Edited by Application Engineering Department 3 Renesas Solutions Corp 2006 Renesas Technology Corp and Renesas Solutions Corp rights reserved Printed in Japan M16C 6S DATA LINK LAYER LIBRARY D2DL USER S MANUAL 24 NE SAS RenesasTechnology Corp 2 6 2 Ote machi Chiyoda ku Tokyo 100 0004 Japan
55. ion packet buffer for the received packet usage to avoid this condition Mapping data area for the transmission and reception packet buffer is the area which tracks the data location on the transmission and reception packet buffer Please set the size of these areas according to your system because they depend on the target system specification such as the maximum payload size of the transmission and reception packet and the frequency of the transmission and reception The following calculated value gives an indication of the size which area used by one packet transmission and reception packet in the transmission and reception packet buffer The payload size of the packet 17 header size 101 byte Notes You do not need to consider about the packet fragmentation on this calculation For example the 400 bytes payload packet occupies 400 17 101 518 bytes The size of the data area for the transmission and reception packet buffer mapping is calculated as follows The transmission and reception packet buffer size bytes 32 43 D2DL USER S MANUAL Note Round up the remainder For other usage area is fixed 284bytes You should allocate the total size of area which is added to each area in RAM and set the size to the D2DL The method of setting is as follows The heap area size is set by the following two methods parameter which is written in crtOmr a30 The parameters which are
56. k default break Output the PLC TEST MENU Get the user selected mode number Branch each process by the mode number Call the It User Send function for the unicast transmission It is described later Call the It User Send function for the broadcast function It is described later Call the It User recept function for the reception It is described later DUAL 57 D2DL USER S MANUAL 8 3 3 It User Send function 8 3 3 1 Flowchart Set the transmission parameter Output Sending Packet Data transmission process for a packet P Output Send Error lE Complete the transmission Clear the transmission complete flag Output the transmission failure message Output the count log of the transmission packet Is the data transmission process called specific times of the number of the packets Output the completion message 8 3 3 2 Details of the function static void It User Send uintl6 nodeld uintl16 parm uintl16 i sint16 errStatus 0 d2dll sndParam sndParam sndParam srcPortId 1 sndParam dstNodeId nodeld sndParam dstPortId 1 sndParam sndData TxData sndParam sndDataLen tx param parm lData TE sndParam sessionTag 1 sndParam sndPrty D2DLL PRTY LOW sndParam sndAck D2DLL SND ACKD 58 D2DL USER S MANUAL printf Sending Packet for i 0 i lt tx param parm sndCnt i 2
57. ks Case There are two tasks for the packet transmission or reception It simply makes a diagram and describes how to show the action when it wakes up the tasks User Task A and B together which call the transmission function which does not use the callback It assumes the User Task A wakes up first and the User Task B is next The task priorities assume the same 40 D2DL USER S MANUAL User Task A User Task B D2DL Process WAIT state Transmission Time n Transmission Time 1 1 From dozens of From dozens of misce nds I 1 I 1 I 1 to several seconds to several seconds Docs 32 4 5 67 8 9 10 1 Wake up the User Task A Call the transmission function obtain one resource from the semaphore in the function and then move to the D2DL process 2 Start the transmission process of the D2DL Then move to the WAIT state to get the transmission result 3 Wake up the User Task B because the User Task A and the D2DL task moved to the WAIT state It calls the transmission function waiting for the semaphore in the function and then moves to the WAIT state 4 Determine the transmission result and the D2DL wakes up the User Task A 5 The User Task A gets the transmission result as the return value of the transmission function its process has done and exits It has returned the resource to the semaphore which obtains at above process 1 at the end of the transmission function 6 The transmissio
58. lResult D2DLL E O while TRUE printf Failed YnYn D2DLL_IDX_RXR 458 yA ES_M EMORY js d2dllResult D2DLL_SetParam if d2dllResult D2DLL E O while TRUE printf Failed YnYn Online d2dllResult D2DLL Online if d2dllResult D2DLL while TRUE printf Failed XnYn P K Send Option Set d2dllResult D2DLL SendOption 2 0 D2DLL SND AUTO 55 src NodeId D2DLL RXTP MIN ECB EP 10 17 12 13 D2DL USER S MANUAL if d2dllResult D2DLL E OK while TRUE printf Failed n n printf Successful Yn The main processing loop UserApplication Initialize the UART Output the initial menu Get the network ID via the user input Get the source node ID via the user input Get the destination node ID via the user input Initialize the D2DL RTOS by the D2DLL Init API function Register the application by the D2DLL_RegApp API function It registers the User_Receive_CB function as a reception callback function and User_SendResult_CB function as a transmission callback function It describes later about each callback function 8 Initialize the D2DL by the D2DLL_Start API function 9 Set the dedicated protocol number by the D2DLL_SetParam API
59. me Occurrence timing interrupt SI O4 D2dll PhyRx PhyUsartISR 20 us 500 us The transmission and reception INTO D2dll Phy ISR 20 us 120 us on the PLC In other case it TAO D2dll Timer ISR 30 us 90 us may occur at random times by TAI D2dll Timerl ISR 10 us or less the reception of the noise Notes The SI O4 interrupt process takes about 500 us only in case of the reception for the top byte of the packet In other case the process takes about 20 us To disable the interrupt in the user application please select one of the following methods I Disable the interrupt by the operation of the interrupt enable flag I flag and the processor interrupt priority level IPL Please make sure to use the interrupt disabling and enabling in pairs II Change the interrupt priority level from ILVL2 to 0 to disable Please clear the I flag before and after the operation of the interrupt priority level from ILVL2 to 0 The D2DL reserves the interrupt number from 32 to 47 of the INT instruction Please use the interrupt number except from 32 to 47 when you use the software interrupt in the user application Register Bank Usage It is not recommended to change the register bank 7 3 3 Notes on the debug You can set up to two breakpoints at the same time in case of using the KD30 Donotuse the DBC interrupt because it is the specific interrupt for the developer support tool 7 3 4 Notes on t
60. n and reception The packets which are requested to be transmitted by the user application and the packets which are received by PHY are transmissi temporarily stored in the transmission and reception packet buffer If the upper layer requests on continuously for example the transmission waiting packet occupies the buffer so the user application cannot receive any packets Therefore the area only for received packet is the area which is always allocated in the transmission and reception packet buffer for the received packet usage to avoid this condition Mapping data area for the transmission and reception packet buffer is the area which tracks the data location on the transmission and reception packet buffer Please set the size of these areas according to your system because they depend on the target system specification such as the maximum payload size of the transmission and reception packet and the transmission and reception frequency The following calculated value gives an indication of the size which area used by one packet transmission and reception packet in the transmission and reception packet buffer The payload size of the packet 17 header size 101 byte Notes You do not need to consider about the packet fragmentation on this calculation For example the 400 bytes payload packet occupies 400 17 101 2 518 bytes The size of the data area for the transmission and reception packet buff
61. n be called at any time after power on D2DLL WriteEep addr Address to write in EEPROM Normal D2DLL E OK This function enables to write the data to the user uint16 addr size Size of the data to write Error D2DLL E PARAM area in EEPROM uint16 size buff Pointer to the buffer which stores D2DLL E TIMING Please refer to D2DL EEPROM I F uchar buff the data to write D2DLL E SYS SPECIFICATION for details This function can be called when the PLC communication is enabled by the DZDLL Online function D2DLL_ReadEep addr Address to read in EEPROM Normal D2DLL E OK This function enables to read the data from the uint16 addr size Size of the data to read Error D2DLL E PARAM user area in EEPROM uint16 size buff Pointer to the buffer which stores D2DLL E TIMING Please refer to D2DL EEPROM I F uchar buff the data to read D2DLL E SYS SPECIFICATION for details This function can be called after calling the D2DLL SizeEep function D2DLL SaveParam void Normal D2DLL E OK This function copies all D2DL parameters from void Error D2DLL E TIMING RAM to EEPROM D2DLL E SYS The D2DL parameter means the parameters which are set by the following functions D2DLL_SetParam D2DLL SetAddrs D2DLL SendOption This function can be called after calling the D2DLL Init function 4 5 Parameter Control API API name Parameter Return value Description D2DLL SendOption ackRetry Numbers of retransmission in Normal D2DLL E OK This functio
62. n function of the User Task B obtains one resource from the semaphore and moves to the D2DL process 7 The transmission process of D2DL starts then it moves to the WAIT state to get the transmission result 8 The transmission result is determined and the User Task B is waked up by means of the D2DL 9 The User Task B gets the transmission result by the return value of the transmission function its process has done and exits It has returned the resource to the semaphore which obtains at above process 6 at the end of the transmission function 10 The processes of the User Task A and the User Task B are finished Note Do not release and exit the User Task WAIT state forcibly when it is triggered by the process steps 2 When it wakes up the tasks the User Task A and B together which calls the reception function D2DLL and does not use the callback it is the same sequence However the D2DLL Recv function cannot assign the received packet to each destination application the port number Therefore it is not recommended that the multiple tasks call the reception function D2DLL Recv in the multiple application environment Case There are two tasks using the callback for the packet transmission or reception It simply describes how to show the action the tasks User Task C and D which use the callback for packet transmission are waked up together It assumes to implement different a
63. n sets the transmission parameter The uintl6 ackRetry ACK mode D2DL has a capability to store the argument uint16 repCnt repCnt Numbers of retransmission in Error D2DLL E PARAM values to EEPROM But this function does not sint16 sndRate UNACK mode store these values to EEPROM It changes only 15 D2DL USER S MANUAL sndRate Transmit rate Rates are different D2DLL E TIMING _ data in RAM If you want to store them to for each area D2DLL E SYS EEPROM you have to call the D2DLL SaveParam function after calling this function This function can be called when the PLC communication is enabled by the DZDLL Online function D2DLL SetParam index Index of the entry Normal D2DLL E OK This function sets one entry in the D2DL sint16 index value Entry value Error D2DLL E PARAM parameter table uint16 value D2DLL_E_TIMING Please use only our recommend index values D2DLL_E_SYS D2DLL_IDX_PROTOCOL_VER 70 Protocol number D2DLL_IDX_DLL_MEMORY 71 The size of the sent received buffer byte D2DLL RXRES MEMORY 77 The size of the special area for the received packet byte This function can be called after calling the D2DLL Init function D2DLL GetParam index Index of the entry Normal D2DLL E OK This function reads one entry in the D2DL sint16 index value Entry value Error D2DLL_E PARAM parameter table uintl6 value D2DLL E TIMING Please use only our
64. nction is called it is terminated soon While waiting for the received packet the task which calls the D2DLL Recv function has been in the sleep status In this period the other task runs When the packet is received the user task runs again The priority of the user task should be lower than the internal tasks of the D2DL Multiple tasks can call the packet reception API function at the same time However until the user task which calls the function first gets the reception result and the other tasks are set to the WAIT state by the semaphore function So the other reception process is not accepted or executed from the other task even if the first user task is in the sleep status waiting for the packet reception If there is a received packet when User the function is called it returns Application soon D2DLL Wait forever until the packet reception Packet reception return Get the reception result 37 D2DL USER S MANUAL Ifthe revTimeout is neither D2DLL_NOWAIT 0x0000 nor D2DLL INFINITE OxFFFF If there is a packet when the D2DLL_Recv is called it is terminated soon If there is no received packet it is waiting for the packet reception for the specific period which is set in rcvTimeout Unit msec When the packet is received the function is terminated If it does not receive a packet while the specific time is expired then the function is terminated While waiting the received packet the
65. network It assigns the common network ID to the node in the same logical network The node ID is assigned to each node and it should be unique in the logical network For example if each house has the different network ID interference between the houses can be avoided D2DL USER S MANUAL ZA M Logical Network NetworkID 5 Logical Network NetworkID 8 NodeID NodeID 2 7 3 2 2 2 Device Serial Number DSN The device serial number DSN is used as the address in case of the CNC service The DSN is a unique 16 bytes value which should be assigned to each node and is stored in the EEPROM of each node The user application in the node that receives a CNC packet can recognize the source device by the source DSN that is included in the received packet The DSN should be assigned to avoid CNC packet overlappings between each user s products To achieve this necessity a customer number is assigned to each user which is included in the DSN whereby DSN overlappings in the D2DL are avoided For details please refer to 5 5 3 2 2 3 Port ID Application registration Multiple processes works applications can share a D2DL Therefore you can lay out multiple applications on a chip You can make the number of application up to 16 and identify each application by the port ID from 0 to 15 This method is useful when you want to identify the processes works of the destination node for example when you want to send the packet
66. on first gets the transmission result other tasks are set to the WAIT state by the semaphore function Thus the other transmission process is not accepted or executed from the other task even if the first user task is in the sleep status waiting for the transmission result User Application D2DLL Send Receive the transmission request Execute the transmission process Wait the transmission result Get the transmission result Wait in the task sleep status Dozens of milliseconds up to several seconds Case The 3rd argument of the D2DLL RegApp is not NULL The API function for transmission i e the D2DLL Send etc terminates as soon as the transmission request is received in the D2DL The wait time does not occur After the transmission result is determined the D2DL calls the callback function which start address is the value of the 3rd argument of the D2DLL_RegApp and passes the transmission result on to the user application Multiple tasks can call the packet transmission request API function at the same time In this case the callback function should be devised because it is necessary which user task should be passed the transmission result For example you can identify which user task should be passed the transmission 35 D2DL USER S MANUAL result by using the member sessionTag in the transmission API structure The example cases are as follows Example 1 The multiple user tasks use the same
67. port number for transmission Example 2 The multiple user tasks use the different port number for transmission but use the same callback function In these cases you can identify the task to pass the transmission result by setting the unique sessionTag to each user task i e including the user task ID to a part of the sessionTag etc User Application D2DLL Send Receive the transmission request Execute the transmission process Wait the transmission result Callback function From dozens of milliseconds to several seconds Get the transmission result 36 D2DL USER S MANUAL 7 2 1 2 Getting the received packet The method to get the received packet is determined by the 2nd argument of the D2DLL_RegApp function Case The 2nd argument of the D2DLL RegApp 15 NULL The reception API function D2DLL_Recv gets the received packet The reception waiting time can be set by the argument rcvTimeout of D2DLL Recv function the revTimeout is D2DLL_NOWAIT 0x0000 The D2DLL_Recv function is terminated whether there is a received packet or not when it is called User Application D2DLL_Recv Get the reception result If the revTimeout is D2DLL_INFINITE OxFFFF If there is not a received packet the D2DLL_Recv waits of the packet reception internally forever When the packet is received the function is terminated If there is a received packet when the fu
68. pp cfg This is a configuration file for the real time OS MR30 It defines the system tasks flags semaphores and so on Please add the definition for the user application after checking the notes Please refer to the section 7 2 4 for details eeprom 16 This is a file for EEPROM I F which includes the function to access the EEPROM Use the example program in combination with different hardware please modify this file to be fitted to the corresponding EEPROM and the communication I O specification of the M16C 6S For details please refer to 5 3 Inc D2DII h This is a header file which contains prototype declarations of the D2DL APIs and data types Please include this file into the C source files for the User Application Program valType h This is a header file which contains basic data type declarations Please include this file before including D2DII h into the C source files for the User Application d2dll lib This is a library file of D2DL d2dll mrc This is a system call file which includes the RTOS system call used in the D2DL library 34 D2DL USER S MANUAL 7 2 Implementation method This section describes the necessary information required to develop programs using the D2DL 7 2 Transmission and Reception Sequence The user application may need the following features Getting the transmission result of the requested packet Getting the received packet The D2DL provides the next t
69. pplications the User Task C transmits via port 1 and the User Task D transmits via port 2 The task priorities assume the same User Task C User Task D D2DL process WAIT state gt to s veral seconds N A Mm r ON 7 8 9 10 11 41 D2DL USER S MANUAL T 8 9 10 11 Wake up the User Task C Call the transmission function and then move to the D2DL process Start the transmission process of the D2DL port 1 Return the function result to the User Task C because the transmission result will be passed by the callback function The User Task C waits for the transmission result Wake up the User Task D because the User Task C and the D2DL task are in the WAIT state Call the transmission function and move the D2DL process Start the transmission process of the D2DL port 2 Return the function result to the User Task D because the transmission result will be passed by the callback function The User Task D waits the transmission result Both of the User Task C and D return from the D2DL transmission function Wait the transmission result for port 1 and port 2 When the transmission result is determined form the port 1 the D2DL calls the callback function to indicate the User Task C The User Task C gets the transmission result by callback function its process has done and exits Wait the transmission result for the port 2 When the transmission result is determined fo
70. r EEPROM I F which includes the function to access to Yes EEPROM If you use the different hardware with the example program please modify this file to be fitted to your EEPROM and the communication I O specification of M16C 6S For details please refer 5 3 D2DII h This is a header file which contains declarations for prototype of D2DL APIs No and data types Please include this file into your C source files for the User Application Program valType h This is a header file which contains declarations for basic data types of each No API function Please include this file before including D2DII h into your C source files for User Application ThisisalibrayfileforD2DL NT kemll ib This is a library file for MiniRTOS of D2DL kernel2 lib This is a library file for MiniRTOS of D2DL 24 D2DL USER S MANUAL 6 2 Implementation method This section describes the necessary information when you develop the program using the D2DL 6 2 1 Transmission and Reception Sequence The user application may need the following features Getting the transmission result of the requested packet Getting the received packet The D2DL provides the next two methods to support above features The user application can get the information via callback function that is called by D2DL The user application can get the information by calling the API function The user application can get the inform
71. res teneret da 15 4 6 Brror Codes 17 5 Development of the User Application For both edition een 18 4 Initialize Seguenos anrr eene a Er EAE Ese ee Ra an taa EE ERR 18 52 Handling the internal parameters for the 2 19 5 3 EEPROM interface process resinas micras e iaa 22 5 4 Configuration of the protocol anie nene nennen ener nennen nns 22 5 5 Notes on using the CNC servicial su Enna 22 5 6 LED port assignment 22 tete teatri A a 23 6 Development the User Application Single Task Edition eee enn 24 6 1 Example program organization a aE nnne nnn 24 6 22 Implementation method id 25 6 2 1 Transmission and Reception Sequence nennen nns 25 6 2 1 1 Getting the packet transmission result eese 25 6 2 1 2 Getting the received packet err iHe Re eU nn EE ERR nn ERR nn ERR Rn eS 26 6 2 1 3 Restrictions on using the reception function 28 6 2 2 Addition of the Interrupt 28 6 2 3 Configuration of the D2DL Heap nnns 30 6 2 4 Configuration 32 CCo E 33
72. rm the port 2 the D2DL calls the callback function to indicate the User Task D The User Task D gets the transmission result by callback function its process has done and exits The process of the User Task C and the User Task D have done If it wakes up the tasks User Task C and D together which use the callback for reception there is no action corresponding to the transmission function process from 1 to 5 The timing of the User Task waking up and waiting and the action of the callback function are the same with the case of the transmission Every port can use the same transmission callback function registered for each port In this case you should identify the User Task to pass the transmission result in the callback function The sessionTag is used for identification for example the port number is set in the low 8 bits of the sessionTag It can be identified by the port ID dstPortId of the destination application in the received data for the reception callback function Case there are the packet transmission task and the packet reception task It simply describes to show the action when it wakes up the reception task User Task E and the transmission task User Task F together It assumes that both of the User Task E and the User Task F do not use the callback function The User Task E calls the reception API with the wait setting D2DLL INFINITE The task priorities assume the same Packet Recept
73. s between each node D2DLL Test Program V1 00 Copyright Renesas Technology Corporation and Renesas Solutions Corporation lt lt note gt gt Use Number key amp Back space Enter Network ID 1 1023 7 Enter Source Node ID 1 2047 2 Enter Destination Node ID 1 2047 gt 5 D2DLL Initialize Successful 1 Transmit 100packets by UniCast 40byte 2 Transmit 100packets by BroadCast 40byte 3 Transmit 500packets by UniCast 40byte 4 Transmit 500packets by BroadCast 40byte 5 Count Received Packets Select Mode gt 8 2 General flowchart Main WorkerThread Transmission terminate Is any key pressed Callback function Transmission result callback function Reception callback function 53 D2DL USER S MANUAL 8 3 Details of the program 8 3 1 Main function Main WorkerThread 8 3 1 1 Flowchart D void Main WorkerThread void 8 3 1 2 Details of the function E EE Initialize Uart amp LED _Uart_Init Select NetID NodeID printf n n prints D2DLL Test Program V1 00 Xn printf Copyright Renesas Technology Corporation andYn printf Renesas Solutions CorporationYnYn printf lt lt note gt gt Use Number key amp Back space YnYn Inpu
74. s of milliseconds to several seconds 25 D2DL USER S MANUAL Case The 3rd argument of D2DLL RegApp is not NULL The API transmission function i e the D2DLL_Send etc terminates as soon as the transmission request is received in the D2DL The wait time does not occur After that when the transmission result is determined the D2DL calls the callback function which start address is the value of the 3rd argument of the D2DLL_RegApp and passes the transmission result to the user application User Application D2DLL Send Receive the transmission request Execute the transmission process Wait the transmission result Callback function From dozens of milliseconds to several seconds Get the transmission result S 6 2 1 2 Getting the received packet The method to get the received packet is determined by the 2nd argument of the D2DLL_RegApp function Case The 2nd argument of the D2DLL RegApp is NULL The reception API function D2DLL_Recv gets the received packet The reception waiting time can be set by the argument rcvTimeout of the D2DLL_Recv function the revTimeout is DZDLL NOWAIT 0x0000 The D2DLL function is terminated whether there is a received packet or not when it is called User Application D2DLL Get the reception result Ifthe revTimeout is D2DLL INFINITE OxFFFF If there is not a received packet the D2DLL_Recv waits of
75. set by the function D2DLL SetParam Both of them should be set First the configuration by means of crtOmr a30 is described Please set the size of your heap area to the following gray shaded line in crtOmr a30 in hexadecimal Do not change other item except this value in this file RAM TOP ADR EQU 400H RAM END ADR EQU 63FFH 24KB 400H ROM TOP ADR EQU 0E8000H 96K ROM start D2DLL HEAP AREA EQU 600H 9 d 25K Section allocation Define the global variable to be used by d2dll here GB i m g 2 11 StartOfHeap BLKW dl g d2dll EndOfHeap BLKW T glb g d2dll StartOfHeap glb g d2dll EndOfHeap initialize the global variables to be used by d2dll here GB mOV W 4t d2dll heap top 42411 StartOfHeap mov W __d2dll_heap_top D2DLL HEAP AREA d2dll EndOfHeap cmp w END ADR 4 d2dll EndOfHeap jgtu exit The g d2dll StartOfHeap is set to the top address of the heap area and the g d2dll EndOfHeap is set to the end address of the heap area These values are passed to the D2DL as the return value of the function HALMemMngS_GetFreeRAMStart and HALMemMngS GetFreeRAMEnd Therefore you should implement these functions in the user application You can use the source code of the example program without any changes The function for getting the start point unsigned HALMemMngS_G
76. ssion function API API name Parameter Return value Description D2DLL_Send sndParam srcPortId PortID of Normal D2DLL E OK This function transmits the data d2dll sndParam source Error D2DLL E PARAM Notes In the case of the Multi Task Edition each sndParam application D2DLL E TIMING task can call this function at the same time dsiNodeld Destination D2DLL E SYS However the function called later is set to WAIT Exin state internally by the semaphore function The argument fpOnTransmitted of the dstPortId Port ID of the D2DLL E NOACK 2DLL ADD fi p defi h f destination DOBLE E BLOKD D RegApp unction defines the pointer application the function to get the result of transmission D2DLL E NORESRC If it is set to NULL the result of transmission is sndData Transmission passed as a return value of the D2DLL Send data function therefore the D2DLL Send function sndDataLen Length of does not return until the transmission sequence is transmission completed data If the argument is not set to NULL i e it is set to sessionTag Packet ID the pointer to the callback function the result of sndPrty Transmission transmission is passed by the callback function In priority this case the D2DLL Send function returns soon sndAck ACK UNACK after issuing the transmission request to lower setting layer s extnsn Reserved This function can be called when the PLC for future communication is enabled by the D2DLL Online function D2
77. st argument The second argument D2DLL IDX PROTOCOL VER 70 Protocol number The example description is as follows d2dllResult D2DLL SetParam D2DLL IDX PROTOCOL VER 0x3B if d2dllResult DZDLL E OK while 1 Note Do not set the protocol number except 0 01 and Ox3B in current version If you use the user specific protocol number each product of the different company can communicate with each other because the same protocol number 0x3B is set Therefore it is recommended that you implement your measures for avoiding the interference between each product in the user application The default value of the protocol number is 0 01 Please refer to the section 5 2 about the handling of the initialization values 5 5 Notes on using the CNC service The device serial number DSN is used as the address in the CNC service The DSN is the unique 16bytes value which should be assigned to each node and it is stored in the EEPROM of each node The user application in the node that receives a CNC packet can recognize the source device by the source DSN that is included in the received packet The DSN should be assigned by the user to avoid overlappings between the CNC packet of the user products To achieve this necessity a customer number is assigned to each user which is included in the DSN 22 D2DL USER S MANUAL The customer numbers are managed in Renesas Solutions Corp Please contact to the following e mail address if
78. t NetID NodeID printf Enter Network ID 1 1023 NetID UartStrGet str src LNetId str2DN str en 4 printf Enter Source Node ID 1 2047 gt Src NodeID UartStrGet str src NodeId str2DN str printf Y n printf Enter Destination Node ID 1 2047 Dst NodeID UartStrGet str dst NodeId str2DN str printf n n printf D2DLL Initialize 54 D2DL USER S MANUAL D2DLL initialize d2dllResult D2DLL Init NULL if d2dllResult D2DLL E OK while TRUE printf Failed YnYn e Application Register d2dllResult D2DLL RegApp User Receive CB User SendResul if d2dllResult D2DLL E while TRUE printf Failed XnYn 1 D2DLL Start dsn 0 uchar src NodeIg dsn 1 uchar src NodeId 8 d2dllResult D2DLL Start src LNetId D2DLL REGION JPN dsn OK D2DLL DIS R if d2dllResul D2DLL E while TRUE printf Failed YnYn Lt Set the Protocol Version d2dllResult D2DLL SetParam D2DLL IDX PROTOCOL V if d2dllResult D2DLL E OK while TRUE printf Failed YnYn 0x3B ER P Set the size of DLL Memory d2dllResult D2DLL IDX DLL 916 4 D2DLL_SetParam if d2dl
79. tarts to run The occurrence frequency of this D2DL interrupt process which includes the D2DL task process depends on the amount of PLC packets 6 3 22 Notes on the interrupt Ifthe processing time of the interrupt process of the user application meets one of the following conditions we recommend enabling multiple interrupt with a priority level of 3 or more Without enabling this some packets might be lost Condition 1 the processing time of one interrupt process of the user application is 100 us or more and its interrupt may occurs in a 2 4 ms interval or less Condition 2 the processing time of one interrupt process of the user application is longer than 500 us The interrupt processing time of the D2DL and its occurrence timing are as shown Trigger of the Function Name Processing Time Occurrence Timing Interrupt SI O4 D2dll PhyRx PhyUsartISR 20 us 500 us The transmission and reception INTO D2dll Phy ISR 20 us 120 us on the PLC In other case it TAO D2dll Timer ISR 30 us 90 us may occur at random times by TAI D2dll ISR 10 us or less the reception of the noise Notes The SI O4 interrupt process takes about 500 us only in case of the reception for the top byte of the packet In other case the process takes about 20 us e To disable the interrupt in the user application please select one of the following methods I Disable the interrupt by the operation of t
80. the Multi Task based programming technique with RTOS feature Note Please refer to the section 5 3 for the EEPROM interface D2DL USER S MANUAL 2 4 Theresources for the D2DL The following table shows the microcomputer resources for the D2DL D2DL Single Task Edition D2DL Multi Task Edition 41Kbytes including RTOS 41 Kbytes including RTOS The user application can set the RAM usage The user application can set the RAM usage i e the size of the buffer for the i e the size of the buffer for the transmission and reception packets transmission and reception packets The sample program are using 6 5KB The sample program are using 6 5KB RAM RAM Timer TAO TAI TA2 TAO TA1 TA2 The RTOS uses the TA2 Serial I O SI O4 SI O4 Using for the internal interfaces between Using for the internal interfaces between the D2DL and the IT800PHY the D2DL and the IT800PHY DMAI DMAI Using for the internal interfaces between Using for the internal interfaces between the D2DL and the IT800PHY the D2DL and the IT800PHY I O Port P4 P5 P4 P5 Using for the internal interfaces between Using for the internal interfaces between the D2DL and the IT800PHY the D2DL and the IT800PHY Interrupt Refer the next table Refer the next table The following table shows the details of the interrupts for the D2DL Causes of Function name Usage Priority interrupts SI O4 2 PhyRx PhyUsartISR The communication
81. the packet reception internally forever When the packet is received the function is terminated If there is a received packet when the function is called it is terminated immediatley While waiting for the received packet the task which calls the D2DLL function has been in the 26 D2DL USER S MANUAL sleep status In this period the other task runs in the Multi Task Edition but in the Single Task Edition the user task stops If there is already a received packet when the User function is called it returns Application directly D2DLL Wait forever until the packet reception Packet reception return Get the reception result If the revTimeout is neither D2DLL_NOWAIT 0x0000 D2DLL INFINITE OxFFFF If there is a packet when the D2DLL_Recv is called it is terminated immediatley If there is not a received packet it waits of the packet reception for the specific period which is set in rcvTimeout Unit msec and it is terminated on the packet reception If it does not receive a packet until the specific time is expired then the function is terminated While waiting for the received packet the task which calls the D2DLL_Recv function has been in the sleep status In this period the other task is running in the Multi Task Edition but in the Single Task Edition the user task stops If there is already a received User packet when the function is called Application it returns directl
82. to the specific process in the specific node In the case of using the packet receive callback function for details please refer to the section 6 and 7 the D2DL sorts the received packet to the destination application 3 2 2 4 Protocol number The D2DL keeps the coexistence of any products which implement different upper protocol by using the protocol number The nodes which use the same protocol number can communicate with each other but the nodes which use different protocol number cannot For example when there are two nodes which have the same address network ID and node ID on the line they can keep the coexistence if each of them uses the different protocol number If you want to use this feature you should set up the protocol number according to your protocol For details please refer to section 5 4 3 2 5 Media Access Control The D2DL supports the channel access control based on the CSMA CA Carrier Sense Multiple Access with Collision Avoidance It implements an adaptive back off algorithm The algorithm estimates the number of nodes which contend the channel priority and optimizes the packet transmission interval The transmission priority of the packet can be set up to 4 different priority levels High Normal AboveLow Low But the user application can only set 3 priority levels High Normal Low for the transmission packet The priority AboveLow is assigned automatically to the fragmented packets so this cannot be set b
83. unication feature This section describes the PLC communication feature of the D2DL 3 2 1 Packet delivery service This section describes the D2DL feature about the packet delivery 3 2 1 1 ACK UNACK service The ACK service allows for checking the accession of the transmitted packet at the target node the destination node The target node which receives the ACK service packet sends an ACK packet which shows the successful reception The source node recognizes the transmission success by the reception of the ACK packet If the source node cannot receive the ACK packet it retransmits the packet predefined times If the retransmission failed in the predefined times an error is returned to the user application The UNACK service does not check the ACK packet It can transmit a packet predefined times to improve the reliability In this case the D2DL transfers a received packet only once to the user application regardless of whether the destination node receives the same packet a number of times The retransmission times of each service can be set by the API function D2DLL SendOption 3 2 1 2 Broadcast service The single network broadcast service can transmit a packet to all nodes in the same logical network which node has the same network ID The CNC Control Network Channel service can transmit a packet to all nodes in the physical network regardless of the network ID even if the node does not have any network ID It is useful when it
84. up file the following folders are created on the PC Folder Name Description d2dllApp m This is a work space folder where the HEW work space file hws is located The development of own programs should be based on the example program using this work space file in the HEW D2dllApp_Vxxxs Note This is a project file where the project information are stored Debug The debug configuration information including the build option information etc are stored here After the build process the Output file is also located here Release Not used src There are some source files of the example program app See below eeprom inc lib Note xxx is a version number Following table shows each file in the src folder Please develop your application by modifying UserMain c and D2DLLApp cfg Folder File Name Description Langu Modifi Name age Jable app C Yes i This is an example source file for the User Application Program The function named Main_WorkerThread is like a function main in a C program Programming own application please modify this function and add sub functions here This is a source file of the startup process and also for the heap area which ASM Yes is used by D2DL library To change the size of the heap area please change this file and do not change the other configurations is a section definition file Do not change D2DLLA
85. wo methods to support above features The user application can get the information via callback function that is called by the D2DL The user application can get the information by calling the API function The user application can get the information from the D2DL by using either one of two methods This section describes each method When there is a user application task it runs as the single task edition 7 2 1 1 Getting the packet transmission result The method to get the transmission result is determined by the 3rd argument of D2DLL_RegApp function Case The 3rd argument of the D2DLL_RegApp is NULL The transmission result is passed by the return value of the packet transmission request API function e the D2DLL Send etc Therefore the transmission function does not return until the transmission result has been determined It may take dozens of milliseconds up to several seconds to determine the transmission result according to the condition of the line and the destination node The task which calls the D2DLL Send function has been in the sleep status until the transmission result has determined In this period the other task runs When the transmission result is determined the user task runs again The priority of the user task should be lower than the internal tasks of the D2DL Multiple tasks can call the packet transmission request API function at the same time However until the user task which calls the functi
86. y D2DLL_Recv The specific time period which is set in rcvTimeout return time out Get the reception result It returns if there is a received packet in this period Case The 2nd argument of the D2ZDLL_RegApp is not NULL The received packet is passed to the user application by the callback function from the D2DL In this case the D2DLL Recv function is not needed 27 D2DL USER S MANUAL User Application Packet reception Callback function When the packet is received the D2DLL calls the callback Get the reception result function In the environment in which there are some application port on the D2DL the function which is registered in each application is called back in case of the packet reception callback function However in case of the D2DLL_Recv function it cannot assign the received packet to each destination application If you use the D2DLL Recv function in the multiple application environment please implement the assignment process for each application by checking the dstPortId destination port ID in the received data 6 2 1 3 Restrictions on using the reception function When the user application receives the packet by the packet reception function D2DLL not the callback function the D2DLL_Recv function should be called at short intervals as the following Region Maximum call interval U S A FCC 50ms Japan ARIB 90ms Europe CENELEC
87. y the user application 3 24 Virtual Jamming Imposter node detection feature The D2DL supports a feature to detect the packet from the imposter node attempting to get into the network using the address of a valid node The D2DL passes the received packet from the imposter node as the imposter packet to the user application if you have set the received packet type as the imposter packet by the D2DLL Start function D2DL USER S MANUAL 3 3 EEPROM Control feature The D2DL can store internal parameters to the EEPROM Therefore it enables keeping the value of various parameters even if the power is shut down and managing the dedicated serial number per each device etc Additionally the user application can use available areas which is not used by the D2DL The D2DL uses the top of 672 bytes of EEPROM area so the application can use the subsequent area EEPROM The area for the D2DL 672bytes The area for the user Rest of the area The D2DL provides the API for the user area access therefore the user application can access the user area easily Please refer to section 5 2 about the data to write to the area for the D2DL 10 D2DL USER S MANUAL 4 API overview Developers of application software can develop the program using the D2DL APIs The application can access to the D2DL via the dedicated API functions The API functions for the D2DL and the structures used as the arguments for the API functions are described in this s
88. you want to use the CNC service Then you will receive an e mail in response which includes your customer number and its information of implementation Email address plcsupport renesas com 5 6 LED port assignment The control signal of LED which indicates the packet reception can be assigned to any I O port If you implement the following functions in the user application you can activate the LED on receiving the packet void D2DLL CB RxLEDon void LED ON for receiving void D2DLL RxLEDoff void LED OFF for receiving Please do not write any process to go through quickly except the process of the LED ON OFF because these functions are called by the interrupt handler If you do not need the LED for receiving please make the functions empty For the LED transmission control you can use the TS Pin31 of M16C 6S so it needs not to be controlled by software The example circuit for LED control using the TS is shown as follows TS 23 D2DL USER S MANUAL 6 Development the User Application Single Task Edition This section describes about the necessary information to develop the user application with the D2DL of the single task edition 6 1 Example program organization It is recommended that you develop the user application program based on the D2DL example program The project of the example program corresponds with the RENESAS HEW High performance Embedded Workshop When you execute the D2DL setup file the

M16C/6S DATA LINK LAYER LIBRARY D2DLL USER`S MANUAL

Contents

Download Pdf Manuals

Related Search

Related Contents