View NUC130RE3CN_7791884.PDF datasheet online --- IC-ON-LINE

Datasheet File OCR Text:

n umi cro tm n uc1 00 seri es d ri ver r ef er en ce g uide v 1 .0 5 . 00 1 publication release date: june . 20 1 1 support chips: support platforms: numicro tm nuc100 series nuvoton pdf create 8 trial www.nuance.com http://
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 2 - th e i n fo r ma t i o n i n th i s d o cum e n t i s sub j e ct to cha n g e wi t h o u t noti ce . th e n u v o t o n te chn o l o g y co r p . sha l l not be l i ab l e f o r te chn i ca l o r e d i t o r i al e r r o r s o r o mi ss i o n s co n t ai n e d her e i n ; nor f o r i n ci d e n t a l o r c o n se q u e n t i a l dam ag e s r e sul t i n g fr o m t h e furn i shi n g , p e r f o r ma n c e , o r use o f t h i s ma t e r i a l . th i s d o cum e n t at i o n ma y n o t , i n wh o l e o r i n p ar t , b e c o p i e d , p h o t o c o p i e d , r e p r o d u c e d , t r an sl at e d , o r r e d u c e d t o an y e l e ctr o n i c medi u m o r ma chi n e - r e ad ab l e f o r m wi t h o u t p r i o r c o n s e n t , i n wr i t i n g , fr o m t h e nu vo t o n t e chn o l o g y co r p . nu vo t o n te chn o l o g y c o r p . al l r i g h t s r e s e r v e d . pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 3 - table of contents 1. ov er v i e w ................................ ................................ ................................ ................ 18 1.1. or g a niz a ti on ................................................................ ................................ ......................... 18 1.2. r e lative d oc uments ................................ ................................ ............................................. 18 1.3. abbr e viations a nd gloss a rie s ................................ ................................ .............................. 18 1.4. da ta t y pe d e finiti on ................................ ................................ ........................................... 20 2. sy s d ri v er ................................ ................................ ................................ ............. 21 2.1. i ntrodu c ti on ................................................................ ................................ .......................... 21 2.2. c lock d iagr a m ................................ ................................................................ ..................... 22 2.3. t y pe de finiti on ................................ ................................................................ .................... 23 e _ sys_ i p _ r st ................................ ................................ ................................ ................................................ 23 e _ sys_ i p _ c l k ................................ ................................ ................................ ................................ ............... 23 e _ sys_ p l l _ c l ks r c ................................ ................................................................ ................................ .... 24 e _ sys_ i p _ di v ................................ ................................ ................................ ................................................ 24 e _ sys_ i p _ c l ks r c ................................................................ ................................ ................................ ....... 24 e _ sys_ c hi p _ c l k sr c ................................ ................................................................ ................................ .. 25 e _ sys_ p d_ t yp e ................................ ................................ ................................ ................................ ........... 25 2.4. f unc ti ons ................................ ................................ ................................ .............................. 25 dr v sys_ r ea d p r o d u cti d ................................ ................................................................ ................................ .. 25 dr v sys_ get r e s etso u r ce ................................ ................................................................ ................................ . 26 dr v sys_ c lear r e s etso u r ce ................................ ................................ ................................ .............................. 26 dr v sys_ r eseti p ................................ ................................ ................................ ................................ .............. 27 dr v sys_ r eset c p u ................................................................ ................................ ................................ .......... 28 dr v sys_ r eset c h ip ................................................................ ................................ ................................ .......... 28 dr v sys_ selectb odvo lt ................................ ................................................................ ................................ .. 29 dr v sys_ setb odf u n ct io n ................................ ................................................................ ............................... 29 dr v sys_ e n ab leb odl o w p o w er mo d e ................................ ................................ ............................................. 30 dr v sys_ d is ab leb od l o w p o w er mo d e ................................ ................................ ................................ ............ 31 dr v sys_ e n ab lel o w vo lt r ese t ................................ ................................ ................................ ......................... 31 dr v sys_ d is ab le l o w vo ltr e s et ................................ ................................ ................................ ....................... 32 dr v sys_ getb od state ................................ ................................................................ ................................ ..... 32 dr v sys_ e n ab let em p er atu r e sen s o r ................................ ................................ ................................ ................. 33 dr v sys_ d is ab let em p er at u r esen s o r ................................ ................................ ................................ ............... 33 dr v sys_ u n lo c k p r o tecte d r eg ................................ ................................ ................................ .......................... 34 dr v sys_ l o ck p r o tecte d r eg ................................ ................................ ................................ ............................. 34 dr v sys_ i s p r o tecte d r eg l o c k ed ................................ ................................ ................................ ...................... 35 dr v sys_ e n ab lep or ................................ ................................ ................................ ................................ ........ 36 dr v sys_ d is ab lep or ................................................................ ................................ ................................ ....... 36 dr v sys_ seti p c lo ck ................................ ................................ ................................ ................................ ......... 37 pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 4 - dr v sys_ selecth c l kso u r ce ................................ ................................ ................................ ........................... 38 dr v sys_ selects y s t ick so u r ce ................................ ................................ ................................ ......................... 38 dr v sys_ selecti p c lo ck so u r ce ................................ ................................ ................................ ......................... 39 dr v sys_ setc lo c k di v id er ................................ ................................ ................................ ................................ 41 dr v sys_ setos c c tr l ................................ ................................ ................................ ................................ ......... 41 dr v sy s_ setp o w er do w n w a k eup i n t ................................ ................................ ................................ ............... 42 dr v sys_ e n ter p o w er do w n ................................ ................................ ................................ .............................. 43 dr v sys_ selectp l l so u r ce ................................ ................................................................ ............................... 44 dr v sys_ setp l l mo d e ................................ ................................................................ ................................ ..... 44 dr v sys_ gete x t c lo ck fre q ................................ ................................................................ ............................... 45 dr v sys_ getp l l c o n ten t ................................ ................................................................ ................................ . 45 dr v sys_ setp l l c o n te n t ................................ ................................................................ ................................ .. 46 dr v sys_ getp l l c lo c k fre q ................................ ................................ ................................ ............................. 46 dr v sys_ get hc l k fre q ................................ ................................ ................................ ................................ ... 47 dr v sys_ op e n ................................................................ ................................ .................................................. 47 dr v sys_ setfre q div id er ou tp u t ................................ ................................ ................................ ....................... 48 dr v sys_ e n ab lehi g h p er f o r m an ce mo d e ................................ ................................ ................................ .......... 49 dr v sys_ d is ab lehi g h p er f o r m an ce mo d e ................................ ................................ ................................ ......... 50 dr v sys_ dela y ................................ ................................ ................................ ................................ ................. 50 dr v sys_ get c h ip c lo c k so u r c esta tu s ................................ ................................ ................................ ............... 51 dr v sys_ get c lo c k s w itc h s tat u s ................................ ................................ ................................ ....................... 52 dr v sys_ c lear c lo c k s w i tch st atu s ................................ ................................ ................................ .................... 52 dr v sys_ get ver s io n ................................ ................................ ................................ ................................ ........ 53 3. u a r t d ri v er ................................ ................................ ................................ ......... 54 3.1. ua r t i ntroduc ti on ................................ ................................ .............................................. 54 3.2. ua r t f e a ture ................................................................ ................................ ...................... 54 3.3. c onst a nt de finiti on ................................ ................................ .............................................. 55 3.4. t y pe de finiti on ................................ ................................................................ .................... 55 e _ uart _ p or t ................................ ................................ ................................ ................................ ............... 55 e _ i n t _ sour c e ................................................................ ................................ ............................................. 55 e _ da t a b i t s_ se t t i ngs ................................ ................................ ................................ ............................. 55 e _ p a r i t y_ se t t i ngs ................................ ................................ ................................ ................................ ... 55 e _ st o p b i t s_ se t t i ngs ................................ ................................................................ ............................... 56 e _ fifo_ set t i ngs ................................ ................................ ................................ ................................ ........ 56 e _ uart _ func ................................ ................................ ................................ ................................ .............. 56 e _ mo de _ r s4 8 5 ................................................................ ................................ ............................................. 56 3.5. mac ros ................................ ................................ ................................ ................................ .. 57 _ dr vu ar t _ sen db y t e ................................ ................................ ................................ .............................. 57 _ dr vu ar t _ r e c e i ve b yt e ................................ ................................ ........................................................ 57 _ dr vu ar t _ se t _ di vi de r ................................ ................................ ................................ .......................... 57 _ dr vu ar t _ r e c e i ve a v a i l a b l e ................................ ................................ ................................ ........... 58 _ dr vu ar t _ w a i t _ t x_ e m pt y ................................ ................................ .................................................. 58 3.6. f unc ti ons ................................ ................................ ................................ .............................. 59 dr v u ar t _ op en ................................ ................................ ................................ ................................ ............... 59 drvuart_close ................................ ................................ ................................ ................................ .............. 61 drvuart_enableint ................................ ................................ ................................ ................................ ........ 61 drvuart_ disableint ................................................................ ................................ ................................ ....... 62 pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 5 - dr v u ar t _ c lear i n tfl ag ................................ ................................ ................................ ................................ ... 63 dr v u ar t _ geti n tst atu s ................................ ................................ ................................ ................................ ... 64 dr v u ar t _ getct sin f o ................................ ................................................................ ................................ .... 65 dr v u ar t _ setr t s ................................ ................................ ................................ ................................ ........... 66 dr v u ar t _ r ea d ................................ ................................ ................................ ................................ ............... 67 dr v u ar t _ w r ite ................................ ................................ ................................ ................................ .............. 68 dr v u ar t _ e n ab lep dm a ................................ ................................................................ ................................ . 69 dr v u ar t _ dis ab lep dm a ................................ ................................ ................................ ................................ 69 dr v u ar t _ setf n i r d a ................................ ................................................................ ................................ .... 70 dr v u ar t _ setfn r s4 8 5 ................................ ................................ ................................ ................................ ... 71 dr v u ar t _ setfn l i n ................................................................ ................................ ................................ ....... 72 dr v u ar t _ getve r s io n ................................ ................................................................ ................................ ..... 73 4. ti m er / wd t d r i v e r ................................ ................................ ............................ 74 4.1. t i mer /w dt i ntroduc ti on ................................ ................................ ................................ .. 74 4.2. t i mer /w dt fea ture ................................ ................................ ................................ .......... 74 4.3. t y pe de finiti on ................................ ................................................................ .................... 74 e _ t i me r _ c hann e l ................................ ................................................................ ................................ .... 74 e _ t i me r _ op mo de ................................................................ ................................ ................................ ....... 75 e _ t i me r _ t x_ p ha se ................................ ................................................................ ................................ .... 75 e _ t i me r _ t e x_ e dge ................................ ................................ ................................ ................................ ... 75 e_ t i me r _ r st c a p _ mo de ................................ ................................ ................................ ........................... 75 e_ w d t _ c md ................................................................ ................................ .................................................. 75 e_ w d t _ i n t e r val ................................................................ ................................ ................................ ....... 76 4.4. f unc ti o ns ................................ ................................ ................................ .............................. 76 dr v t i me r _ i n it ................................ ................................ ................................ ................................................ 76 dr v t i me r _ op en ................................................................ ................................ ............................................. 77 dr v t i me r _ c lo s e ................................................................ ................................ ............................................. 78 dr v t i me r _ sett im er e v e n t ................................ ................................ ................................ .............................. 78 dr v t i me r _ c lear t im er e v e n t ................................ ................................ ................................ .......................... 79 dr v t i me r _ e n ab lei nt ................................ ................................ ................................ ................................ ...... 80 dr v t i me r _ dis ab lei n t ................................ ................................................................ ................................ ..... 80 dr v t i me r _ geti n tfl a g ................................ ................................................................ ................................ .... 81 dr v t i me r _ c le ar i n tfl a g ................................ ................................................................ ................................ .. 81 dr v t i me r _ star t ................................ ................................ ................................ ................................ .............. 82 dr v t i me r _ geti n tt ick s ................................ ................................ ................................ ................................ ... 82 dr v t i me r _ r eseti n tt ick s ................................ ................................ ................................ ................................ 83 dr v t i me r _ dela y ................................ ................................ ................................ ................................ ............ 83 dr v t i me r _ op en c o u n ter ................................ ................................ ................................ ................................ 84 dr v t i me r _ star tc o u n ter ................................ ................................................................ ................................ . 85 dr v t i me r _ getco u n ter s ................................ ................................................................ ................................ .. 85 dr v t i me r _ op en c ap tu r e ................................ ................................ ................................ ................................ 86 dr v t i me r _ c lo s ecap tu r e ................................ ................................ ................................ ................................ 87 dr v t i me r _ selecte x ter n al m o d e ................................ ................................ ..................................................... 87 dr v t i me r _ selectcap tu r ee d g e ................................ ................................ ................................ ....................... 88 dr v t i me r _ e n ab lec ap tu r ei n t ................................ ................................ ................................ .......................... 89 dr v t i me r _ dis ab lec ap tu r ei n t ................................ ................................ ................................ ......................... 89 dr v t i me r _ e n ab lec ap tu r e ................................ ................................ ................................ .............................. 90 dr v t i me r _ dis ab lec ap tu r e ................................ ................................ ................................ ............................. 90 dr v t i me r _ getcap tu r eda ta ................................ ................................................................ ............................ 91 pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 6 - dr v t i me r _ getcap tu r ei n t fla g ................................ ................................ ........................................................ 92 dr v t i me r _ c lear c ap tu r ei n t f lag ................................ ................................ ..................................................... 92 dr v t i me r _ e n ab lec ap tu r ede b o u n ce ................................ ................................ ................................ .............. 93 dr v t i me r _ dis ab lec ap tu r ed eb o u n ce ................................ ................................ ............................................. 94 dr v t i me r _ e n ab lec o u n ter d eb o u n ce ................................ ................................ ................................ .............. 94 dr v t i me r _ dis ab lec o u n ter d eb o u n ce ................................ ................................ ............................................. 95 dr v t i me r _ selectco u n ter det ec tp h ase ................................ ................................ ................................ ........... 96 dr v t i me r _ getve r s io n ................................ ................................ ................................ ................................ ... 96 dr v w dt _ op en ................................ ................................ ................................ ................................................ 97 dr v w dt _ c lo s e ................................ ................................ ................................ ................................................ 97 dr v w dt _ i n s talli sr ................................ ................................ ................................ ................................ ......... 98 dr v w dt _ i o ctl ................................................................ ................................ .................................................. 98 5. gp i o d ri v er ................................ ................................ ................................ ........ 1 0 0 5.1. gp i o introdu c ti on ................................ ................................................................ .............. 100 5.2. gp i o f e a ture ................................................................ ................................ ..................... 100 5.3. t y pe de finiti on ................................ ................................................................ .................. 100 e _ dr vgp i o_ p or t ................................ ................................ ................................ ................................ ...... 100 e_ dr vgp i o_ i o ................................ ................................ ................................ ................................ ............ 100 e_ dr vgp i o_ i nt _ t yp e ................................ ................................ ................................ .............................. 101 e_ dr vgp i o_ i nt _ mo de ................................ ................................ ................................ ............................ 101 e_ dr vgp i o_ db c l ks r c ................................ ................................ ................................ ........................... 101 e_ dr vgp i o_ func ................................................................ ................................ ................................ ..... 101 5.4. mac ros ................................ ................................ ................................ ................................ 102 _ dr vgp i o_ dout ................................ ................................ ................................ ................................ ....... 102 gp a _ [ n ] / g p b _ [ n ] / g p c _ [ n ] / g p d_ [ n ] / g pe_ [ n ] ................................ ................................ .................... 103 5.5. f unc ti ons ................................ ................................ ................................ ............................ 104 dr v gp i o_ op en ................................ ................................ ................................ .............................................. 104 dr v gp i o_ c lo s e ................................ ................................ ................................ .............................................. 105 dr v gp i o_ setb it ................................ ................................ ................................ ................................ ............. 105 dr v gp i o_ getb it ................................ ................................ ................................ ................................ ............ 106 dr v gp i o_ c lr b it ................................ ................................ ................................ ................................ ............. 107 dr v gp i o_ setp o r tb its ................................................................ ................................ ................................ ..... 107 dr v gp i o_ getp o r tb its ................................ ................................ ................................ ................................ .... 108 dr v gp i o_ getdo u tb it ................................ ................................ ................................ ................................ .... 108 dr v gp i o_ getp o r tdo u tb its ................................ ................................ ................................ ............................ 109 dr v gp i o_ setb itmask ................................ ................................ ................................ ................................ .... 110 dr v gp i o_ getb itmask ................................ ................................................................ ................................ ... 110 dr v gp i o_ c lr b itmask ................................ ................................ ................................ ................................ .... 111 dr v gp i o_ setp o r tma s k ................................ ................................................................ ................................ .. 112 dr v gp i o_ getp o r tma s k ................................ ................................................................ ................................ .. 112 dr v gp i o_ c lr p o r tma s k ................................ ................................................................ ................................ .. 113 dr v gp i o_ e n ab ledig ita li n p u t b it ................................ ................................ ................................................... 113 dr v gp i o_ dis ab ledig i tali n p u tb it ................................ ................................ ................................ .................. 114 dr v gp i o_ e n ab lede b o u n ce ................................ ................................ ................................ ............................ 115 dr v gp i o_ dis ab lede b o u n ce ................................ ................................................................ .......................... 115 dr v gp i o_ setdeb o u n ce t i m e ................................ ................................ ................................ ......................... 116 dr v gp i o_ getde b o u n ce sa m p lec y c le ................................ ................................ ................................ ............ 116 dr v gp i o_ e n ab lei n t ................................ ................................ ................................ ................................ ....... 117 pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 7 - dr v gp i o_ dis ab lei n t ................................ ................................ ................................ ................................ ...... 118 dr v gp i o_ seti n tc a llb ac k ................................ ................................................................ ............................... 119 dr v gp i o_ e n ab lee i nt 0 ................................ ................................ ................................ ................................ . 119 dr v gp i o_ dis ab lee i nt 0 ................................ ................................................................ ................................ 120 dr v gp i o_ e n ab lee i n t1 ................................ ................................ ................................ ................................ . 120 dr v gp i o_ dis ab lee i nt 1 ................................ ................................................................ ................................ 121 dr v gp i o_ geti n tst at u s ................................ ................................................................ ................................ ... 122 dr v gp i o _ i n itf u n ctio n ................................ ................................................................ ................................ ... 122 dr v gp i o_ getve r s io n ................................ ................................ ................................ ................................ .... 123 6. a d c d ri v er ................................ ................................ ................................ .......... 1 2 5 6.1. ad c i nt roduc ti on ................................ ................................................................ .............. 125 6.2. ad c f e a ture ................................................................ ................................ ...................... 125 6.3. t y pe de finiti on ................................ ................................................................ .................. 126 e _ a d c _ i np ut _ mo de ................................ ................................................................ ................................ 126 e _ a d c _ op e r a t i on_ mo d e ................................ ................................ ................................ ..................... 126 e _ a d c _ c l k_ sr c ................................................................ ................................ ................................ ........ 126 e _ a d c _ e xt _ t r i _ c ond ................................ ................................ ................................ ............................ 126 e _ a d c _ c h7 _ sr c ................................................................ ................................ ................................ ........ 126 e _ a d c _ c mp _ c ondi t i on ................................ ................................ ................................ ......................... 126 e _ a d c _ di ff _ mo de _ out p u t _ for m a t ................................................................ ............................... 126 6.4. mac ros ................................ ................................ ................................ ................................ 127 _ dr v a d c _ c onv ................................................................ ................................ ................................ ........ 127 _ dr v a d c _ ge t _ a dc _ i nt _ fla g ................................ ................................ ................................ ............ 127 _ dr v a d c _ ge t _ c mp 0 _ i n t _ fl a g ................................ ................................ ................................ .......... 128 _ dr v a d c _ ge t _ c mp 1 _ i n t _ fl a g ................................ ................................ ................................ .......... 128 _ dr v a d c _ c l e a r _ a d c _ i nt _ fl a g ................................ ................................ ................................ ....... 128 _ dr v a d c _ c l e a r _ c mp 0 _ i nt _ fl a g ................................ ................................ ................................ ..... 129 _ dr v a d c _ c l e a r _ c mp 1 _ i nt _ fl a g ................................ ................................ ................................ ..... 129 6.5. f unc ti ons ................................ ................................ ................................ ............................ 130 dr v a d c _ op en ................................ ................................ ................................ ................................ ............... 130 dr v a d c _ c lo s e ................................ ................................ ................................ ................................ ............... 131 dr v a d c _ set a d c c h a n n el ................................ ................................................................ ............................. 132 dr v a d c _ c o n f i g a d c c h a n n e l7 ................................ ................................ ................................ ..................... 132 dr v a d c _ set a d c i n p u tmo d e ................................ ................................ ................................ ........................ 133 dr v a d c _ set a d c op er atio n mo d e ................................ ................................ ................................................. 134 dr v a d c _ set a d c c l k src ................................ ................................................................ ............................... 134 dr v a d c _ set a d c di v is o r ................................ ................................ ................................ .............................. 135 dr v a d c _ e n ab le a d c i n t ................................ ................................................................ ................................ 135 dr v a d c _ dis ab le a d c i n t ................................ ................................................................ ............................... 136 dr v a d c _ e n ab le a d c c m p 0 i n t ................................ ................................ ...................................................... 137 dr v a d c _ dis ab le a d c c m p 0 i n t ................................ ................................ ................................ ..................... 138 dr v a d c _ e n ab le a d c c m p 1 i n t ................................ ................................ ...................................................... 138 dr v a d c _ dis ab le a d c c m p 1 i n t ................................ ................................ ................................ ..................... 139 dr v a d c _ getco n v er s io n r a te ................................ ................................ ................................ ........................ 140 dr v a d c _ e n ab lee x tt r ig g er ................................ ................................ ................................ ........................... 140 dr v a d c _ dis ab lee x tt r ig g er ................................ ................................................................ .......................... 141 dr v a d c _ star tc o n v er t ................................ ................................................................ ................................ ... 141 dr v a d c _ sto p c o n v er t ................................ ................................................................ ................................ ... 142 pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 8 - dr v a d c _ i s c o n v er s io n do n e ................................ ................................................................ .......................... 142 dr v a d c _ getco n v er s io n data ................................ ................................ ................................ ........................ 143 dr v a d c _ e n ab lep dm a ................................ ................................ ................................ ................................ . 143 dr v a d c _ dis ab lep dm a ................................ ................................................................ ................................ 144 dr v a d c _ i s data valid ................................ ................................ ................................ ................................ .... 144 dr v a d c _ i s data o v er r u n ................................ ................................................................ ................................ 145 dr v a d c _ e n ab le a d c c m p 0 ................................ ................................................................ .......................... 145 dr v a d c _ dis ab le a d c c m p 0 ................................ ................................ ................................ ......................... 146 dr v a d c _ e n ab le a d c c m p 1 ................................ ................................................................ .......................... 147 dr v a d c _ dis ab le a d c c m p 1 ................................ ................................ ................................ ......................... 148 dr v a d c _ e n ab lesel f c a lib r atio n ................................ ................................ ................................ .................... 148 dr v a d c _ i s c alib r atio n do n e ................................ ................................................................ .......................... 149 dr v a d c _ dis ab lesel f c alib r at io n ................................ ................................ ................................................... 149 dr v a d c _ dif f mo d eou tp u tfo r m at ................................ ................................ ................................................. 150 dr v a d c _ getve r s io n ................................................................ ................................ ................................ ..... 150 7. sp i d ri v er ................................ ................................ ................................ ............ 1 5 2 7.1. s p i i ntroduc ti on ................................ ................................................................ ................. 152 7.2. s p i f e a ture ................................................................ ................................ ......................... 152 7.3. t y pe de finiti on ................................ ................................................................ .................. 153 e_ dr vsp i _ p or t ................................ ................................ ................................ ................................ ......... 153 e _ dr vsp i _ mo de ................................................................ ................................ ................................ ........ 153 e _ dr vsp i _ t r a ns_ t yp e ................................ ................................ ................................ ........................... 153 e _ dr vsp i _ e ndi a n ................................ ................................ ................................ ................................ .... 153 e _ dr vsp i _ b y t e _ r e or de r ................................ ................................ ................................ ..................... 153 e _ dr vsp i _ ss l t r i g ................................ ................................................................ ................................ ... 154 e _ dr vsp i _ ss _ ac t _ t yp e ................................ ................................ ................................ ......................... 154 e _ dr vsp i _ sla ve _ se l ................................ ................................ ................................ .............................. 154 e_ dr vsp i _ dm a _ mo de ................................ ................................................................ ............................. 154 7.4. f unc ti ons ................................ ................................ ................................ ............................ 155 dr v sp i _ op en ................................ ................................ ................................ ................................ .................. 155 dr v sp i _ c lo s e ................................ ................................ ................................ ................................................. 156 dr v sp i _ set2 b ittr an s f er mo d e ................................ ................................ ................................ ........................ 157 dr v sp i _ seten d ian ................................ ................................ ................................ ................................ .......... 158 dr v sp i _ setb itl e n g th ................................................................ ................................ ................................ ..... 158 dr v sp i _ setb y ter eo r d er ................................ ................................ ................................ ................................ . 159 dr v sp i _ setsu s p en d c y cle ................................ ................................ ................................ .............................. 160 dr v sp i _ sett r ig g er mo d e ................................ ................................................................ ................................ 161 dr v s p i _ setsl av e select a cti v e l e v el ................................ ................................ ................................ ............... 162 dr v sp i _ getl e v elt r ig g er stat u s ................................ ................................ ...................................................... 163 dr v sp i _ e n ab leau to ss ................................ ................................................................ ................................ ... 164 dr v sp i _ dis ab leau to s s ................................ ................................................................ ................................ .. 165 dr v sp i _ setss ................................ ................................ ................................ ................................................. 165 dr v sp i _ c lr ss ................................ ................................ ................................ ................................................. 166 dr v sp i _ i s b u s y ................................ ................................ ................................ ................................ ............... 167 dr v sp i _ b u r s tt r an s f er ................................ ................................ ................................ ................................ .... 168 dr v sp i _ setc lo ck fre q ................................ ................................ ................................ ................................ .... 169 dr v sp i _ getcl o ck 1 fre q ................................ ................................................................ ................................ .. 170 dr v sp i _ getcl o ck 2 fre q ................................ ................................................................ ................................ .. 171 dr v sp i _ setvar iab lec lo ckfunction ................................ ................................ ................................................ 171 pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 9 - dr v sp i _ e n ab lei n t ................................................................ ................................ ........................................... 173 dr v sp i _ dis ab lei n t ................................ ................................ ................................ ................................ .......... 174 dr v sp i _ geti n tfl a g ................................ ................................ ................................ ................................ ......... 174 dr v sp i _ c lr i n tfl a g ................................ ................................ ................................ ................................ .......... 175 dr v sp i _ sin g ler ea d ................................................................ ................................ ................................ ........ 176 dr v sp i _ sin g lew r ite ................................ ................................ ................................ ................................ ....... 176 dr v sp i _ b u r s tr ea d ................................ ................................ ................................ ................................ ......... 177 dr v sp i _ b u r s tw r ite ................................ ................................ ................................ ................................ ......... 178 dr v sp i _ du m p r x r e g is ter ................................ ................................ ................................ .............................. 179 dr v sp i _ sett x r eg i s ter ................................ ................................................................ ................................ ... 179 dr v sp i _ setgo ................................................................ ................................ ................................................ 180 dr v sp i _ c lr go ................................................................ ................................ ................................................ 181 dr v sp i _ setp dm a ................................ ................................ ................................ ................................ .......... 182 dr v sp i _ setfifom o d e ................................ ................................................................ ................................ ... 183 dr v sp i _ i s r x e m p t y ................................................................ ................................ ................................ ........ 183 dr v sp i _ i s r x fu l l ................................ ................................ ................................ ................................ ............ 184 dr v sp i _ i s t x e m p t y ................................................................ ................................ ................................ ........ 185 dr v sp i _ i s t x fu ll ................................ ................................ ................................ ................................ ............. 186 dr v sp i _ c lr r x fifo ................................................................ ................................ ................................ ........ 187 dr v sp i _ c lr t x fifo ................................................................ ................................ ................................ ........ 188 dr v sp i _ e n ab lediv o n e ................................ ................................................................ ................................ ... 188 dr v sp i _ dis ab lediv on e ................................ ................................................................ ................................ .. 189 dr v sp i _ e n ab le3 w ir e ................................................................ ................................ ................................ ..... 190 dr v sp i _ dis ab le3 w ir e ................................ ................................ ................................ ................................ .... 190 dr v sp i _ 3 w ir ea b o r t ................................ ................................ ................................ ................................ ....... 191 dr v sp i _ e n ab le3 w ir estar ti n t ................................ ................................ ................................ ......................... 192 dr v sp i _ dis ab le3 w ir e star ti n t ................................ ................................ ................................ ........................ 193 dr v sp i _ get3 w ir estar ti n tfl ag ................................ ................................ ................................ ........................ 193 dr v sp i _ c lr 3 w ir estar ti n tfl a g ................................ ................................ ................................ ........................ 194 dr v sp i _ getve r s io n ................................................................ ................................ ................................ ........ 195 8. i 2 c d ri v er ................................ ................................ ................................ ............ 1 9 6 8.1. i 2c i ntrodu c ti on ................................ ................................................................ ................. 196 8.2. i 2c f e a tu re ................................................................ ................................ ......................... 196 8.3. t y pe de finiti on ................................ ................................................................ .................. 196 e _ i 2 c _ p or t ................................ ................................ ................................ ................................ .................. 196 e _ i 2 c _ c al l b a c k_ t yp e ................................ ................................................................ .......................... 196 8.4. f unc ti ons ................................ ................................ ................................ ............................ 197 dr v i 2 c _ op en ................................ ................................ ................................ ................................................. 197 dr v i 2 c _ c lo s e ................................ ................................ ................................ ................................................. 197 dr v i 2 c _ setc lo ck fre q ................................ ................................ ................................ ................................ .... 198 dr v i 2 c _ getcl o c k fre q ................................ ................................ ................................ ................................ .... 198 dr v i 2 c _ set a d d r ess ................................................................ ................................ ................................ ........ 199 dr v i 2 c _ set a d d r ess ma s k ................................ ................................................................ ............................... 200 dr v i 2 c _ getstat u s ................................................................ ................................ ........................................... 200 dr v i 2 c _ w r itedata ................................ ................................ ................................ ................................ ......... 201 dr v i 2 c _ r ea d data ................................ ................................ ................................ ................................ .......... 201 dr v i 2 c _ c tr l ................................ ................................ ................................ ................................ .................... 202 dr v i 2 c _ geti n t flag ................................ ................................ ................................ ................................ ......... 203 dr v i 2 c _ c lear i n t fla g ................................ ................................ ................................ ................................ ...... 203 pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 10 - dr v i 2 c _ e n ab lei n t ................................................................ ................................ ........................................... 204 dr v i 2 c _ dis ab lei n t ................................ ................................ ................................ ................................ ......... 204 dr v i 2 c _ i n s tal lc allb ac k ................................ ................................ ................................ ................................ . 205 dr v i 2 c _ un i n s tallc a llb ac k ................................ ................................................................ ............................. 205 dr v i 2 c _ sett i m eo u t c o u n ter ................................ ................................ ................................ ........................... 20 6 dr v i 2 c _ c lear t i m eo u tf lag ................................ ................................................................ ............................. 207 dr v i 2 c _ getve r s io n ................................................................ ................................ ................................ ........ 207 9. r tc d ri v er ................................ ................................ ................................ .......... 2 0 9 9.1. r tc i ntroduc ti on ................................ ................................................................ ............... 209 9.2. r tc f e a ture s ................................................................ ................................ ..................... 209 c onst a nt de finiti on ................................................................ ................................ .................... 210 9.3. t y pe de finiti on ................................ ................................................................ .................. 210 e _ dr vr t c _ i nt _ sour c e ................................ ................................ ................................ ......................... 210 e _ dr vr t c _ t i c k ................................................................ ................................ ................................ ........ 210 e _ dr vr t c _ t i me _ sel e c t ................................ ................................ ................................ ....................... 210 e _ dr vr t c _ dw r _ p ar a m e t e r ................................ ................................ .............................................. 211 9.4. f unc ti ons ................................ ................................ ................................ ............................ 211 dr v r t c _ setfre q u e n c y c o m p en s atio n ................................ ................................ ........................................... 211 dr v r t c _ i s l ea p yea r ................................ ................................ ................................ ................................ ...... 212 dr v r t c _ geti n tt ick ................................ ................................ ................................ ................................ ....... 212 dr v r t c _ r ese ti n tt ick ................................ ................................ ................................ ................................ .... 213 dr v r t c _ w r itee n ab le ................................ ................................ ................................ ................................ .... 213 dr v r t c _ i n it ................................ ................................ ................................ ................................................... 214 dr v r t c _ sett ick mo d e ................................ ................................................................ ................................ ... 214 dr v r t c _ e n ab lei n t ................................ ................................ ................................ ................................ ......... 215 dr v r t c _ dis ab lei n t ................................................................ ................................ ................................ ........ 216 dr v r t c _ op en ................................................................ ................................ ................................................ 217 dr v r t c _ r ea d ................................................................ ................................ ................................................ 218 dr v r t c _ w r ite ................................ ................................ ................................ ................................ ............... 219 dr v r t c _ c lo s e ................................ ................................ ................................ ................................ ............... 220 dr v r t c _ getve r s io n ................................ ................................ ................................ ................................ ...... 220 10. c a n d ri v er ................................ ................................ ................................ .......... 2 2 1 10.1. c an i nt roduc ti on ................................ ................................................................ .............. 221 10.2. c an f e a ture ................................................................ ................................ ...................... 221 10.3. c onst a nt de finiti on ................................ ................................ ............................................ 221 10.4. f unc ti ons ................................ ................................ ................................ ............................ 222 dr v c an_ i n it ................................ ................................ ................................ ................................ .................. 222 dr v c an_ c lo s e ................................ ................................ ................................ ................................ ............... 223 dr v c an_ op en ................................ ................................ ................................ ................................ ............... 223 dr v c an_ sett i m in g ................................ ................................ ................................ ................................ ....... 224 dr v c an_ r esetm s g ob j ................................ ................................................................ ................................ .. 225 drvcan_resetallmsgobj ................................ ................................................................ ............................. 225 drvcan_settxmsgobj ................................ ................................ ................................ ................................ . 226 pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 11 - dr v c an_ setms g ob j ma s k ................................ ................................................................ ............................. 227 dr v c an_ setr x m s g ob j ................................ ................................ ................................ ................................ . 228 dr v c an_ c lr i n tp n d ................................................................ ................................ ................................ ........ 229 dr v c an_ sett x r q s t ................................ ................................ ................................ ................................ ....... 229 dr v c an_ r ea d ms g ob j ................................ ................................................................ ................................ .. 230 dr v c an_ w aite n d of t x ................................ ................................ ................................ ................................ . 230 dr v c an_ b asicsen d m s g ................................ ................................................................ ................................ 231 dr v c an_ b asicr ec ei v em s g ................................ ................................ ................................ ........................... 232 dr v c an_ e n ter i n i t mo d e ................................ ................................................................ ................................ 232 dr v c an_ l ea v ei n i tmo d e ................................ ................................................................ ............................... 233 dr v c an_ e n ter t estmo d e ................................ ................................................................ ............................... 233 dr v c an_ l ea v et estmo d e ................................ ................................ ................................ .............................. 234 dr v c an_ i s ne w data r ec eiv e d ................................ ................................ ................................ ....................... 234 dr v c an_ i s t x r q s tp en d in g ................................ ................................ ................................ ............................ 235 dr v c an_ i s i n tp en d i n g ................................ ................................................................ ................................ ... 235 dr v c an_ i s ob j ec tvalid ................................ ................................ ................................ ................................ . 236 dr v c an_ r eseti f ................................................................ ................................ ........................................... 237 dr v c an_ w aitmsg ................................ ................................ ................................ ................................ ......... 237 dr v c an_ e n ab lei n t ................................................................ ................................ ................................ ........ 238 dr v c an_ dis ab lei n t ................................ ................................ ................................ ................................ ....... 238 dr v c an_ i n s tal lc allb ac k ................................ ................................................................ ................................ 239 dr v c an_ un i n s tallc a llb ac k ................................ ................................ ................................ ........................... 239 dr v c an_ e n ab lew ak eup ................................ ................................ ................................ .............................. 240 dr v c an_ dis ab lew ak eup ................................ ................................................................ ............................. 240 dr v c an_ getc anb itr ate ................................ ................................................................ ............................. 241 dr v c an_ gett x e r r c o u n t ................................ ................................................................ ............................... 241 dr v c an_ getr x e r r c o u n t ................................ ................................ ................................ .............................. 242 dr v c an_ getve r s io n ................................................................ ................................ ................................ ..... 242 11. p wm d ri v er ................................ ................................ ................................ ........ 2 4 4 11.1. p w m i ntrodu c ti on ................................ ................................................................ ............. 244 11.2. p w m f e a ture s ................................ ................................................................ ................... 244 11.3. c onst a nt de finiti on ................................ ................................ ............................................ 245 11.4. f unc ti ons ................................ ................................ ................................ ............................ 246 dr v p w m_ i s t im er e n ab led ................................ ................................................................ ............................. 246 dr v p w m_ sett im er c o u n ter ................................ ................................ ................................ ........................... 246 dr v p w m_ gett im er c o u n ter ................................ ................................................................ .......................... 247 dr v p w m_ e n ab lei n t ................................ ................................ ................................ ................................ ....... 248 dr v p w m_ dis a b lei n t ................................ ................................ ................................ ................................ ...... 249 dr v p w m_ c lear i n t ................................ ................................ ................................ ................................ ......... 250 dr v p w m_ geti n tfl ag ................................................................ ................................ ................................ ..... 251 dr v p w m_ getr is i n g c o u n ter ................................ ................................................................ .......................... 252 dr v p w m_ getfallin g c o u n ter ................................ ................................ ................................ ......................... 252 dr v p w m_ getcap tu r ei n ts tatu s ................................ ................................ ...................................................... 253 dr v p w m_ c lear c ap tu r ei n t sta tu s ................................ ................................ ................................................... 254 dr v p w m_ op en ................................ ................................ ................................ .............................................. 255 dr v p w m_ c lo s e ................................ ................................ ................................ ................................ ............. 255 dr v p w m_ e n ab lede ad z o n e ................................ ................................ ................................ ........................... 256 dr v p w m_ e n ab le ................................................................ ................................ ........................................... 257 dr v p w m_ sett im er c l k ................................ ................................................................ ................................ .. 258 pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 12 - dr v p w m_ sett im er i o ................................ ................................ ................................ ................................ .... 261 dr v p w m_ selectcl o ck so u r ce ................................ ................................ ................................ ........................ 262 dr v p w m_ selectcl ea r l a tch fl ag op tio n ................................ ................................ ................................ ......... 263 dr v p w m_ getve r s io n ................................ ................................ ................................ ................................ .... 263 12. p s2 d ri v er ................................ ................................ ................................ ............ 2 6 5 12.1. ps2 i ntroduc ti on ................................ ................................................................ ................ 265 12.2. ps2 f e a ture ................................................................ ................................ ........................ 265 12.3. c onst a nt de fina ti on ................................ ................................ ........................................... 265 12.4. mac ros ................................ ................................ ................................ ................................ 266 _ dr vp s2 _ ove r r i de ................................ ................................ ................................ ................................ . 266 _ dr vp s2 _ p s2 c l k ................................ ................................ ................................ ................................ ....... 266 _ dr vp s2 _ p s2 da t a ................................ ................................ ................................ ................................ .... 267 _ dr vp s2 _ c l r fifo ................................................................ ................................ ................................ ..... 267 _ dr vp s2 _ a c knot al w ays ................................ ................................ ................................ .................... 268 _ dr vp s2 _ a c k al w a ys ................................ ................................ ................................ ............................ 268 _ dr vp s2 _ r xi nt e na b l e ................................ ................................................................ .......................... 269 _ dr vp s2 _ r xi nt di sa b l e ................................ ................................ ................................ ........................ 269 _ dr vp s2 _ t xi n t e na b l e ................................ ................................................................ .......................... 270 _ dr vp s2 _ t xi n t di sa b l e ................................ ................................ ................................ ......................... 270 _ dr vp s2 _ p s2 e na b l e ................................ ................................................................ ............................... 271 _ dr vp s2 _ p s2 di sa b l e ................................ ................................ ................................ .............................. 271 _ dr vp s2 _ t xfi fo ................................ ................................ ................................ ................................ ....... 272 _ dr vp s2 _ sw ove r r i de ................................ ................................ ................................ ........................... 272 _ dr vp s2 _ i nt c l r ................................ ................................ ................................ ................................ ....... 273 _ dr vp s2 _ r xd a t a ................................................................ ................................ ................................ ..... 274 _ dr vp s2 _ t xda t a w a i t ................................ ................................ ................................ ........................... 274 _ dr vp s2 _ t xda t a ................................................................ ................................ ................................ ..... 275 _ dr vp s2 _ t xda t a 0 ................................ ................................................................ ................................ ... 276 _ dr vp s2 _ t xda t a 1 ................................ ................................................................ ................................ ... 277 _ dr vp s2 _ t xda t a 2 ................................ ................................................................ ................................ ... 277 _ dr vp s2 _ t xda t a 3 ................................ ................................................................ ................................ ... 278 _ dr vp s2 _ i st xe m pt y ................................ ................................................................ ............................... 278 _ dr vp s2 _ i sf r a me e r r ................................ ................................ ................................ ............................ 279 _ dr vp s2 _ i sr xb usy ................................ ................................................................ ................................ .. 279 12.5. f unc ti ons ................................ ................................ ................................ ............................ 280 dr v p s2 _ op en ................................ ................................ ................................ ................................................. 280 dr v p s2 _ c lo s e ................................ ................................ ................................ ................................................. 281 dr v p s2 _ e n ab lei n t ................................ ................................ ................................ ................................ .......... 281 dr v p s2 _ dis ab lei n t ................................ ................................ ................................ ................................ ......... 282 dr v p s2 _ i s i n ten ab led ................................................................ ................................ ................................ ..... 282 dr v p s2 _ c lear i n ................................ ................................ ................................ .............................................. 283 dr v p s2 _ geti n tst at u s ................................ ................................ ................................ ................................ ...... 284 dr v p s2 _ sett x fifode p th ................................ ................................ ................................ .............................. 285 dr v p s2 _ r ea d ................................ ................................ ................................ ................................................. 285 dr v p s2 _ w r ite ................................ ................................ ................................ ................................................. 286 dr v p s2 _ getve r s io n ................................ ................................ ................................ ................................ ....... 286 13. f m c d ri v er ................................ ................................ ................................ ......... 2 8 8 pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 13 - 13.1. f mc i ntroduc ti on ................................ ................................................................ .............. 288 13.2. f mc f e a ture ................................................................ ................................ ...................... 288 me m o r y a d d r ess ma p ................................ ................................ ................................ ................................ .... 288 flas h me m o r y stru ct u r e ................................ ................................ ................................ ................................ . 289 13.3. t y pe de finiti on ................................ ................................................................ .................. 289 e _ fmc _ b oot sel e c t ................................ ................................................................ ................................ 289 13.4. f unc ti ons ................................ ................................ ................................ ............................ 289 dr v fm c _ e n ab lei sp ................................ ................................ ................................ ................................ ....... 289 dr v fm c _ dis ab lei sp ................................ ................................ ................................ ................................ ...... 290 dr v fm c _ b o o tselect ................................ ................................ ................................ ................................ ...... 291 dr v fm c _ getb o o tselect ................................ ................................................................ ................................ 291 dr v fm c _ e n ab le l dup d ate ................................ ................................ ................................ ............................ 292 dr v fm c _ dis ab le l du p d ate ................................ ................................ ................................ ........................... 292 dr v fm c _ e n ab lec o n f ig up d at e ................................ ................................ ...................................................... 293 dr v fm c _ dis ab lec o n f ig up d ate ................................ ................................ ................................ ..................... 293 dr v fm c _ e n ab le a p up d ate ................................ ................................ ................................ ............................ 294 dr v fm c _ dis ab le a p up d ate ................................ ................................ ................................ ........................... 295 dr v fm c _ e n ab lep o w er sa v in g ................................ ................................ ................................ ....................... 295 dr v fm c _ dis ab lep o w er sa v i n g ................................ ................................ ...................................................... 296 dr v fm c _ w r ite ................................ ................................ ................................ ................................ ............... 296 dr v fm c _ r ea d ................................ ................................ ................................ ................................ ............... 297 dr v fm c _ e r ase ................................ ................................ ................................ ................................ ............... 298 dr v fm c _ w r itec o n f i g ................................ ................................................................ ................................ ... 298 dr v fm c _ r ea d data fla s h b ase a d d r ................................ ................................ ................................ ............... 299 dr v fm c _ e n ab le l o w fre q op tmo d e ................................ ................................ ................................ ............... 300 dr v fm c _ dis ab le l o w fre q op tmo d e ................................ ................................ .............................................. 300 dr v fm c _ getve r s io n ................................................................ ................................ ................................ ..... 301 14. u sb d ri v er ................................ ................................ ................................ .......... 3 0 2 14.1. i ntrodu c ti on ................................................................ ................................ ........................ 302 14.2. f e a tur e ................................ ................................ ................................ ................................ 302 14.3. usb f r a mew o rk ................................ ................................................................ ................ 303 14.4. c a ll f low ................................ ................................ ................................ ............................ 304 14.5. c onst a nt de finiti on ................................ ................................ ............................................ 304 usb r eg i s ter a d d r ess ................................ ................................ ................................ ................................ .... 304 i nt e n r eg is ter b it de f i n itio n ................................ ................................ ................................ ....................... 305 i nt s t s r eg is ter b it de f in i ti o n ................................ ................................ ................................ ..................... 306 a t t r r eg is ter b it de f in itio n ................................ ................................ ................................ ........................ 3 06 c o n f i u r atio n r e g i s ter b it de f i n itio n ................................ ................................ .............................................. 306 e x ter a - c o n f i u r atio n r eg i s ter b it de f in itio n ................................................................ ................................ ... 307 14.6. mac ro ................................ ................................ ................................ ................................ . 307 _ dr vusb _ e n a b l e _ mi s c _ i nt ................................ ................................ ................................................ 307 _ dr vusb _ e n a b l e _ w a k e up ................................ ................................ ................................................. 308 _ dr vusb _ di s a b l e _ w a k e up ................................ ................................ ................................................ 308 _ dr vusb _ e n a b l e _ w a k e up _ i n t ................................ ................................ ................................ ......... 309 pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 14 - _ dr vusb _ di s a b l e _ w a k e up _ i n t ................................ ................................ ................................ ........ 309 _ dr vusb _ e n a b l e _ f l de t _ i n t ................................ ................................ ................................ ............. 310 _ dr vusb _ di s a b l e _ f l de t _ i n t ................................ ................................ ................................ ............ 310 _ dr vusb _ e n a b l e _ usb _ i nt ................................ ................................ ................................ .................. 311 _ dr vusb _ di s a b l e _ usb _ i nt ................................ ................................ ................................................. 311 _ dr vusb _ e n a b l e _ b us_ i nt ................................ ................................ ................................ .................. 312 _ dr vusb _ di s a b l e _ b us_ i nt ................................ ................................ ................................................. 312 _ dr vusb _ c l e ar _ e p _ r e a d y_ and_ t r i g_ st a ll ................................ ................................ ............. 312 _ dr vusb _ c l e ar _ e p _ r e a d y ................................ ................................ ................................................. 313 _ dr vusb _ set _ se t up _ b u f ................................ ................................ ................................ ..................... 314 _ dr v usb _ set _ e p_ b uf ................................ ................................................................ ............................. 314 _ dr vusb _ t r i g_ e p ................................ ................................ ................................ ................................ .... 315 _ dr vusb _ ge t _ e p _ da t a _ siz e ................................ ................................ .............................................. 316 _ dr vusb _ set _ e p_ t og_ b i t ................................ ................................ ................................ .................... 316 _ dr vusb _ set _ e ve n t _ fl a g ................................ ................................ ................................ .................. 317 _ dr vusb _ ge t _ e ve n t _ f l a g ................................ ................................ ................................................. 318 _ dr vusb _ c l e ar _ e p _ s t al l ................................ ................................ ................................ .................. 318 _ dr vusb _ t r i g_ e p_ st a l l ................................ ................................ ...................................................... 319 _ dr vusb _ c l e ar _ e p _ dsq_ sync ................................ ................................ ................................ .......... 319 _ dr vusb _ set _ c fg ................................ ................................................................ ................................ ... 320 _ dr vusb _ ge t _ c fg ................................ ................................................................ ................................ ... 321 _ dr vusb _ set _ fa dd r ................................ ................................ ................................ .............................. 321 _ dr vusb _ ge t _ fa dd r ................................ ................................................................ ............................. 322 _ dr vusb _ ge t _ e p st s ................................ ................................................................ ............................... 322 _ dr vusb _ set _ c fgp ................................ ................................ ................................ ................................ . 323 _ dr vusb _ ge t _ c fgp ................................ ................................................................ ................................ 324 _ dr vusb _ e n a b l e _ usb ................................ ................................ ................................ ........................... 324 _ dr vusb _ di s a b l e _ usb ................................ ................................................................ .......................... 325 _ dr vusb _ di s a b l e _ p hy ................................ ................................ ................................ ......................... 325 _ dr vusb _ e n a b l e _ se0 ................................ ................................ ................................ ............................ 326 _ dr vusb _ di s a b l e _ se0 ................................ ................................ ................................ ........................... 326 _ dr vusb _ set _ c fg_ e p 0 ................................ ................................ ................................ ........................... 327 _ dr vusb _ set _ c fg_ e p 1 ................................ ................................ ................................ ........................... 327 _ dr vusb _ set _ c fg_ e p 2 ................................ ................................ ................................ ........................... 328 _ dr vusb _ set _ c fgp 3 ................................ ................................................................ ............................... 329 _ dr vusb _ set _ c fgp 4 ................................ ................................................................ ............................... 329 _ dr vusb _ set _ c fgp 5 ................................ ................................................................ ............................... 330 14.7. f unc ti ons ................................ ................................ ................................ ............................ 331 dr v usb _ getve r s io n ................................ ................................ ................................ ................................ ...... 331 dr v usb _ op en ................................................................ ................................ ................................................ 331 dr v usb _ c lo s e ................................ ................................ ................................ ................................ ............... 333 dr v usb _ p r edisp atch e v e n t ................................ ................................ ................................ ............................ 333 dr v usb _ dis p atc h e v e n t ................................ ................................ ................................ ................................ . 334 dr v usb _ i s data 0 ................................ ................................ ................................ ................................ ............ 334 dr v usb _ getusb s tate ................................ ................................ ................................ ................................ .... 335 dr v usb _ setu s b state ................................................................ ................................ ................................ ..... 336 dr v usb _ gete p i d en tit y ................................ ................................................................ ................................ .. 336 dr v usb _ gete p i d ................................................................ ................................ ........................................... 337 dr v usb _ data o u tt r ig g er ................................ ................................................................ ............................... 337 dr v usb _ geto u tdata ................................................................ ................................ ................................ ..... 338 dr v usb _ data i n ................................ ................................ ................................ ................................ ............. 338 dr v usb _ b u s r eset c allb a ck ................................ ................................ ................................ ........................... 339 dr v usb _ i n s ta llc la s s de v ice ................................ ................................................................ .......................... 340 pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 15 - dr v usb _ i n s ta llc tr l han d ler ................................ ................................ ................................ ........................... 340 dr v usb _ c tr lse tu p a c k ................................ ................................................................ ................................ .. 341 dr v usb _ c tr ldatai n a c k ................................ ................................ ................................ ................................ . 342 dr v usb _ c tr ldata ou t ack ................................ ................................ ................................ .............................. 342 dr v usb _ c tr ldatai n de f au lt ................................ ................................ ................................ ........................... 343 dr v usb _ c tr ldata ou t def a u lt ................................ ................................ ................................ ......................... 344 dr v usb _ r ese t ................................ ................................ ................................ ................................ ............... 344 dr v usb _ c lr c tr lr ea d y ................................ ................................................................ ................................ ... 345 dr v usb _ c lr c tr lr ea d y an d t r ig stal l ................................ ................................ .............................................. 345 dr v usb _ getset u p b u f f er ................................ ................................................................ ............................... 346 dr v usb _ getfr ee s r a m ................................ ................................................................ ................................ 346 dr v usb _ e n ab lesel f p o w er ................................ ................................................................ ............................. 347 dr v usb _ dis ab lesel f p o w er ................................ ................................ ................................ ............................ 347 dr v usb _ i s sel f p o w er e n ab led ................................ ................................ ................................ ........................ 348 dr v usb _ e n ab ler e m o tew ak e u p ................................ ................................ ................................ .................... 348 dr v usb _ dis ab le r e m o tew a k eu p ................................ ................................ ................................................... 349 dr v usb _ i s r e m o tew ak e u p e n ab led ................................ ................................ ................................ ............... 349 dr v usb _ setma x p o w er ................................ ................................................................ ................................ .. 350 dr v usb _ getm ax p o w er ................................ ................................ ................................ ................................ . 350 dr v usb _ e n ab leusb ................................................................ ................................ ................................ ..... 351 dr v usb _ dis ab leu sb ................................ ................................ ................................ ................................ .... 351 dr v usb _ p r edisp atch w ak e u p e v en t ................................ ................................ .............................................. 352 dr v usb _ p r edisp atch fdt e v en t ................................ ................................ ................................ .................... 352 dr v usb _ p r edisp atch b u s e v e n t ................................ ................................ ................................ ..................... 353 dr v usb _ p r edisp atch e p e v en t ................................ ................................ ................................ ....................... 35 3 dr v usb _ dis p atc h w ak e u p e v en t ................................ ................................ ................................ .................... 354 dr v usb _ dis p atc h m is ce v e n t ................................ ................................ ................................ ......................... 354 dr v usb _ dis p atc h e p e v en t ................................ ................................ ................................ ............................ 355 dr v usb _ c tr lse tu p set a d d r es s ................................ ................................ ................................ ....................... 355 dr v usb _ c tr lse tu p c lear setfe atu r e ................................ ................................ ................................ ............... 356 dr v usb _ c tr lse tu p get c o n f i g u r atio n ................................ ................................ ................................ ............. 356 dr v usb _ c tr lse tu p get stat u s ................................ ................................................................ .......................... 357 dr v usb _ c tr lse tu p geti n ter f a ce ................................ ................................ ................................ ..................... 357 dr v usb _ c tr lse tu p seti n ter f ac e ................................ ................................ ...................................................... 358 dr v usb _ c tr lse tu p set c o n f i g u r atio n ................................ ................................ .............................................. 358 dr v usb _ c tr ldatai n set a d d r e s s ................................ ................................ ................................ ..................... 359 dr v usb _ m e m cp y ................................................................ ................................ ........................................... 359 15. p d m a d ri v er ................................ ................................ ................................ ...... 3 6 1 15.1. p dma i ntrodu c ti on ................................ ................................ ........................................... 361 15.2. p dma f e a tur e ................................ ................................................................ ................... 361 15.3. c onst a nt de finiti on ................................ ................................ ............................................ 361 15.4. t y pe de finiti on ................................ ................................................................ .................. 361 e _ dr vp dm a _ c h a nne l _ i nde x ................................ ................................ ................................ ............. 361 e _ dr vp dm a _ di r e c t i on_ sel e c t ................................ ................................ ................................ ........ 362 e _ dr vp dm a _ t r a ns fer_ w i dt h ................................ ................................ ................................ .......... 362 e _ dr vp dm a _ i nt _ e na b l e ................................ ................................ ...................................................... 362 e _ dr vp dm a _ a p b _ de vi c e ................................ ................................ ...................................................... 362 e _drvpdma_apb_rw ................................ ................................ ................................ .............................. 363 e_drvpdma_mode ................................ ................................................................ ................................ .. 363 pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 16 - 15.5. f unc ti ons ................................ ................................ ................................ ............................ 363 dr v p dm a _ i n it ................................ ................................ ................................ ................................ ............... 363 dr v p dm a _ c lo s e ................................................................ ................................ ........................................... 363 dr v p dm a _ c he n ab let r an s f e r ................................ ................................ ...................................................... 364 dr v p dm a _ c hso f t w ar ere s et ................................ ................................ ................................ ........................ 365 dr v p dm a _ op e n ................................ ................................ ................................ ................................ ............ 365 dr v p dm a _ c lear i n t flag ................................ ................................................................ ................................ 367 dr v p dm a _ p o llin t ................................ ................................ ................................ ................................ .......... 368 dr v p dm a _ se t a p b t r an s f er w id t h ................................ ................................ ................................................ 369 dr v p dm a _ se tc h fo r a p b dev ice ................................ ................................ ................................................. 370 dr v p dm a _ se tso u r ce a d d r ess ................................ ................................ ................................ ....................... 371 dr v p dm a _ se tdest a d d r ess ................................ ................................ ................................ ........................... 371 dr v p dm a _ di s ab lei n t ................................ ................................ ................................ ................................ .... 372 dr v p dm a _ e n ab lei n t ................................................................ ................................ ................................ ..... 373 dr v p dm a _ get a p b t r an s f er w id th ................................ ................................ ................................................ 373 dr v p dm a _ get c h fo r a p b dev ice ................................ ................................ ................................................. 374 dr v p dm a _ get c u r r en tde s t ad d r ................................ ................................ ................................................... 375 dr v p dm a _ get c u r r en tso u r ce a d d r ................................ ................................ ................................ ............... 376 dr v p dm a _ get r e m ai n t r an s f er c o u n t ................................ ................................ ........................................... 377 dr v p dm a _ geti n ter n a lb u f p o in ter ................................ ................................ ................................................. 377 dr v p dm a _ get sh ar ed b u f dat a ................................ ................................ ...................................................... 379 dr v p dm a _ gett r an s f er l en g t h ................................ ................................ ...................................................... 380 dr v p dm a _ get so u r ce a d d r es s ................................ ................................ ................................ ....................... 380 dr v p dm a _ get dest a d d r ess ................................ ................................................................ .......................... 381 dr v p dm a _ i n s tall c allb ac k ................................ ................................ ................................ ............................ 382 dr v p dm a _ i s c hb u s y ................................ ................................ ................................ ................................ .... 383 dr v p dm a _ i s i n ten ab led ................................ ................................................................ ................................ 383 dr v p dm a _ get ver s io n ................................ ................................................................ ................................ .. 384 16. i 2 s d r i v er ................................ ................................ ................................ ............ 3 8 6 16.1. i 2s i ntrodu c ti on ................................ ................................................................ ................. 386 16.2. i 2s f e a tur e ................................................................ ................................ ......................... 386 16.3. c onst a nt de finiti on ................................ ................................ ............................................ 387 16.4. t y pe de finiti on ................................ ................................................................ .................. 388 e _ i 2 s_ c ha nne l ................................ ................................ ................................ ................................ ......... 388 e _ i 2 s_ c al l b ac k_ t yp e ................................ ................................ ................................ ........................... 388 16.5. mac ro f unc ti ons ................................ ................................................................ ................ 388 _ dr vi 2 s_ w r i t e _ t x _ fifo ................................ ................................ ................................ ........................ 388 _ dr vi 2 s_ r e a d_ r x_ fif o ................................ ................................ ................................ ......................... 389 _ dr vi 2 s_ r e a d_ t x_ fifo_ l e ve l ................................ ................................ ........................................... 389 _ dr vi 2 s_ r e a d_ r x_ fif o_ l e ve l ................................ ................................ ........................................... 390 16.6. f unc ti ons ................................ ................................ ................................ ............................ 391 dr v i 2 s_ op en ................................ ................................ ................................ ................................ .................. 391 dr v i 2 s_ c lo s e ................................ ................................ ................................ ................................................. 392 dr v i 2 s_ e n ab lei n t ................................................................ ................................ ........................................... 392 dr v i 2 s_ dis ab lei n t ................................ ................................ ................................ ................................ .......... 393 dr v i 2 s_ getb c l kf r eq ................................ ................................................................ ................................ ... 394 dr v i 2 s_ setb c l kfr eq ................................ ................................................................ ................................ ... 395 pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 17 - dr v i 2 s_ getm c l k fre q ................................ ................................................................ ................................ .. 395 dr v i 2 s_ set mc l k fre q ................................ ................................................................ ................................ ... 396 dr v i 2 s_ setc h an n el z er o c r o s s dete ct ................................ ................................ ................................ ............. 396 dr v i 2 s_ e n ab let x dm a ................................ ................................................................ ................................ .. 397 dr v i 2 s_ dis ab let x dm a ................................ ................................ ................................ ................................ . 397 dr v i 2 s_ e n ab ler x dm a ................................ ................................................................ ................................ .. 398 dr v i 2 s_ dis ab ler x dm a ................................ ................................................................ ................................ 398 dr v i 2 s_ e n ab let x ................................................................ ................................ ........................................... 399 dr v i 2 s_ dis ab let x ................................ ................................ ................................ ................................ .......... 399 dr v i 2 s_ e n ab ler x ................................................................ ................................ ........................................... 400 dr v i 2 s_ dis ab ler x ................................ ................................ ................................ ................................ .......... 400 dr v i 2 s_ e n ab let x mu te ................................ ................................................................ ................................ ... 401 dr v i 2 s_ dis ab let x mu te ................................ ................................................................ ................................ .. 401 dr v i 2 s_ e n ab lem c l k ................................ ................................ ................................ ................................ .... 401 dr v i 2 s_ dis ab lem c l k ................................ ................................................................ ................................ ... 402 dr v i 2 s_ c lear t x fifo ................................................................ ................................ ................................ ..... 402 dr v i 2 s_ c lear r x fifo ................................................................ ................................ ................................ ..... 403 dr v i 2 s_ selectcl o c k so u r ce ................................ ................................ ................................ ............................ 403 dr v i 2 s_ getso u r ce c lo ck fre q ................................ ................................ ................................ ......................... 404 dr v i 2 s_ getve r s io n ................................................................ ................................ ................................ ........ 404 17. ebi d ri v er ................................ ................................ ................................ ........... 4 0 6 17.1. ebi i ntro duc ti on ................................ ................................................................ ................ 406 17.2. ebi f e a tu re ................................................................ ................................ ........................ 406 17.3. t y pe de finiti on ................................ ................................................................ .................. 407 e _ dr ve b i _ da t a _ w i dt h ................................ ................................ ................................ ......................... 407 e _ dr ve b i _ a dd r _ w i dt h ................................ ................................ ................................ ........................ 407 e _ dr ve b i _ mcl kdi v ................................ ................................................................ ................................ 407 17.4. ap i f unc ti ons ................................................................ ................................ .................... 408 dr v e b i _ op en ................................ ................................ ................................ ................................................. 408 dr v e b i _ c lo s e ................................ ................................ ................................ ................................................. 409 dr v e b i _ setb u s t i m in g ................................ ................................................................ ................................ ... 409 dr v e b i _ getb u s t im in g ................................ ................................................................ ................................ .. 410 dr v e b i _ getve r s io n ................................ ................................ ................................ ................................ ....... 411 18. a ppendi x ................................ ................................ ................................ .............. 4 1 2 18.1. numicr o tm nu c 100 s e r ies produc ts s e lec ti on guide ................................ ..................... 412 18.2. p d i d t a ble ................................................................ ................................ ........................ 414 19. r ev i s i o n h i s to r y ................................ ................................ ................................ .. 416 pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 18 - 1. overvi ew 1.1. organization t h is d o cu m en t d escr ib es th e nu mic r o ? nuc1 0 0 s er ies d r iv er r ef er en ce m a n u al . s y s te m - le v el s o f t w ar e d ev elo p er s ca n u s e t h e n u mic r o ? nuc1 0 0 s er ies d r iv er to d o th e f ast ap p licatio n s o f t w ar e d ev elo p m e n t, in s tead o f u s i n g th e r e g is ter le v el p r o g r a m m i n g , w h ic h ca n r ed u ce th e to tal d ev elo p m e n t ti m e s i g n if ican t l y . i n th i s d o cu m e n t, a d escr ip tio n , u s a g e a n d an ill u s tr ated ex a m p le co d e ar e p r o v id ed f o r ea ch d r iv er ap p licatio n in ter f ac e. t h e f u ll d r iv er s a m p les a n d d r iv er s o u r ce co d es c an b e f o u n d in t h e b sp ( b o a r d su p p o r t p ac k ag e) o f th e n u mi cr o tm nuc 1 0 0 s er ies. t h is d o cu m en t is o r g a n ized in to s ev er al ch ap ter s . c h ap ter 1 is an o v er v ie w . fro m c h ap ter 2 to c h ap ter 1 7 ar e th e d etailed d r iv er d escr ip t io n s i n clu d i n g th e f o llo w in g s : s y s te m dr i v er , u a r t dr iv er , t im er dr iv er , gp i o dr iv er , a dc dr i v er , sp i dr iv er , i 2 c dr iv er , r t c dr iv er , c a n dr i v er , p w m dr iv er , p s2 dr iv er , fmc dr i v er , usb dr iv er , p dm a dr i v er , i 2 s dr iv er an d e b i dr iv er . fin al l y , f o r th e nu m icr o tm nuc1 0 0 s er ies s elec tio n g u id e an d p r o d u ct id en tit y li s t a r e d escr ib ed in a p p en d i x . 1.2. relati v e d oc um ent s user can find the following documents in our website for other relative information. ? ? numicro tm nuc100 series technical reference manual (trm) ? ? nu mic r o tm nu c 1 0 0 s er ies ap p licatio n no tes 1.3. a b b re v i ati on s a nd g loss aries adc analog - to - digital converter ahb adva nced high - performance bus amba advanced microcontroller bus architecture apb advanced peripheral bus bod brown out detection buf buffer can controller area network cfg configuration dsq data sequence pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 19 - ebi external bus interface ep end point fifo f irst - in - first - out fld float - detection fmc flash memory controller gpio general purpose input/output i2c inter integrated circuit i2s integrated interchip sound lin local interconnect network lvr low voltage reset pdid product device identi t y pdma p eripheral d irect m emory a ccess phy physical layer pll phase - locked loop por power on reset pwm pulse - w idth m odulation ps/2 ibm personal system/2 spi serial peripheral interface tog toggle trig trigger trm technical reference manual uart universa l asynchronous receiver/transmitter pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 20 - 1.4. data type d efinition the definition of all basic data types used in our drivers follow s the definition of ansi c and compliant with arm cmsis ( cortex microcontroller software interface standard ) . the definitions of fun ction - dependent enumeration types are defined in each chapter. the basic data types are listed as follows. type definition description int8_t singed char 8 bits signed integer int16_t signed short 16 bits signed integer int32_t signed int 32 bits signed integer uint8_t unsigned char 8 bits unsigned integer uint16_t unsigned short 16 bits unsigned integer uint32_t unsigned int 32 bits unsigned integer pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 21 - 2. sys driv er 2.1. introduction th e following functions are included in system manager and clock controller section, ? ? product device id ? ? system management registers for chip and module functional reset. ? ? brown - out and chip miscellaneous control. ? ? clock generator ? ? s y s te m clo c k and peripherals clock ? ? p o w er d o w n m o d e pdf create 8 trial www.nuance.com
2.2. clock diagram the clock diagram s how s all relative clock s for the whole chip , includ ing system clocks ( cpu clock, hclk, and pclk) and all peripheral clocks . here, 12m means the external crystal clock source and it is connected with 12mhz crystal. 22m means internal 22mhz rc clock source a nd its frequency is 22.1184mhz with 3 % deviation. 32 k means the external 32768hz crystal for rtc purpose. 10k means internal 10khz rc clock source with 5 0% deviation. pdf create 8 trial www.nuance.com
2.3. type definition e_sys_ip_rst enumeration identifier value description e_sys_gpio_rst 1 gpio reset e_sys_tmr0_rst 2 timer0 reset e_sys_tmr 1 _rst 3 timer1 reset e_sys_tmr 2 _rst 4 timer2 reset e_sys_tmr 3 _rst 5 timer3 reset e_sys_i2c0_rst 8 i2c0 reset e_sys_i2c 1 _rst 9 i2c1 reset e_sys_spi0_rst 12 spi0 reset e_sys_spi 1 _rst 13 spi1 reset e _sys_spi 2 _rst 14 spi2 reset e_sys_spi 3 _rst 15 spi3 reset e_sys_uart0_rst 16 uart0 reset e_sys_uart 1 _rst 17 uart1 reset e_sys_uart 2 _rst 18 uart2 reset e_sys_pwm 03 _rst 20 pwm 0~3 reset e_sys_pwm 47 _rst 21 pwm 4~7 reset e_sys_acmp_rst 22 analog comparator reset e_sys_ps2_rst 23 ps2 reset e_sys_can0_rst 24 can0 reset e_sys_usbd_rst 27 usb device reset e_sys_adc_rst 28 adc reset e_sys_ i2s _rst 29 i2s reset e_sys_pdma_rst 32 pdma reset e_sys_ ebi _rst 33 ebi reset e_sys_ip_clk enumeration identifier valu e description e_sys_wd t _clk 0 watch dog timer clock enable control e_sys_rtc_clk 1 rtc clock enable control e_sys_tmr0_clk 2 timer0 clock enable control e_sys_tmr 1 _clk 3 timer1 clock enable control e_sys_tmr 2 _clk 4 timer2 clock enable control e_sys_t mr 3 _clk 5 timer3 clock enable control e_sys_ fdiv _clk 6 clock divider clock enable control e_sys_i2c0_clk 8 i2c0 clock enable control pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 24 - e_sys_i2c 1 _clk 9 i2c 1 clock enable control e_sys_spi0_clk 12 spi0 clock enable control e_sys_spi 1 _clk 13 spi1 clock en able control e_sys_spi 2 _clk 14 spi2 clock enable control e_sys_spi 3 _clk 15 spi3 clock enable control e_sys_uart0_clk 16 uart0 clock enable control e_sys_uart 1 _clk 17 uart 1 clock enable control e_sys_uart 2 _clk 18 uart 2 clock enable control e_sys_pwm 01 _clk 20 pwm 01 clock enable control e_sys_pwm 23 _clk 21 pwm 23 clock enable control e_sys_pwm 45 _clk 22 pwm 45 clock enable control e_sys_pwm 67 _clk 23 pwm 67 clock enable control e_sys_can0_clk 24 can0 clock enable control e_sys_usbd_clk 27 usb device clock enable control e_sys_adc_clk 28 adc clock enable control e_sys_ i2s _clk 29 i2s clock enable control e_sys_acmp_clk 30 analog comparator clock enable control e_sys_ps2_clk 31 ps2 clock enable control e_sys_pdma_clk 33 pdma clock enable control e_sys_ i sp _clk 34 flash isp controller clock enable control e_sys_ ebi _clk 35 ebi clock enable control e_sys_pll_clksrc enumeration identifier value description e_sys_external_12m 0 pll source clock is from external 12mhz e_sys_internal_22m 1 pll source clock i s from in ternal 2 2mhz e_sys_ip_div enumeration identifier value description e_sys_adc_div 0 adc source clock divider setting e_sys_uart_div 1 uart source clock divider setting e_sys_usb_div 2 usb source clock divider setting e_sys_hclk_div 3 hclk sour ce clock divider setting e_sys_ip_clksrc enumeration identifier value description e_sys_wd t _clksrc 0 watch dog timer clock source setting e_sys_adc_clksrc 1 adc clock source setting e_sys_tmr0_clksrc 2 timer0 clock source setting e_sys_tmr 1 _clksrc 3 t imer1 clock source setting pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 25 - e_sys_tmr 2 _clksrc 4 timer2 clock source setting e_sys_tmr 3 _clksrc 5 timer3 clock source setting e_sys_ uart _clksrc 6 uart clock source setting e_sys_pwm01_clksrc 7 pwm01 clock source setting e_sys_pwm23_clksrc 8 pwm23 clock s ource setting e_sys_i2s_clksrc 9 i2s clock source setting e_sys_frqdiv_clksrc 1 0 frequency divider output clock source setting e_sys_pwm45_clksrc 1 1 pwm45 clock source setting e_sys_pwm 67 _clksrc 1 2 pwm67 clock source setting e_sys_chip_clksrc enumerat ion identifier value description e_sys_xtl12m 0 select external 12m crystal e_sys_xtl32k 1 select external 32k crystal e_sys_osc22 m 2 select internal 22m oscillator e_sys_osc10k 3 select internal 10k oscillator e_sys_pll 4 select pll clock e_sys_pd_t ype enumeration identifier value description e_sys_immediate 0 enter power down immediately e_sys_wait_for_cpu 1 enter power down wait cpu sleep command 2.4. fu n ctio ns drv sys _ rea dproduc tid p ro t o t y pe u in t3 2 _ t d r v sys_ r ea d p r o d u cti d ( v o id ) ; descript io n t o r ea d p r o d u ct d ev ice id en ti t y . t h e p r o d u ct dev ice i d is d ep en d ed o n c h ip p ar t n u m b er . p lease r ef er to p d i d t a b le o f a p p en d i x in d etail s . p a ra m et er no n e i nclu de dr iv er /dr v sys .h pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 26 - ret urn va lue p r o d u ct dev ice id e x a m p le u in t3 2 _ t u 3 2 d at a ; u 3 2 d ata = dr v sys_ r ea d p r o d u cti d ( ); / * r ea d p r o d u ct dev ice i d * / d rv s y s _ ge t res e tso urc e p ro t o t y pe u in t3 2 _ t d r v sys_ get r eset so u r ce ( v o id ) ; descript io n t o id en tify r e s et s o u r ce f r o m l ast o p er atio n . t h e co r r esp o n d in g r eset s o u r ce b its ar e lis ted i n r eg i s ter ? r st sr c ? o f t r m in d etails. bit number description bit 0 power on reset bit 1 reset pin bit 2 watch dog timer bit 3 low voltage reset bit 4 brown - out detector reset bit 5 cortex m0 kernel reset bit 6 reserved bit 7 cpu reset parameter no n e i nclu de dr iv er /dr v sys .h ret urn va lue t h e v alu e i n r st sr c r eg i s ter . e x a m p le u in t3 2 _ t u 3 2 d ata ; u 3 2 d ata = dr v sys_ get r eset so u r ce ( ); / * get r eset so u r ce f r o m la s t o p er atio n * / d rv s y s _ cle a r re s e ts ourc e p ro t o t y pe u in t3 2 _ t d r v sys_ c lear r eset so u r ce ( u i n t3 2 _ t u 3 2 src ) ; d escript io n pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 27 - c lear r eset so u r ce b y w r it i n g a ? 1 ? . p a ra m et er u3 2 src [ in] t h e co r r esp o n d in g b it o f r eset s o u r ce . i nclu de dr iv er /dr v sys .h ret urn va lue 0 su cc ee d e x a m p le dr v sys_ c lear r e s etso u r ce ( 1 << 3 ); /* c lear b it 3 ( l o w vo ltag e r ese t) */ d rv s y s _ res e ti p p ro t o t y pe v o id dr v sys _ r eseti p (e_ sys _ i p _ r st ei p r s t) ; descript io n t o r eset i p in clu d e gp i o , t i m er 0 , t im er 1 , t im er 2 , t im er 3 , i 2 c 0 , i 2 c 1 , sp i 0 , sp i 1 , s pi2 , sp i 3 , ua r t 0 , ua r t 1 , ua r t 2 , pw m0 3 , pw m4 7 , a c mp , p s2 , c a n0 , usb d, a d c , i 2 s, p dm a , an d e b i . no t e p lea s e m ak e s u r e t h at th e r eg i s ter w r ite - p r o tectio n f u n ctio n h as b ee n u n lo ck ed b ef o r e u s i n g th is a p i to r eset p dm a o r e b i . user ca n ch ec k t h e s ta tu s o f th e r e g is ter w r ite - p r o tectio n f u n ctio n w it h dr v sys_ i s p r o te cte d r eg l o ck ed ( ) . p a ra m et er eip rst [ in] e n u m er atio n f o r i p r eset, r ef er en ce th e e _ sy s_ i p _ r st of sectio n 2 . 3 . i nclu de dr iv er /dr v sys .h ret urn va lue no n e e x a m p le dr v sys_ r eseti p ( e _ sys_ i 2 c 0 _ r st ) ; /* r ese t i 2 c 0 */ dr v sys_ r eseti p ( e _ sys_ sp i 0 _ r st ) ; /* r e s et sp i 0 */ dr v sys_ r eseti p ( e _ sys_ uart 0 _ r st ) ; /* r ese t u ar t 0 */ pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 28 - d rv s y s _ res e tc p u p ro t o t y pe v o id dr v sys _ r eset c p u ( v o id ) ; descript io n t o r eset cp u. so f t w ar e w i ll s et c p u_ r st ( i p r st c 1 [ 1 ] ) t o r eset co r tex - m0 c p u k er n el an d flas h m e m o r y co n tr o ller ( fmc ) . no t e p lease m ak e s u r e t h at th e r eg i s ter w r ite - p r o tectio n f u n ctio n h as b ee n u n lo ck ed b ef o r e u s i n g th is a p i . user ca n c h ec k t h e s tatu s o f th e r eg is ter w r ite - p r o tectio n f u n ctio n w i th dr v sys_ i s p r o tecte d r eg l o c k ed ( ) . p a ra m et er no n e i nclu de dr iv er /dr v sys .h ret urn va lue no n e e x a m p le dr v sys_ r eset c p u ( ); /* r eset c p u an d fm c */ d rv s y s _ res e tc hip p ro t o t y pe v o id dr v sys _ r eset c h ip ( v o id ) ; descript io n t o r eset w h o le c h ip , in cl u d i ng c o r tex - m0 c p u k er n el a n d all p er ip h er als. no t e p lease m ak e s u r e t h at th e r eg i s ter w r ite - p r o tectio n f u n ctio n h as b ee n u n lo ck ed b ef o r e u s i n g th is a p i . user ca n c h ec k t h e s tatu s o f th e r eg is ter w r ite - p r o tectio n f u n ctio n w i th dr v sys_ i s p r o tecte d r eg l o c k ed ( ) . p a ra m et er no n e i nclu de dr iv er /dr v sys .h ret urn va lue pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 29 - no n e e x a m p le dr v sys_ r eset c h ip ( ); /* r eset w h o le ch ip */ d rv s y s _ s e l e c tb odv olt p ro t o t y pe v o id dr v sys _ selectb od vo lt ( u in t8 _ t u 8 vo lt); descript io n t o s elec t b r o w n - ou t th r es h o l d v o ltag e . no t e p lease m ak e s u r e t h at th e r eg i s ter w r ite - p r o tectio n f u n ctio n h as b ee n u n lo ck ed b ef o r e u s i n g th is a p i . user ca n c h ec k t h e s tatu s o f th e r eg is ter w r ite - p r o tectio n f u n ctio n w i th dr v sys_ i s p r o tecte d r eg l o c k ed ( ) . p a ra m et er u8 vo lt [ in] 3 : 4 . 5 v, 2 : 3 . 8 v, 1 : 2. 7 v, 0 : 2 . 2 v i nclu de dr iv er /dr v sys .h ret urn va lue no n e. e x a m p le dr v sys_ selectb odvo lt ( 0 ) ; /* set b r o w n - ou t dete cto r v o ltag e 2 . 2 v * / dr v sys_ selectb odvo lt ( 1 ); /* se t b r o wn - ou t dete cto r v o ltag e 2 . 7 v * / dr v sys_ selectb odvo lt ( 2 ); /* se t b r o w n - ou t dete cto r v o ltag e 3 . 8 v * / d rv s y s _ s e tb odfunction p ro t o t y pe v o id dr v sys _ setb odf u n ctio n ( in t3 2 _ t i3 2 e n a b l e, in t3 2 _ t i3 2 flag , b od_ c al l b ac k b o d ca llb ac k fn ) ; descript io n t o en ab le b r o w n- o u t d etec to r an d s elec t b r o w n - o u t r eset f u n ctio n o r in ter r u p t f u n ctio n . i f b r o w n - ou t in ter r u p t f u n c tio n is s elec ted , th i s w ill i n s tall c all b ac k f u n ctio n f o r b od in ter r u p t h an d ler . w h e n th e v o ltag e o f a v dd p in is lo w er th a n s elec ted b r o w n - o u t t h r es h o ld v o lta g e , b r o w n - o u t d etec to r w i ll r eset ch ip o r ass er t a n in ter r u p t . use r ca n u s e dr v sys_ selectb odvo lt ( ) to s elec t b r o w n - o u t th r e s h o ld v o ltag e . pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 30 - no t e p lease m ak e s u r e t h at th e r eg i s ter w r ite - p r o tectio n f u n ctio n h as b ee n u n lo ck ed b ef o r e u s i n g th is a p i . user ca n c h ec k t h e s tatu s o f th e r eg is ter w r ite - p r o tectio n f u n ctio n w i th dr v sys_ i s p r o tecte d r eg l o c k ed ( ) . p a ra m et er i3 2 e na ble [ in] 1 : e n ab le, 0 : d is ab le i3 2 f la g [ in] 1 : e n ab le b r o w n - o u t r eset f u n ctio n , 0 : e n ab le b r o w n - o u t i n t er r u p t f u n ctio n bo dca llb a c k f n [ in] i n s tall b r o w n - o u t c all b ac k f u n ctio n w h e n in ter r u p t f u n c tio n is en ab led . i nclu de dr iv er /dr v sys .h ret urn va lue no n e e x a m p le / * e n ab le b r o w n - ou t dete cto r , s elec t b r o w n - ou t i n ter r u p t f u n ctio n an d i n s tall ca l lb ac k f u n ctio n ? b od_ c allb ac k fn ? */ dr v sys_ setb odf u n ct io n ( 1 , 0 , b od_ c allb ac k fn ) ; / * e n ab le b r o w n - ou t dete cto r an d s elec t b r o w n - o u t r eset f u n ct io n */ dr v sys_ setb odf u n ct io n ( 1 , 1 , nul l ); / * dis ab le b r o w n - o u t dete cto r */ dr v sys_ setb odf u n ct io n ( 0 , 0 , nul l ); d rv s y s _ e nabl e bodl owp owe rmod e p ro t o t y pe v o id dr v sys _ e n ab leb od l o w p o w er mo d e ( v o id ); descript io n t o en ab le b r o w n- o u t d etec to r lo w p o w er m o d e. t h e b r o w n - o u t dete cto r co n s u m es a b o u t 1 0 0 u a i n n o r m al m o d e, th e lo w p o w er m o d e c an r ed u ce th e cu r r en t to ab o u t 1 /1 0 b u t slo w th e b r o w n - o u t dete c to r r esp o n s e. no t e p lease m ak e s u r e t h at th e r eg i s ter w r ite - p r o tectio n f u n ctio n h as b ee n u n lo ck ed b ef o r e u s i n g th is a p i . user ca n c h ec k t h e s tatu s o f th e r eg is ter w r ite - p r o tectio n f u n ctio n w i t h dr v sys_ i s p r o tecte d r eg l o c k ed ( ) . p a ra m et er pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 31 - no n e i nclu de dr iv er /dr v sys .h ret urn va lue no n e e x a m p le d r v sys _ e n ab leb odl o w p o w er mo d e ( ); /* e n ab le b r o w n - ou t lo w p o w er m o d e */ d rv s y s _ dis a bl e bod lowp owe rmod e p ro t o t y pe v o id dr v sys _ dis ab leb o dl o w p o w er mo d e ( v o id ); descript io n t o d is ab le b r o w n - o u t de tecto r lo w p o w er m o d e. no t e p lease m ak e s u r e t h at th e r eg i s ter w r ite - p r o tectio n f u n ctio n h as b ee n u n lo ck ed b ef o r e u s i n g th is a p i . user ca n c h ec k t h e s tatu s o f th e r eg is te r w r ite - p r o tectio n f u n ctio n w i th dr v sys_ i s p r o tecte d r eg l o c k ed ( ) . p a ra m et er no n e i nclu de dr iv er /dr v sys .h ret urn va lue no n e e x a m p le d r v sys _ d is ab leb od l o w p o w er mo d e ( ); /* dis ab le b r o w n - ou t lo w p o w er m o d e */ d rv s y s _ e nabl e lowv oltr e s e t p ro t o t y pe v o id dr v sys _ e n ab le l o w vo ltr e s e t ( v o id ); descript io n t o en ab le lo w v o lta g e r eset f u n ctio n r eset t h e c h ip w h e n in p u t v o lta g e is lo w er t h an l v r cir cu it. t h e t y p ical th r e s h o ld i s 2 . 0 v. t h e ch ar ac ter is tics o f l v r th r e s h o ld v o lta g e is s h o w n in e lectr ical c h ar ac ter is t ics s ec tio n o f t r m. pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 32 - no t e p lease m ak e s u r e t h at th e r eg i s ter w r ite - p r o tectio n f u n ctio n h as b ee n u n lo ck ed b ef o r e u s i n g th is a p i . user ca n c h ec k t h e s tatu s o f th e r eg is ter w r ite - p r o tectio n f u n ctio n w i th dr v sys_ i s p r o tecte d r eg l o c k ed ( ) . p a ra m et er no n e i nclu de dr iv er /dr v sys .h ret urn va lue no n e e x a m p le d r v sys _ e n ab lel o w vo lt r s t ( ); /* e n ab le lo w v o lta g e r eset f u n ctio n */ drvs y s _ dis a bl e low v oltr e s e t p ro t o t y pe v o id dr v sys _ dis ab le l o wvo ltr e s e t ( v o id ); descript io n t o d is ab le lo w v o ltag e r ese t f u n ct io n . no t e p lease m ak e s u r e t h at th e r eg i s ter w r ite - p r o tectio n f u n ctio n h as b ee n u n lo ck ed b ef o r e u s i n g th is a p i . user ca n c h ec k t h e s tatu s o f th e r eg is ter w r ite - p r o tectio n f u n ctio n w i th dr v sys_ i s p r o tecte d r eg l o c k ed ( ) . p a ra m et er no n e i nclu de dr iv er /dr v sys .h ret urn va lue no n e e x a m p le d r v sys _ d is ab le l o w vo ltr s t ( ); /* dis ab le lo w v o lta g e r eset f u n ct io n */ drvs y s _ ge tb ods tat e p ro t o t y pe u in t3 2 _ t d r v sys _ getb ods t ate ( v o id ) ; pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 33 - descript io n t o g et b r o w n - o u t dete cto r s ta te . p a ra m et er no n e i nclu de dr iv er /dr v sys .h ret urn va lue 1 : th e d etec ted v o ltag e is lo w e r th an b od t h r esh o ld v o lta g e . 0 : th e d etec ted v o ltag e is h i g h er th an b od t h r esh o ld v o lta g e . e x a m p le u in t3 2 _ t u 3 2 f lag ; / * get b r o w n - o u t sta te if b r o w n - o u t d etec to r f u n ct io n is e n ab led */ u 3 2 f la g = dr v sy s _ getb ods tate ( ) ; drvs y s _ e nabl e tem p e ra tu re s e nsor p ro t o t y pe v o id dr v sys _ e n ab le t em p er atu r esen s o r ( v o id ); descript io n t o en ab le t e m p er atu r e s e n s o r f u n ct io n . p a ra m et er s no n e i nclu de dr iv er /dr v sys .h ret urn va lue no n e e x a m p le d r v sys _ e n ab le t em p er atu r e sen s o r ( ); /* e n ab le t e m p e r atu r e s en s o r f u n ctio n */ drvs y s _ dis a bl e tem per a tu re s e n s or p ro t o t y pe v o id dr v sys _ dis ab le t e m p er atu r esen s o r ( v o id ); descript io n pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 34 - t o d is ab le t em p er at u r e s en s o r f u n ctio n . p a ra m et er s no n e i nclu de dr iv er /dr v sys .h ret urn va lue no n e e x a m p le d r v sys _ d is ab le t em p er at u r e sen s o r ( ); /* di s ab le t e m p er atu r e s en s o r f u n ctio n */ drvs y s _ unlock p rote c tedreg p ro t o t y pe in t3 2 _ t dr v sys_ un lo c k p r o tecte d r e g ( v o id ) ; descript io n t o u n lo ck t h e p r o tecte d r eg is t er s . so m e o f t h e s y s te m co n tr o l r eg is ter s n ee d to b e p r o tecte d to av o id in ad v er te n t w r ite an d d i s tu r b th e c h ip o p er atio n . t h ese s y s te m co n tr o l r eg is ter s ar e lo ck ed af ter th e p o w er o n r ese t. i f u s er n ee d s to m o d if y th e s e r eg is ter s , u s er m u s t un l oc k th e m . t h ese p r o tecte d r eg is ter s ar e lis ted in r e g i s ter ? r e g w r p r ot ? o f s y s te m ma n a g e r sectio n o f t r m in d etail s . p a ra m et er s no n e i nclu de dr iv er /dr v sys .h ret urn va lue 0 su cc ee d <0 failed e x a m p le in t3 2 _ t i3 2 r et ; / * u n lo ck p r o tecte d r eg is ter s */ i3 2 r et = dr v sys_ un lo c k p r o t ec ted r eg ( ); drvs y s _ lock p rote c t e dreg p ro t o t y pe in t3 2 _ t dr v sys_ l o c k p r o t ec ted r eg ( v o id ) ; pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 35 - descript io n t o r e - l o ck th e p r o tecte d r eg is t er s . r ec o m m en d u s er to r e - lo c k th e p r o tecte d r eg is ter a f ter m o d i f y i n g t h ese r e g is ter s p a ra m et er s no n e i nclu de dr iv er /dr v sys .h ret urn va lue 0 su cc ee d <0 failed e x a m p le in t3 2 _ t i3 2 r et ; / * l o ck p r o tecte d r eg is ter s */ i3 2 r et = dr v sys_ l o ck p r o tect ed r eg ( ); drvs y s _ is p rote c ted regloc k e d p ro t o t y pe in t3 2 _ t dr v sys_ i s p r o tecte d r eg l o ck ed ( v o id ) ; descript io n t o ch ec k th e p r o tecte d r eg is te r s ar e lo ck ed o r n o t . p a ra m et er s no n e i nclu de dr iv er /dr v sys .h ret urn va lue 1 : t h e p r o tecte d r eg is ter s ar e u n lo c k ed . 0 : t h e p r o tecte d r eg is ter s ar e lo ck ed . e x a m p le in t3 2 _ t i3 2 f lag ; / * ch ec k th e p r o tecte d r eg is ter s ar e u n lo c k ed o r n o t */ i3 2 f lag = dr v sys_ i s p r o tecte d r eg l o ck ed ( ); if ( i3 2 f lag ) / * d o s o m et h in g f o r u n lo c k * / pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 36 - else / * d o s o m et h in g f o r lo ck * / drvs y s _ e nabl e p or p ro t o t y pe v o id dr v sys _ e n ab le p or ( v o id ); descript io n t o re - en ab le p o w er - on - r ese t c o n tr o l. no t e p lease m ak e s u r e t h at th e r eg i s ter w r ite - p r o tectio n f u n ctio n h as b ee n u n lo ck ed b ef o r e u s i n g th is a p i . user ca n c h ec k t h e s tatu s o f th e r eg is ter w r ite - p r o tectio n f u n ctio n w i th dr v sy s_ i s p r o tecte d r eg l o c k ed ( ) . p a ra m et er s no n e i nclu de dr iv er /dr v sys .h ret urn va lue no n e e x a m p le d r v sys _ e n ab le p or ( ); / * e n ab le p o w er - on - r eset c o n tr o l */ drvs y s _ dis a bl e p or p ro t o t y pe v o id dr v sys _ dis ab le p or ( v o id ); descript io n t o d is ab le p o w er - on - r e s et c o n tr o l. w h en p o w er o n , th e p or cir cu it g e n er ates a r eset s ig n a l to r eset th e w h o le c h ip f u n c tio n , b u t n o i s e o n th e p o w er m a y ca u s e t h e p or ac tiv e a g ai n . user ca n d is ab le th e p or co n t r o l c ir cu it f o r th i s co n d itio n . no t e p lease m ak e s u r e t h at th e r eg i s ter w r ite- p r o tectio n f u n ctio n h as b ee n u n lo ck ed b ef o r e u s i n g th is a p i . user ca n c h ec k t h e s tatu s o f th e r eg is ter w r ite - p r o tectio n f u n ctio n w i th dr v sys_ i s p r o tecte d r eg l o c k ed ( ) . p a ra m et er s no n e pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 37 - i nclu de dr iv er /dr v s ys .h ret urn va lue no n e e x a m p le d r v sys _ d is ab le p or ( ); / * dis ab le p o w er - on - r eset c o n t r o l */ d rv s y s _ s e tipclo c k p ro t o t y pe v o id dr v sys _ seti p c lo ck ( e _ sys_ i p _ c l k ei p c lk , in t3 2 _ t i3 2 e n ab le ); descript io n t o en ab le o r d is ab le i p clo ck i n clu d e w atch do g t i m e r , r t c , t im er 0 , t im er 1 , t im er 2 , t im er 3 , i 2 c 0 , i 2 c 1 , s p i 0 , sp i 1 , sp i 2 , sp i 3 , ua r t 0 , ua r t 1 , ua r t 2 , pw m0 1 , p w m 2 3 , p w m4 5 , p w m6 7 , c a n0 , us b d, a dc , i 2 s, a c mp , p s2 , p dm a , e b i , flas h i sp co n tr o ller an d fre q u en c y di v id er ou tp u t . no t e p lease m ak e s u r e t h at th e r eg i s ter w r ite - p r o tectio n f u n ctio n h as b ee n u n lo ck ed b ef o r e u s i n g th is a p i to en ab le o r d is ab le th e clo ck o f w atc h do g t i m er . user ca n ch ec k th e s tat u s o f t h e r eg i s ter w r ite - p r o tectio n f u n ctio n w it h dr v s ys_ i s p r o tec ted r eg l o ck ed ( ) . p a ra m et er eip cl k [ in] e n u m er atio n f o r i p clo ck , r ef er en ce th e e _ sys_ i p _ c l k o f sectio n 2 . 3 . i3 2 e na ble [ in] 1 : e n ab le, 0 : d is ab le i nclu de dr iv er /dr v sys .h ret urn va lue no n e e x a m p le dr v sys_ seti p c lo ck ( e _ sys _ i 2 c 0 _ c l k, 1 ) ; /* e n ab l e i 2 c 0 en g in e clo c k */ dr v sys_ seti p c lo ck ( e _ sys _ i 2 c 0 _ c l k, 0 ); /* dis ab l e i 2 c 0 en g in e clo c k */ dr v sys_ seti p c lo ck ( e _ sys _ sp i 0 _ c l k, 1 ) ; /* e n ab l e sp i 0 en g in e clo ck */ dr v sys_ seti p c lo ck ( e _ sys _ sp i 0 _ c l k , 0 ); /* di s ab le sp i 0 en g in e clo ck */ dr v sys_ seti p c lo ck ( e _ sys _ t mr0 _ c l k, 1 ) ; /* e n ab l e timer 0 en g i n e clo ck */ pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 38 - dr v sys_ seti p c lo ck ( e _ sys _ t mr0 _ c l k , 0 ); /* dis ab le t i me r 0 en g in e clo ck */ d rv s y s _ s e l e c t hc lksourc e p ro t o t y pe in t3 2 _ t dr v sys_ se lec th c l kso u r ce ( u i n t8 _ t u 8 c l k src se l ) ; descript io n t o s elec t h c l k clo ck s o u r ce f r o m ex ter n al 1 2 m cr y s tal clo ck , ex ter n al 3 2 k cr y s tal clo ck , p l l clo ck , i n ter n al 1 0 k o s cillato r clo ck , o r in ter n al 2 2 m o s cillato r clo ck . p lease r ef er to th e c lo ck dia g r a m f o r hc l k u s a g e in d etail s . no t e p lease m ak e s u r e t h at th e r eg i s ter w r ite - p r o tectio n f u n ctio n h as b ee n u n lo ck ed b ef o r e u s i n g th is a p i . user ca n c h ec k t h e s tatu s o f th e r eg is ter w r ite - p r o tectio n f u n ctio n w i th dr v sy s_ i s p r o tecte d r eg l o c k ed ( ) . p a ra m et er u8 cl k srcse l [ in] 0 : e x ter n al 1 2 m clo ck 1 : e x ter n al 3 2 k clo ck 2 : p l l clo ck 3 : i n ter n al 1 0 k clo ck 7 : i n ter n al 2 2 m clo ck i nclu de dr iv er /dr v sys .h ret urn va lue 0 su cc ee d < 0 i n co r r ec t p ar am eter e x a m p le dr v sys_ se lec th c l kso u r ce ( 0 ); /* c h a n g e hc l k clo c k s o u r ce to b e ex ter n al 1 2 m */ dr v sys_ se lec th c l kso u r ce ( 2 ); /* c h a n g e hc l k clo c k s o u r ce to b e p l l */ d rv s y s _ s e l e c ts y s ti c k s ourc e p ro t o t y pe in t3 2 _ t dr v sys_ se lec t s y s t ick so u r ce ( u in t8 _ t u 8 c l k src s el) ; descript io n pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 39 - t o s e lect c o r tex - m0 s y s t ick clo ck s o u r ce f r o m e x ter n al 1 2 m cr y s tal clo ck , e x ter n al 3 2 k cr y s tal clo ck , e x ter n al 1 2 m cr y s tal clo c k /2 , hc l k/2 , o r in te r n al 2 2 m o s cillato r clo ck /2 . t h e s y s t ick ti m er is a s tan d ar d tim er in cl u d ed b y c o r tex - m0 . no t e p lease m ak e s u r e t h at th e r eg i s ter w r ite - p r o tectio n f u n ctio n h as b ee n u n lo ck ed b ef o r e u s i n g th is a p i . user ca n c h ec k t h e s tatu s o f th e r eg is ter w r ite - p r o tectio n f u n ctio n w i th dr v sys_ i s p r o tecte d r eg l o c k ed ( ) . p a ra m et er u8 cl k srcs el [ in] 0 : e x ter n al 1 2 m clo ck 1 : e x ter n al 3 2 k clo ck 2 : e x ter n al 1 2 m clo ck / 2 3 : h c l k / 2 7 : i n ter n al 2 2 m clo ck / 2 i nclu de dr iv er /dr v sys .h ret urn va lue 0 su cc ee d < 0 i n co r r ec t p ar am eter e x a m p le dr v sys_ se lec ts y s t ick so u r ce ( 0 ); /* c h a n g e s y s t ick clo ck s o u r ce to b e ex ter n al 1 2 m */ dr v sys_ se lec ts y s t ick so u r ce ( 3 ); /* c h a n g e s y s t ick clo ck s o u r ce to b e hc l k / 2 */ d rv s y s _ se l e c tipclo c k s ourc e p ro t o t y pe in t3 2 _ t dr v sys_ se lec ti p c lo ck so u r ce ( e _ sys_ i p _ c l k sr c ei p c lk src , u in t8 _ t u 8 c l k src sel) ; descript io n t o s elec t i p clo ck s o u r ce in cl u d e w atch do g t i m er , a d c , t im er 0 ~3 , uart , p w m0 1 , p w m2 3 , p w m4 5 , pw m6 7 , i 2 s a n d fre q u en c y di v id er ou t p u t. p lease r ef er to th e c lo ck diag r a m f o r i p clo ck s o u r ce . t h e s ettin g s o f i p ? s co r r esp o n d in g clo ck s o u r ce ar e lis ted in r eg i s ter s ? c l k se l 1 ? a n d ? c l kse l 2 ? o f t r m in d etails . no t e p lease m ak e s u r e t h at th e r eg i s ter w r ite - p r o tectio n f u n ctio n h as b ee n u n lo ck ed b ef o r e u s i n g th is a p i to s elec t th e clo c k s o u r ce o f w atch do g t i m er . us er ca n ch ec k t h e s ta tu s o f t h e r eg i s ter w r ite - p r o tectio n f u n ctio n w it h dr v s ys_ i s p r o tecte d r eg l o ck ed ( ) . pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 40 - p a ra m et er eip cl ks rc [ in] e _ sys_ w d t _ c l ksr c / e _ sys_ a d c _ c l ks r c / e _ sy s_ t mr0 _ c l ks r c e _ sys_ t mr1 _ c l ks r c / e _ sys_ t m r 2 _ c l ks r c / e _ sys_ t mr3 _ c l k sr c e _ sys_ u a r t _ c l k sr c / e _ sys_ p w m 01 _ c l ks r c / e _ sys_ p w m 23 _ c l ks r c e _ sys_ p w m 45 _ c l ks r c / e _ sys_ p w m 67 _ c l ks r c / e _ sys_ fr qdi v _ c l ks r c e _ sys_ i 2 s _ c l k sr c . u8 cl k srcse l [ in] ip ? s c o r r esp o n d in g clo ck s o u r ce . u8clksrcsel 0 1 2 3 7 watch dog timer rese rved ext . 32k (*) hclk/2048 internal 10k x adc external 12m pll hclk (* ) internal 22m x timer external 12m external 32k hclk reserved internal 22m uart external 12m pll reserved internal 22m x pwm external 12m external 32k hclk internal 22m x frequenc y divider output external 12m external 32k hclk internal 22m x i2s external 12m pll hclk internal 22m x no t e ( * ) on l y nu m icr o tm nuc1 x 0 x x x c x ser ie s ( e x . nu c 1 4 0 ve 3 c n) s u p p o r t e x ter n al 3 2 k hz c r y s tal as w atch do g t im er clo ck s o u r ce a n d hc l k a s adc clock sou rce . please r ef er to nu mic r o tm nuc1 0 0 ser ies p r o d u cts selec tio n g u i d e o f a p p en d ix i n d etails. i nclu de dr iv er /dr v sys .h ret urn va lue 0 su cc ee d < 0 i n co r r ec t p ar am eter e x a m p le / * se lec t a d c clo ck s o u r ce f r o m 1 2 m */ dr v sys_ se lec ti p c lo ck so u r ce ( e _ sys_ a d c _ c l ks r c , 0 x 0 0 ) ; / * se lec t t i me r 0 clo ck s o u r c e f r o m hc l k */ dr v sys_ se lec ti p c lo ck so u r ce ( e _ sys_ t mr0 _ c l ksr c , 0 x 0 2 ); / * se lec t i 2 s clo ck s o u r ce f r o m h cl k */ dr v sys_ se lec ti p c lo ck so u r ce ( e _ sys_ i 2 s _ c l ks r c , 0 x 0 2 ) ; pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 41 - d rv s ys _ s e tc loc k div ide r p ro t o t y pe in t3 2 _ t dr v sys_ setc lo ck div id er ( e _ sys_ i p _ di v ei p div , i n t3 2 _ t i3 2 v alu e) ; descript io n t o s et i p en g in e clo ck d i v id e n u m b er f r o m i p clo ck s o u r ce . t h e i p c lo ck f r eq u en c y is ca lc u lated b y : i p clo ck s o u r ce f r eq u en c y / ( i3 2 v alu e + 1 ) . p a ra m et er eip div [ in] e _ sys_ adc_ di v / e _ sys_ uart _ di v / e _ sys_ usb _ di v / e _ sys_ hc l k_ di v i3 2 v a lue [ in] div id e n u m b er . hc l k, usb , u a r t : 0 ~1 5 a d c : 0 ~2 5 5 i nclu de dr iv er /dr v sys .h ret urn va lue 0 su cc ee d < 0 i n co r r ec t p ar am eter e x a m p le / * set a d c clo ck d i v id e n u m b er 0 x 0 1 ; a dc clo ck = a d c s o u r ce clo ck / ( 1 +1 ) */ dr v sys_ setc lo c k di v id er ( e _ sys_ adc_ di v , 0 x 0 1 ); / * set u ar t clo ck d iv id e n u m b er 0 x 0 2 ; u ar t clo ck = uart s o u r ce clo ck / ( 2 +1 ) */ dr v sys_ setc lo c k di v id er ( e _ sys_ u a r t _ di v , 0 x 0 2 ); / * set h c l k clo ck d iv id e n u m b er 0 x 0 3 ; h c l k clo ck = h c l k s o u r ce clo ck / ( 3 +1 ) */ dr v sys_ seti p c lo ck so u r ce ( e _ sys_ hc l k_ di v , 0 x 0 3 ) ; d rv s y s _ s e tos c ct rl p ro t o t y pe in t3 2 _ t dr v sys_ setos c c t r l ( e _ sys_ c hi p _ c l ks r c e c lk src , in t3 2 _ t i3 2 e n ab le) ; descript io n t o en ab le o r d is ab le in ter n al o s cil lato r an d ex ter n al cr y s tal i n clu d e i n ter n a l 1 0 k an d 2 2 m o s cillato r , o r ex ter n al 3 2 k an d 1 2 m cr y s tal. pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 42 - no t e p lease m ak e s u r e t h at th e r eg i s ter w r ite - p r o tectio n f u n ctio n h as b ee n u n lo ck ed b ef o r e u s i n g th is a p i . user ca n c h ec k t h e s tatu s o f th e r eg is ter w r ite - p r o tectio n f u n ctio n w i th dr v sys_ i s p r o tecte d r eg l o c k ed ( ) . p a ra m et er eo s cct rl [ in] e _ sys_ xt l 1 2 m / e _ sys_ xt l 3 2 k / e _ sys_ osc 2 2 m / e _ sys_ osc 1 0 k . i3 2 e na ble [ in] 1 : e n ab le, 0 : d is ab le i nclu de dr iv er /dr v sys .h ret ur n va lue 0 su cc ee d < 0 i n co r r ec t p ar am eter e x a m p le dr v sys_ setos c c tr l ( e _ sys _ xt l 1 2 m , 1 ); / * e n ab le e x ter n al 1 2 m */ dr v sys_ setos c c tr l ( e _ sys _ xt l 1 2 m , 0 ); / * dis ab le e x ter n al 1 2 m */ d rv s y s _ s e tpow e rdownw a k e upint p ro t o t y pe v o id dr v sys_ setp o w er do w n w ak eup i n t ( in t3 2 _ t i3 2 e n ab le, pw r w u_ c al l b ac k p d w u ca llb ac k f n , in t3 2 _ t i3 2 en w ude la y ) ; descript io n t o en ab le o r d is ab le p o w er d o w n w a k e u p in ter r u p t f u n c tio n , an d in s tal l its ca llb ac k f u n c ti o n if p o w er d o w n w a k e u p is e n a b le, an d en ab le clo ck c y cle s d ela y to w a it th e s y s te m clo ck s tab le. t h e d elay ed clo ck c y c l e is 4 0 9 6 clo ck cy cles w h e n ch ip w o r k at ex ter n al 4 ~2 4 mh z cr y s tal, or 2 5 6 clo ck cy cles wh en c h ip w o r k at in ter n al 2 2 . 1 1 8 4 mh z o s cillato r . t h e p o w e r d o w n w a k e u p i n ter r u p t w ill o cc u r w h e n gp i o, usb , ua r t , w d t , c a n, a c mp , b od o r r t c w a k eu p . no t e p lease m ak e s u r e t h at th e r eg i s ter w r ite - p r o tectio n f u n ctio n h as b ee n u n lo ck ed b ef o r e u s i n g th is a p i . user ca n c h ec k t h e s tatu s o f th e r eg is ter w r ite - p r o tectio n f u n ctio n w i th dr v sys_ i s p r o tecte d r eg l o c k ed ( ) . p a ra m et er i3 2 e na ble [ in] 1 : e n ab le, 0 : d is ab le pd w uca llb a c k f n [ in] pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 43 - i n s tall p o w er d o w n w a k e u p ca ll b ac k f u n c tio n w h en i n ter r u p t f u n ctio n i s en ab led . i3 2 enwude la y [ in] 1 : e n ab le clo ck c y cle s d ela y , 0 : d is ab le clo ck c y cle s d ela y i nclu de dr iv er /dr v sys .h ret urn va lue no n e e x a m p le / * e n ab le p o w er d o w n w ak e u p i n ter r u p t f u n ctio n , i n s ta ll c allb ac k f u n ctio n ? p w r w u _ c allb ac k f n ? , an d e n ab le clo ck c y cle s d ela y */ dr v sys_ setp o w er do w n w a k eup i n t ( 1 , pw r w u _ c allb ac k fn , 1 ); /* dis able power d own wake up interrupt function, and un install ca llback function */ drvsys_ setpowerdownwakeupint ( 0 , null, 0 ); d rv s y s _ e nt e r p ow e r down p ro t o t y pe v o id dr v sys_ e n ter p o w er do w n ( e _ sys_ p d_ t y p e e pdt y p e ) ; descript io n t o en ter s y s te m p o w er d o w n m o d e i m m ed iatel y o r a f ter c p u en ter s s leep m o d e. w h e n ch ip en ter s p o w er d o w n m o d e, t h e l do, 1 2 m cr y s tal, a n d 2 2 m o s cillato r w ill b e d is ab led . p lea s e r ef er to a p p licatio n no te, a n _ 1 0 0 7 _ e n _ p o w er_ ma n a g em en t , f o r ap p licatio n . no t e p lease m ak e s u r e t h at th e r eg i s ter w r ite - p r o tectio n f u n ctio n h as b ee n u n lo ck ed b ef o r e u s i n g th is a p i . user ca n c h ec k t h e s tatu s o f th e r eg is ter w r ite - p r o tectio n f u n ctio n w i th dr v sys_ i s p r o tecte d r eg l o c k ed ( ) . p a ra m et er ep dt y pe [ in] e _ sys_ i mm e di a t e : ch ip en te r s p o w er d o w n m o d e i m m ed iatel y . e _ sys_ w a i t _ for _ c p u : c h ip k ee p s ac ti v e till t h e c p u s leep m o d e is al s o ac tiv e a n d th en t h e c h ip en ter s p o w er d o w n m o d e. i nclu de dr iv er /dr v sys .h ret urn va lue no n e e x a m p le pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 44 - / * c h ip en ter p o w er m o d e i m m ed iatel y */ dr v sys_ e n ter p o w er do w n ( e _ sys_ i mm e di a t e ) ; / * w ait f o r c p u en ter s s leep m o d e, t h en c h ip en ter p o w er m o d e */ dr v sys_ e n ter p o w er do w n ( e _ sys_ w a i t _ for _ c p u ) ; d rv s y s _ s e l e c tplls ourc e p ro t o t y pe v o id dr v sys_ selectp l l s o u r ce ( e _ sys_ p l l _ c l k sr c ep lls r c) ; descript io n t o s elec t p l l clo ck s o u r ce in clu d e 2 2 m o s cillato r an d 1 2 m cr y s tal. p a ra m et er ep lls rc [ in] e _ sys_ e xt e r nal _ 1 2 m / e _ sys_ i nt e r nal _ 2 2 m i nclu de dr iv er /dr v sys .h ret urn va lue no n e e x a m p le / * select p l l clo c k s o u r ce f r o m 1 2 m */ dr v sys_ selec tp l l so u r ce ( e _ sys_ e xt e r nal _ 1 2 m ) ; /* select p l l clo c k s o u r ce f r o m 2 2 m */ dr v sys_ selec tp l l so u r ce ( e _ sys_ i nt e r nal _ 2 2 m ) ; d rv s y s _ s e tpllm od e p ro t o t y pe v o id dr v sys_ setp l l mo d e ( in t3 2 _ t i3 2 flag ) ; descript io n t o s et p l l o p er ate in p o w er d o w n m o d e o r n o r m al m o d e . p a ra m et er i3 2 f la g [ in] 1 : p l l is i n p o w er d o w n m o d e. 0 : p l l is i n n o r m al m o d e. i nclu de pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 45 - dr iv er /dr v sys .h ret urn va lue no n e e x a m p le / * e n ab le p l l p o w er d o w n m o d e, p l l o p er ates in p o w er d o w n m o d e */ dr v sys_ setp l l mo d e ( 1 ) ; / * dis ab le p l l p o w er d o w n m o d e, p l l o p er ates in n o r m al m o d e */ dr v sys_ s etp l l mo d e ( 0 ) ; d rv s y s _ ge te xt cloc k fre q p ro t o t y pe u in t3 2 _ t d r v sys_ gete xt c lo ck fre q ( v o id ) ; descript io n t o g et ex ter n al cr y s tal clo c k f r eq u en c y . t h e u n it i s in hz. p a ra m et er no n e i nclu de dr iv er /dr v sys .h ret urn va lue t h e ex ter n al cr y s tal clo ck f r eq u en c y e x a m p le u in t3 2 _ t u 32 clo ck ; u 32 clo ck = dr v sy s_ gete xt c lo ck fre q ( ) ; /* get e x ter n a l c r y s tal clo c k f r eq u e n c y * / d rv s y s _ ge tp ll con tent p ro t o t y pe u in t3 2 _ t dr v sys_ getp ll c o n ten t( e _ sy s_ p l l _ c l ks r c ep lls r c, u in t3 2 _ t u 3 2 p llc l k ) ; descript io n t o ca lcu late th e n ea r est p l l f r eq u en c y to f it t h e tar g et p l l f r eq u en c y t h at is d e f in ed b y u 3 2 p llc lk . p a ra m et er ep lls rc [ in] e_ sys_ e xt e r nal _ 1 2 m / e_ sys_ i nt e r nal _ 2 2 m pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 46 - u3 2 p llcl k [ in] t h e tar g et p l l clo ck f r eq u e n c y . t h e u n it i s in hz. t h e r an g e o f u 3 2 p llc lk i s 25m hz~ 20 0 m hz . i nclu de dr iv er /dr v sys .h ret urn va lue t h e p l l co n tr o l r eg is ter s e tti n g . e x a m p le u in t3 2 _ t u 3 2 p llc r ; / * get p l l co n tr o l r eg i s ter s et tin g f o r tar g et p l l clo c k 5 0 mh z * / u 3 2 p llc r = dr v sys_ getp ll c o n te n t ( e _ sys_ e xt e r nal _ 1 2 m , 5 0 0 0 0 0 0 0 ); d rv s y s _ s e tp ll con tent p ro t o t y pe v o id dr v sys_ setp ll c o n te n t ( u i n t3 2 _ t u 3 2 p llc o n ten t) ; descript io n to s et p l l s et tin g s . u s er ca n u s e dr v sys_ getp ll c o n ten t ( ) to g et p r o p er p l l s et tin g a n d u s e dr v sys_ getp l l c lo c k fr eq ( ) t o g et ac tu al p l l clo ck f r eq u en c y . p a ra m et er u3 2 p llco nte nt [ in] t h e p l l r eg is ter s etti n g f o r th e tar g et p l l clo ck f r eq u en c y . i nclu de dr iv er /dr v sys .h ret urn va lue no n e e x a m p le u in t3 2 _ t u 3 2 p llc r ; / * get p l l co n tr o l r eg i s ter s et tin g f o r tar g et p l l clo c k 5 0 mh z * / u 3 2 p llc r = dr v sys_ getp ll c o n te n t ( e _ dr vs ys_ e xt e r n al _ 1 2 m, 5 0 0 0 0 0 0 0 ); / * set p l l co n tr o l r eg i s ter s et tin g to g et n ea r e s t p l l clo ck * / dr v sys_ setp ll c o n te n t ( u 3 2 p llc r ) ; d rv s y s _ ge tpllc loc k fre q p ro t o t y pe pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 47 - u in t3 2 _ t dr v sys_ getp l l c lo ck fre q ( v o id ) ; descript io n to g et p l l clo c k o u tp u t f r eq u en c y . p a ra m et er no n e i nclu de dr iv er /dr v sys .h ret urn va lue t h e p l l clo ck o u tp u t f r eq u e n c y in hz e x a m p le u in t3 2 _ t u 3 2 clo ck ; u 3 2 clo ck = dr v sy s_ getp l l c lo ck fre q ( ); /* get ac t u al p l l clo ck * / d rv s y s _ ge th clk fre q p ro t o t y pe u in t3 2 _ t dr v sys_ gethc l k fre q ( v o id ) ; descript io n t o g et hc l k clo ck f r eq u e n c y . p a ra m et er no n e i nclu de dr iv er /dr v sys .h ret urn va lue t h e hc l k clo c k f r eq u e n c y in hz e x a m p le u in t3 2 _ t u 3 2 clo ck ; u 3 2 clo ck = dr v sy s_ get hc l k fre q ( ); /* get c u r r en t h c l k clo ck * / d rv s y s _ ope n p ro t o t y pe in t3 2 _ t d r v sys_ op e n ( u i n t3 2 _ t u 3 2 hclk ) ; descript io n pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 48 - t o co n f ig u r e th e p l l s etti n g ac co r d in g to th e p l l s o u r ce c lo ck an d tar g et h c l k clo ck . du e to h ar d w ar e li m itatio n , th e ac t u al hc l k clo ck m a y b e d if f er en t to tar g et h c l k clo ck . t h e dr v sys_ getp l l c lo ck fr eq ( ) c o u ld b e u s ed to g et ac tu al p l l clo ck . t h e dr v sys_ geth c l k fre q ( ) co u ld b e u s ed to g et ac tu al hc l k clo ck . t h e dr v sys_ se t c lo ck di v id e r ( ) c o u ld b e u s ed to g et lo w er hc l k clo ck . no t e p lease m ak e s u r e t h at th e r eg i s ter w r ite - p r o tectio n f u n ctio n h as b ee n u n lo ck ed b ef o r e u s i n g th is a p i . user ca n c h ec k t h e s tatu s o f th e r eg is ter w r ite - p r o tectio n f u n ctio n w i th dr v sys_ i s p r o tecte d r eg l o c k ed ( ) . p a ra m et er u3 2 h clk [ in] t h e tar g et h c l k clo ck f r eq u e n c y . t h e u n it is i n hz. t h e r an g e o f u 3 2 hcl k is 25 m hz~ 5 0 m hz . i nclu de dr iv er /dr v sys .h ret urn va lue e _ suc c e ss su cc ee d e _ dr vsys_ e r r _ o ut _ of_ r ange t h e clo ck s ettin g is o u t o f r an g e e _ dr vsys_ e r r _ r e g_ p r ot e c t e d t h e w r ite p r o tectio n f u n c tio n is en ab led e x a m p le / * set p l l clo ck 5 0 mh z, an d s w itc h hc l k s o u r ce clo ck to p l l * / dr v sys_ op e n ( 50000 000 ); d rv s y s _ s e t fre qdi v i der outp ut p ro t o t y pe in t3 2 _ t dr v sys_ set fre q d iv id er ou tp u t ( in t3 2 _ t i3 2 flag , u in t8 _ t u 8 di v id er ) ; descript io n nuc1 0 0 ser ies s u p p o r t to m o n ito r clo ck s o u r ce f r eq u en c y b y c l ko o u tp u t p i n . t h is f u n ctio n is u s ed t o en ab le o r d is ab le f r eq u e n c y clo c k o u tp u t a n d s et its d i v id er n u m b er . t h e f o r m u la o f o u tp u t f r eq u en c y is , where is the input clock frequency, is th e f r eq u e n c y o f d i v id er o u t p u t c lo ck , an d n is a 4 - b it v al u e. t o m o n ito r th e clo ck s o u r ce f r eq u en c y , w e ca n u s e t h is f u n ct io n to en ab le clo ck o u tp u t f u n ctio n . ho w e v er , w e s til l n e ed to s et c l ko a s o u tp u t p in b y gp i o m u lti - f u n ct io n s elec t io n to o u tp u t th e clo c k to o u tp u t p in o f nu c 1 0 0 s er ies. pdf create 8 trial www.nuance.com 1 2 ? ? n in o u t f f in f out f
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 49 - p a ra m et er i3 2 f la g [ in] 1 : e n ab le; 0 : d is ab le. u8 div ider [ in] t h e d iv id er n u m b er o f o u tp u t f r eq u en c y . t h e v al u e is 0 ~1 5 . i nclu de dr iv er /dr v sys .h ret urn va lue 0 su cc ee d <0 i n co r r ec t p ar am eter e x a m p le / * e n ab le f r eq u en c y clo ck o u t p u t a n d s et it s d iv id e n u m b er 2 , t h e o u tp u t f r eq u e n c y = i n p u t clo ck / 2 ^( 2 +1 ) * / dr v sys_ set fre q div id er ou tp u t ( 1 , 2 ) ; / * dis ab le f r eq u e n c y clo c k o u t p u t * / dr v sys_ set fre q div id er ou tp u t ( 0 , 0 ) ; d rv s y s _ e nabl e highpe rfo rma nc e m ode p ro t o t y pe v o id dr v sys_ e n ab lehi g h p er f o r m a n ce mo d e ( v o id ) ; descript io n t o e n ab le ch ip h i g h p er f o r m a n ce m o d e. w h en t h i s f u n c tio n i s en ab le , in ter n al r a m an d gp i o ac ce s s is w o r k in g w it h ze r o w a it st ate. no t e 1 on l y l o w d e n s it y s er ies s u p p o r t th is f u n ctio n . p lease r ef er t o nu mic r o tm nuc1 0 0 ser ies p r o d u cts selec tio n gu id e o f ap p en d ix in d e tail s . no t e 2 p lease m ak e s u r e t h at th e r eg i s ter w r ite - p r o tectio n f u n ctio n h as b ee n u n lo ck ed b ef o r e u s i n g th is a p i . user ca n c h ec k t h e s tatu s o f th e r eg is ter w r ite - p r o tectio n f u n ctio n w i th dr v sys_ i s p r o tecte d r e g l o c k ed ( ) . p a ra m et er no n e i nclu de dr iv er /dr v sys .h pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 50 - ret urn va lue no n e e x a m p le / * e n ab le h ig h p er f o r m a n ce m o d e */ dr v sys_ e n ab lehi g h p er f o r m an ce mo d e ( ) ; d rv s y s _ dis a bl e high p e rfo rma nc e m ode p ro t o t y pe v o id dr v sys_ dis ab lehi g h p er f o r m a n ce mo d e ( v o id ) ; descript io n t o d is ab le ch ip h ig h p er f o r m a n ce m o d e. no t e 1 on l y l o w de n s it y s er ies s u p p o r t th is f u n ctio n . p lease r ef er t o nu mic r o tm nuc1 0 0 ser ies p r o d u cts selec tio n gu id e o f ap p en d ix in d etail s . no t e 2 p lease m ak e s u r e t h at th e r eg i s ter w r ite - p r o tectio n f u n ctio n h as b ee n u n lo ck ed b ef o r e u s i n g th is a p i . user ca n c h ec k t h e s tatu s o f th e r eg is ter w r ite - p r o tectio n f u n ctio n w i th dr v sys_ i s p r o tecte d r eg l o c k ed ( ) . p a ra m et er no n e i nc lu de dr iv er /dr v sys .h ret urn va lue no n e e x a m p le / * dis ab le h i g h p er f o r m a n ce m o d e */ dr v sys_ d is ab lehi g h p er f o r m an ce mo d e ( ) ; d rv s y s _ del a y p ro t o t y pe v o id dr v sys_ dela y ( u in t3 2 _ t u s ) ; descript io n use th e s y s t ick ti m er o f c o r tex - m0 to g en er ate t h e d ela y ti m e an d t h e u n it i s in u s . t h e s y s t ick clo ck s o u r ce is d ef a u l t to b e f r o m h c l k clo ck . i f t h e s y s t ick clo ck s o u r ce is ch an g ed b y u s er , th e d ela y ti m e m a y b e n o t c o r r ec t. pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 51 - p a ra m et er us [ in] dela y ti m e . t h e m a x i m a l d elay ti m e is 3 3 5 0 0 0 u s . i nclu de dr iv er /dr v sys .h ret urn va lue no n e e x a m p le dr v sys_ dela y ( 5 0 0 0 ) ; / * dela y 5 0 0 0 u s */ d rv s y s _ ge tc hipc lo c k s ourc e s tatus p ro t o t y pe in t3 2 _ t dr v sys_ getc h ip c lo ck so u r ce sta tu s ( e _ sys_ c hi p _ c l ks r c e c lk src ) ; descript io n t o m o n ito r if t h e ch ip clo ck s o u r ce s tab le o r n o t , in clu d e i n t er n al 1 0 k, 2 2 m o s cillato r , ex ter n al 3 2 k, 1 2 m cr y s tal, o r p l l clo ck . no t e on l y nu m icr o tm nuc1 x 0 x x x c x s er ies ( e x . nu c 1 4 0 ve 3 c n) an d l o w den s it y s er ies s u p p o r t th is f u n ctio n . p lease r ef er to nu mic r o tm nu c 1 0 0 ser ies p r o d u cts selec tio n gu id e o f a p p en d i x in d etail s . p a ra m et er e cl k src [ in] e _ sys_ xt l 1 2 m / e _ sys_ xt l 3 2 k / e _ sys_ osc 2 2 m / e _ sys_ osc 1 0 k / e _ sys_ p l l i nclu de dr iv er /dr v sys .h ret urn va lue 0 c lo ck s o u r ce is n o t st ab le o r n o t e n ab led 1 c lo ck s o u r ce is s tab le < 0 i n co r r ec t p ar am eter e x a m p le / * e n ab le e x ter n al 1 2 m */ dr v sys_ setos c c tr l ( e _ sys _ xt l 1 2 m , 1 ); / * w aitin g f o r 1 2 m c r y s tal s t ab le * / pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 52 - w h ile ( dr v sys_ get c h ip c lo c k so u r ce s tatu s ( e _ sys_ xt l 1 2 m) ! = 1 ) ; / * dis ab le p l l p o w er d o w n m o d e */ dr v sys_ setp l l mo d e ( 0 ) ; / * w aitin g f o r p l l clo ck s tab l e * / w h ile ( dr v sys_ get c h ip c lo c k so u r ce s tatu s ( e _ sys_ p l l ) ! = 1 ) ; d rv s y s _ ge tc loc k s w itchs tatus p ro t o t y pe u in t3 2 _ t dr v sys_ getcl o c k s w i tch statu s ( v o id ) ; descript io n t o g et if s w i tch tar g et cl o ck i s s u cc es s f u l o r f ailed w h e n s o f t w ar e s w i tch es s y s te m clo ck s o u r ce . no t e on l y nu m icr o tm nuc1 x 0 x x x c x s er ies ( e x . nu c 1 4 0 ve 3 c n) an d l o w den s it y s er ies s u p p o r t th is f u n ctio n . p lease r ef er to nu mic r o tm nu c 1 0 0 ser ies p r o d u cts selec tio n gu id e o f ap p en d i x in d etail s . p a ra m et er no n e i nclu de dr iv er /dr v sys .h ret urn va lue 0 : c lo ck s w itc h s u cc es s 1 : c lo ck s w itc h f ail e x a m p le u in t3 2 _ t u 3 2 f lag ; dr v sys_ se lec th c l kso u r ce ( 2 ) ; /* c h a n g e hc l k clo c k s o u r ce to b e p l l */ u 3 2 f la g = dr v sy s_ getcl o c k s w itc h stat u s ( ) ; /* ge t c lo ck s w itc h f lag */ if ( u 3 2 f la g ) /* d o s o m et h in g f o r clo ck s w itc h f ail * / d rv s y s _ cle a rclo c k s wi tchs tatus p ro t o t y pe v o id dr v sys _ c lear c lo ck s w itc h statu s ( v o id ) ; descript io n t o clea r th e c lo ck s w i tch fa il flag . pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 53 - no t e on l y nu m icr o tm nuc1 x 0 x x x c x s er ies ( e x . nu c 1 4 0 ve 3 c n) an d l o w den s it y s er ies s u p p o r t th is f u n ctio n . p lease r ef er to nu mic r o tm nu c 1 0 0 ser ies p r o d u cts selec tio n gu id e o f a p p en d i x in d etail s . p a ra m et er no n e i nclu de dr iv er /dr v sys .h ret urn v a lue no n e e x a m p le u in t3 2 _ t u 3 2 f lag ; dr v sys_ se lec th c l kso u r ce ( 0 ); /* c h a n g e hc l k clo c k s o u r ce to b e ex ter n al 1 2 m */ u 3 2 f la g = dr v sy s_ getcl o c k s w itc h stat u s ( ) ; /* ge t c lo ck s w itc h f ail f lag */ if ( u 3 2 f la g ) dr v sys _ c lear c lo c k s w i tc h stat u s ( ) ; / * c lear clo ck s w itc h f a il f la g */ drvs y s _ ge tve rs ion p ro t o t y pe u in t3 2 _ t dr v sys _ getve r s io n ( v o id ); descript io n get th i s v er s io n o f dr v sys d r iv er . p a ra m et er no n e i nclu de dr iv er /dr v sys .h ret urn va lue ver s io n n u m b er : 31:24 23:16 15:8 7:0 00000000 major_num minor_num build_num pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 54 - 3. uar t driv er 3.1. uart introduction t h e un iv er s al as y n c h r o n o u s r ec eiv er /t r an s m itter ( u ar t ) p er f o r m s a s er ial - to - p ar allel c o n v er s io n o n d ata ch ar ac ter s r ec eiv ed f r o m th e p er ip h er al s u c h as mo de m, an d a p ar allel - to - s er ial co n v er s io n o n d ata ch ar ac ter s r ec eiv ed f r o m th e c p u . deta ils p lease r ef er to t h e s ec t io n in t h e tar g et ch ip s p ec i f ica tio n titl ed u ar t . 3.2. uart feature the uart includes following features: ? ? 64 byte s(uart0) /16 byte s(uart1,uart2) entry fifos for received and transmitted data payloads ? ? auto fl ow control/flow control function (cts, rts) are supported. ? ? fully programmable serial - interface characteristics: -- 5 - , 6 - , 7 - , o r 8 - b it c h ar ac ter -- e v e n , o d d , o r n o - p ar it y b it g en er atio n a n d d etec tio n -- 1 - , 1 & 1 /2 , o r 2 - s to p b it g en er atio n -- b au d r ate g e n er atio n -- fals e s tar t b it d etec tio n . ? ? full - prioritized interrupt system controls ? ? l o o p b ac k m o d e f o r in ter n al d iag n o s tic testing ? ? support irda sir function ? ? su p p o r t l i n ( l o ca l i n ter co nnect network) master mode. ? ? p r o g r am m ab le b au d - r ate g en e r ato r th at allo w s th e clo c k to b e d iv id ed b y p r o g r a m m ab le d iv id er pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 55 - 3.3. constant definition constant name value description mode_tx 1 irda or lin function transmit mode mode_ r x 2 irda or lin function recevie mode 3.4. t y pe defi nit i on e_uart_port enumeration identifier value descri ption uart_port0 0x000 uart port 0 uart_port1 0x100000 uart port 1 uart_port 2 0x104000 uart port 2 e_int_source enumeration identifier value description drvuart_rdaint 0x1 receive data available interrupt and time - out interrupt drvuart_threint 0x2 tr ansmit holding register empty interrupt drvuart_wakeupint 0x40 wake up interrupt enable drvuart_rls i nt 0x4 receive line interrupt drvuart_mosint 0x8 modem interrupt drvuart_toutint 0x10 time - out interrupt. drvuart_buferrint 0x20 buffer error interrup t enable drvuart_linint 0x100 lin rx break field detected interrupt enable e_databits_settings enumeration identifier value description drvuart_databits_5 0x0 word length select: character length is 5 bits. drvuart_databits_6 0x1 word length select: ch aracter length is 6 bits. drvuart_databits_7 0x2 word length select: character length is 7 bits. drvuart_databits_8 0x3 word length select: character length is 8 bits. e_parity_settings enumeration identifier value description drvuart_parity_none 0x0 n one parity pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 56 - drvuart_parity_odd 0x1 odd parity enable drvuart_parity_even 0x 3 even parity enable drvuart_parity_mark 0x 5 parity mask drvuart_parity_space 0x 7 parity space e_stopbits_settings enumeration identifier value description drvuart_stopbits_1 0 x0 number of stop bit: stop bit length is 1 bit. drvuart_stopbits_1_5 0x 1 number of stop bit: stop bit length is 1.5 bit when character length is 5 bits. drvuart_stopbits_2 0x 1 number of stop bit: stop bit length is 2 bit when character length is 6, 7 or 8 bits. e_fifo_settings enumeration identifier value description drvuart_fifo_1bytes 0x0 rx fifo interrupt trigger level is 1 byte drvuart_fifo_4bytes 0x1 rx fifo interrupt trigger level is 4 byte s drvuart_fifo_8bytes 0x2 rx fifo interrupt trigger lev el is 8 byte s drvuart_fifo_14bytes 0x3 rx fifo interrupt trigger level is 14 byte s drvuart_fifo_30bytes 0x4 rx fifo interrupt trigger level is 30 byte s drvuart_fifo_46bytes 0x5 rx fifo interrupt trigger level is 46 byte s drvuart_fifo_62bytes 0x6 rx fif o interrupt trigger level is 62 byte s e_uart_func enumeration identifier value description fun_uart 0 select uart function fun_ lin 1 select lin function fun_ irda 2 select irda function fun_ rs485 3 select rs485 function e _ m ode _ rs4 8 5 enumeration ident ifier value description mode_rs485_nmm 1 rs - 485 normal multidrop operation mode mode_rs485_aad 2 rs - 485 auto address detection operation mode mode_rs485_aud 4 rs - 485 auto direction mode pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 57 - 3.5. macro s _ dr v ua rt_s e nd byte p ro t o t y pe v o id _ dr vu ar t _ send b yt e ( u 32 po r t, b y data ) ; descript io n sen d 1 b y te d ata f r o m u ar t . i nclu de dr iv er /dr v u ar t .h ret urn va lue n o n e. e x a m p le / * usi n g u ar t p o r t0 to s en d o n e b y te 0 x 5 5 * / _ dr vu ar t _ send b y t e ( uart _ p or t 0 , 0 x 5 5 ) ; _ dr v ua rt_rece iv e byte p ro t o t y pe u in t8 _ t _ dr vuart _ r e c e i ve b yt e ( u 32p o r t) ; descript io n r ec eiv e 1 b y te d ata f r o m s p ec if ied u ar t fifo . i nclu de dr iv er /dr v u ar t .h ret urn va lue on e b y te d ata. e x a m p le / * usi n g u ar t p o r t0 to r ec eiv e o n e b y te * / u in t8 _ t u 8 d ata; u 8 d ata = _ dr vuart _ r e c e i ve b y t e ( ua r t _ p or t 0 ) ; _ dr v ua rt_s e t_di v ider p ro t o t y p e pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 58 - v o id _ dr vu a r t _ set _ d i vi de r ( u 3 2 p o r t, u 1 6 div id er ) ; descript io n t o s et th e u a r t d iv id er to co n tr o l u a r t b au d - r ate i nclu de dr iv er /dr v u ar t .h ret urn va lue no n e. e x a m p le / * set t h e d iv id er o f u ar t is 6 * / _ dr vu ar t _ se t _ di vi de r ( uart _ p or t 0 , 6 ) ; _ dr v ua rt_rece iv e availab le p ro t o t y pe in t8 _ t _ dr vu a r t _ r e c e i ve a v a i l a b l e ( u 3 2 p o r t) ; descript io n t o g et cu r r en t r x fif o p o in te r i nclu de dr iv er /dr v u ar t .h ret urn va lue r x fi fo p o in ter v al u e. e x a m p le / * t o g et uart ch an n e l 0 cu r r en t r x fifo p o in ter * / _ dr vu ar t _ r e c e i ve a v a i l a b l e ( u ar t _ p or t 0 ) ; _ dr v ua rt_w ait_ tx_ e m p ty p ro t o t y pe v o id _ dr vu a r t _ w a i t _ t x_ e m pt y ( u 3 2 p o r t ) ; descript io n p o llin g t x e m p t y f la g to ch ec k t x fifo is e m p t y . i nclu de dr iv er /dr v u ar t .h pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 59 - ret urn va lue no n e. e x a m p le / * se n d 0 x 5 5 f r o m u a r t 0 an d ch ec k t x fifo is e m p t y * / _ d r vu ar t _ send b y t e ( uart _ p or t 0 , 0 x 5 5 ) ; _ dr vu ar t _ w a i t _ t x_ e m pt y ( ua r t _ p or t 0 ) ; 3.6. fu n ctio ns drv ua rt_o pen p ro t o t y pe i n t3 2_t dr v u ar t _ op en ( e_ uart _ p or t u 3 2 p o r t , uart _ t * s p ar a m ); descript io n t h e f u n c tio n i s u s ed to in i tial i ze uart . i t c o n s is ts o f b au d - r ate, p ar i ty , d ata - b it s , s to p - b its , rx - tr i g g er - le v el a n d ti m eo u t in ter v al s etti n g s . p a ra m et er u 3 2p o rt [ in] sp ec if y u a r t _ p or t 0 / ua r t _ p or t 1 /ua r t _ p or t 2 s p a ra m [ in] sp ec if y th e p r o p er ty o f u a r t . i t in clu d es u3 2 b a ud r a te : b au d r ate ( hz) u8 cp a r ity : none / e ve n / odd p ar ity it co u ld b e dr vu ar t _ p a r i t y_ none ( no n e p ar ity ) . dr vu ar t _ p a r i t y_ e ve n ( e v en p ar it y ) dr vu ar t _ p a r i t y_ odd ( od d p ar ity ) . u8 cda ta b its : d ata b it setti n g i t c o u ld b e dr vu ar t _ da t a _ b i t s_ 5 ( 5 d ata b its ) . pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 60 - dr vu ar t _ da t a _ b i t s_ 6 ( 6 d ata b its ) dr vu ar t _ da t a _ b i t s_ 7 ( 7 d at a b its ) . dr vu ar t _ da t a _ b i t s_ 8 ( 8 d ata b its ) . u8 csto p b its : s to p b its s etti n g i t c o u ld b e dr vu ar t _ st o p b i t s_ 1 ( 1 s to p b it). dr vu ar t _ st o p b i t s_ 1 _5 ( 1 . 5 s to p b it) dr vu ar t _ st o p b i t s_ 2 ( 2 s to p b its ) . u8 crx t r ig g erle ve l : rx f if o i n terru p t t rig g e r l e v e l l e ve l _ x _ b yt e m ea n s th e tr ig g er le v el o f u ar t ch an n el is x b y tes i t c o u ld b e dr vu ar t _ fifo_ 1 b y t e , dr vu ar t _ fifo_ 4 b y t e s dr vu ar t _ fifo_ 8 b y t e s , dr vu ar t _ fifo_ 1 4 b y t e s dr vu ar t _ fifo_ 30 b y t e s , dr vu ar t _ fifo_ 46b y t e s dr vu ar t _ fifo_ 62 b y t e s i n u a r t 0 , it c o u ld b e l e ve l _ 1 _ b yt e to l e ve l _ 6 2 _ b yt e s . oth er s , it c o u ld b e l e ve l _ 1 _ b y t e to l e ve l _ 14 _ b y t e s . u8 t im eout : t im e o u t v al u e n . i t r ep r esen ts n - clo c k c y cl e a n d t h e c o u n ti n g c lo c k is b a u d ra te. i nclu de dr iv er /dr v u ar t .h ret urn va lue e _ suc c e ss : s u cc es s . e _ dr vu a r t _ e r r _ p or t _ i nv a l i d : w r o n g u ar t p o r t co n f i g u r e e _ dr vu a r t _ e r r _ p ar i t y_ i nval i d : w r o n g p ar t y s e ttin g e _ dr vu a r t _ e r r _ d a t a _ b i t s_ i nva l i d : w r o n g data b it setti n g e _ dr vu a r t _ e r r _ st op _ b i t s_ i nva l i d : w r o n g sto p b it setti n g e _ dr vu a r t _ e r r _ t r i gge r l e ve l _ i nv al i d : w r o n g tr ig g er lev el s etti n g e x a m p le / * set u ar t 0 u n d er 1 1 5 2 0 0 b p s , 8 d ata b its , 1 s to p b it a n d n o n e p ar it y an d 1 b y te r x tr ig g er lev el s et tin g s . */ st r _ ua r t _ t s p a r am ; s p ar am . u 3 2 b au d r ate = 1 1 5 2 0 0 ; s p ar am . u 8 cda tab its = dr vu ar t _ da t a b i t s_ 8 ; s p ar am . u 8 csto p b its = dr vu ar t _ st o p b i t s_ 1 ; pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 61 - s p ar am . u 8 cp ar it y = dr vu ar t _ p a r i t y_ no ne ; s p ar am . u 8 cr x t r ig g er l ev el = dr vu ar t _ fifo_ 1 b y t e s; dr v u ar t _ op en ( ua r t _ p o r t 0 , & s p ar am ) ; drv uart _ clos e p ro t o t y pe v o id dr v u ar t _ c lo s e ( e_ uart _ p or t u 3 2 p o r t ); descript io n t h e f u n c tio n i s u s ed to d is ab le uart clo ck , d is ab le i sr an d clea r ca llb ac k f u n ctio n p o in te r af ter ch ec k i n g t h e t x e m p t y . p a ra m et er u 3 2p o rt [ in] sp ec if y u a r t _ p or t 0 / ua r t _ p or t 1 /ua r t _ p or t 2 i nclu de dr iv er /dr v u ar t .h ret urn va lue no n e e x a m p le / * c lo s e u a r t ch an n el 0 * / dr v u ar t _ c lo s e ( uart _ p or t 0 ); drv uart _ e nabl e int p ro t o t y pe v o id dr v u ar t _ e n ab lei n t ( e_ uart _ p or t u 3 2 p o r t , u in t3 2 _ t u 3 2 i n ter r u p tfl a g , p fn_ dr vu a r t _ c al l b ac k p f n ca llb ac k ); descript io n pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 62 - t h e f u n c tio n i s u s ed to en ab le s p ec if ied u ar t i n ter r u p t , i n s t all th e ca llb ac k f u n ct io n an d en ab le nvi c u ar t i r q. p a ra m et er u 3 2p o rt [ in] sp ec if y u a r t _ p or t 0 / ua r t _ p or t 1 /ua r t _ p or t 2 u3 2 i nte rr up t f la g [ in] dr v ua r t _ l i n i nt : l i n r x b r ea k field dete cted i n ter r u p t e n ab le dr v ua r t _ b u f e r r i nt : b u f f er e r r o r i n ter r u p t e n ab le dr v ua r t _ wa k e i n t : w ak eu p i n ter r u p t. dr v ua r t _ mo si nt : m od e m statu s i n ter r u p t. dr v ua r t _ r l snt : r ec eiv e l i n e stat u s i n ter r u p t . dr v ua r t _ t h r e i nt : t r a n s m it ho ld i n g r eg i s ter e m p t y i n ter r u p t . dr v ua r t _ r d a i nt : r ec ei v e data av ailab le i n ter r u p t a n d t im e - o u t i n ter r u p t dr v ua r t _ t out i nt : t i m e - o u t i n ter r u p t . pfnca llb a c k [i n] c all b ac k f u n ctio n p o in ter i nclu de dr iv er /dr v u ar t .h ret urn va lue no n e no t e use | to co n n ec t th e i n ter r u p t f lag s to en ab le m u ltip le i n te r r u p ts s i m u ltan eo u s l y . i f y o u ca ll t h e f u n ctio n t w ice i n a p r o j ec t, th e s etti n g s is d ep en d o n th e s ec o n d s etti n g . e x a m p le / * e n ab le u ar t ch an n el 0 r da a n d t hr e in ter r u p t. fi n al l y , in s tall u ar t _ i n t _ ha nd l e f u n ctio n to b e ca llb ac k f u n ct io n . */ dr v u ar t _ e n ab lei n t( uart _ p or t 0 , ( dr vuart _ r d a i nt | dr vu ar t _ t hr e i nt ) , uart _ i n t _ ha ndl e ) ; drv uart _ dis a ble int p ro t o t y pe v o id dr v u ar t _ di s ab lei n t ( e_ uart _ p or t u 3 2 p o r t u in t3 2 _ t u 3 2 i n ter r u p tfl a g pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 63 - ); descript io n t h e f u n c tio n i s u s ed to d is ab le uart s p ec if ied i n ter r u p t , un i n s ta ll th e ca ll b ac k f u n ctio n a n d d is ab le nvi c u a r t i r q. p a ra m et er u 3 2p o rt [ in] sp ec if y u a r t _ p or t 0 / ua r t _ p or t 1 /ua r t _ p or t 2 u3 2 i nte rr up t f la g [ in] dr v ua r t _ l i n i nt : l i n r x b r ea k field dete cted i n ter r u p t e n ab le dr v ua r t _ b u f e r r i nt : b u f f er e r r o r i n ter r u p t e n ab le dr v ua r t _ wa k e i n t : w ak eu p i n ter r u p t. dr v ua r t _ mo si nt : mo d e m statu s i n ter r u p t . dr v ua r t _ r l snt : r ec eiv e l i n e stat u s i n ter r u pt . dr v ua r t _ t h r e i nt : t r a n s m it ho ld i n g r eg i s ter e m p t y i n ter r u p t . dr v ua r t _ r d a i nt : r ec ei v e data av ailab le i n ter r u p t a n d t im e - o u t i n ter r u p t dr v ua r t _ t out i nt : t i m e - o u t i n ter r u p t . i nclu de dr iv er /dr v u ar t .h ret urn va lue no n e no t e use | to co n n ec t th e i n ter r u p t f lag s to d is ab le m u ltip le in t er r u p ts s i m u l tan eo u s l y . e x a m p le /* t o d is ab le th e t hr e in ter r u p t en ab le f lag . */ dr v u ar t _ dis ab lei n t ( uart _ p or t 0 , dr vuart _ t hr e i nt ); drv uart _ cle a rint fla g p ro t o t y pe u in t3 2 _ t dr v u ar t _ c lear i n t flag ( e_ uart _ p or t u 3 2 p o r t u in t3 2 _ t u 3 2 i n ter r u p tfl a g ); descript io n pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 64 - t h e f u n c tio n i s u s ed to clea r uart s p ec if ied i n ter r u p t f la g . p a ra m et er u 3 2p o rt [ in] sp ec if y u a r t _ p or t 0 / ua r t _ p or t 1 /ua r t _ p or t 2 u3 2 i nte rr up t f la g [ in] dr v ua r t _ l i n i nt : l i n r x b r ea k field dete cted i n ter r u p t e n ab le dr v ua r t _ b u f e r r i nt : b u f f er e r r o r i n ter r u p t e n ab le dr v ua r t _ wa k e i n t : w ak eu p i n ter r u p t. dr v ua r t _ mo si nt : mo d e m statu s i n ter r u p t . dr v ua r t _ r l snt : r ec eiv e l i n e stat u s i n ter r u p t . dr v ua r t _ t h r e i nt : t r a n s m it ho ld i n g r eg i s ter e m p t y i n ter r u p t . dr v ua r t _ r d a i nt : r ec ei v e data av a ilab le i n ter r u p t . dr v ua r t _ t out i nt : t i m e - o u t i n ter r u p t . i nclu de dr iv er /dr v u ar t .h ret urn va lue e _ suc e ss su cc es s e x a m p le / * t o clea r ua r t 0 l i n b r ea k in ter r u p t f lag */ dr v u ar t _ c lear i n t flag ( u ar t _ p or t 0 , dr vua r t _ l i ni nt ); drvuar t_g e tint s tatus p ro t o t y pe i nt 32 _t dr v u ar t _ geti n tst atu s ( e_ uart _ p or t u 3 2 p o r t u in t3 2 _ t u 3 2 i n ter r u p tfl a g ); descript io n t h e f u n c tio n i s u s ed to g et t h e s p ec if ied u a r t in ter r u p t s tat u s . p a ra m et er u 3 2p o rt [ in] pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 65 - sp ec if y u a r t _ p or t 0 / ua r t _ p or t 1 /ua r t _ p or t 2 u3 2 i nte rr up t f la g [ in] dr v ua r t _ l i n i nt : l i n r x b r ea k field dete cted i n ter r u p t e n ab le dr v ua r t _ b u f e r r i nt : b u f f er e r r o r i n ter r u p t e n ab le dr v ua r t _ wa k e i n t : w ak eu p i n ter r u p t. dr v ua r t _ mo si nt : mo d e m statu s i n ter r u p t . dr v ua r t _ r l snt : r ec eiv e l i n e stat u s i n ter r u p t . dr v ua r t _ t h r e i nt : t r a n s m it ho ld i n g r eg i s ter e m p t y i n ter r u p t . dr v ua r t _ r d a i nt : r ec ei v e data av ailab le i n ter r u p t . dr v ua r t _ t out i nt : t i m e - o u t i n ter r u p t . i nclu de dr iv er / dr v u ar t .h ret urn va lue 0 : t h e s p ec if ied in ter r u p t d id n o t h ap p en . 1 : t h e s p ec if ied in ter r u p t h ap p en ed . e _ dr vu a r t _ ar gum e nt : erro r p ar am eter . no t e i t is r ec o m m e n d ed to p o ll o n e in ter r u p t a t a ti m e. example / * t o g et th e t hr e in ter r u p t en ab le f la g . * / i f( dr v u ar t _ geti n tst at u s ( u ar t _ p or t 0 , dr vuart _ t hr e i nt )) p r in tf ( t hr e i nt is h ap p en ed ! \ n ); else p r in tf ( t hr e i nt is n o t h ap p en ed o r er r o r p ar am eter \ n ); drvu art _ ge tc ts info p ro t o t y pe v o id dr v u ar t _ getct s i n f o ( e_ uart _ p or t u 3 2 p o r t, u in t8 _ t * p u 8 c t sval u e, u in t8 _ t * p u 8 c t sc h a n g e state } descript io n pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 66 - t h e f u n c tio n i s u s ed to g et c t s p in v al u e an d d etec t ct s c h an g e s tate p a ra m et er u 3 2 p o rt [ in] sp ec if y u a r t _ p or t 0 / ua r t _ p or t 1 ( ua r t _ p or t 2 is n o s u p p o r ted . ) pu 8 ct s va lue [ o ut ] sp ec if y th e b u f f er to r ec eiv e t h e c t s v al u e. r etr u n c u r r en t c t s p in s tate. pu 8 ct s cha ng est a t e [ o ut ] sp ec if y th e b u f f er to r ec eiv e t h e c t s c h an g e s tate. r et u r n c t s p in s tat e is c h an g ed o r n o t. 1 m ea n s ch a n g ed a n d 0 m ea n s n o t y et. i nclu de dr iv er / dr v u ar t .h ret urn va lue no n e e x a m p le /* t o g et c t s p in s tatu s an d s av e to u 8 c t s_ v alu e. t o g et d etec t ct s c h an g e f lag a n d s av e to u 8 c t s_ s tate. * / u in t8 _ t u 8 c t s _ v alu e , u 8 c t s_ s tate ; dr v u ar t _ getct s i n f o ( uar t _ p or t 1 , & u 8 c t s_ v alu e ,& u 8 c t s_ s tate ); drvu art _ s et r ts p ro t o t y pe v o id dr v u ar t _ s et r t s ( e_ uart _ p or t u 3 2 p o r t, u in t8 _ t u 8 valu e , u in t1 6 _ t u 1 6 t r ig g er l e v el } descript io n t h e f u n c tio n i s u s ed to s et r t s s etti n g . p a ra m et er u 3 2 p o rt [ in] sp ec if y u a r t _ p or t 0 / ua r t _ p or t 1 ( ua r t _ p or t 2 is n o s u p p o r ted . ) u8 va lue [ in] set 0 : d r iv e r t s p in to lo g ic 1 ( i f th e l ev _ r t s set to lo w lev el tr i g g er ed ) . pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 67 - dr iv e r t s p in to lo g ic 0 ( i f th e l ev _ r t s set to h i g h le v el t r ig g er ed ) . set 1 : d r iv e r t s p in to lo g ic 0 ( i f th e l ev _ r t s s et to lo w lev el tr i g g er ed ) . dr iv e r t s p in to lo g ic 1 ( i f th e l ev _ r t s s et to h ig h le v el tr ig g er ed ) . no te. l ev _ r t s is r t s t r ig g er l ev el . 0 is lo w le v el an d 1 is h i g h le v el. u1 6 t rig g er l ev el [ in] r t s t r ig g er l e v el :d r vu ar t _ fifo_ 1 b y t e s to dr vuart _ fifo_ 6 2 b y t e s i nclu de dr iv er / dr v u ar t .h ret urn va lue no n e e x a m p le / * c o n d itio n : dr i v e r t s to lo g ic 1 in u ar t ch an n el 1 an d set rt s tr ig g er le v el is 1 b y te s * / dr v u ar t _ s et r t s ( ua r t _ por t 1 , 1 , dr vua r t _ fifo_ 1 b yt e s ); drvuar t_re a d p ro t o t y pe in t3 2 _ t dr v u ar t _ r ea d ( e_ uart _ p or t u 3 2 p o r t u in t8 _ t * p u 8 r x b u f , u in t3 2 _ t u 3 2 r ea d b y tes ) ; descript io n t h e f u n c tio n i s u s ed to r ea d r x d ata f r o m r x fifo a n d th e d ata w ill b e s to r ed in p u 8 r x b u f . p a ra m et er u 3 2p o rt [ in] sp ec if y u a r t _ p or t 0 / ua r t _ p or t 1 /ua r t _ p or t 2 pu 8 rx b uf [ o ut ] sp ec if y th e b u f f er to r ec eiv e t h e d ata o f r ec eiv e fifo. u3 2 rea db y t es [ in] sp ec if y th e r ea d b y tes n u m b er o f d ata. i nclu de dr iv er /dr v u ar t .h ret urn va lue pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 68 - e _ suc c e ss : s u cc es s . e _ dr vu a r t _ t i me ou t : f i fo p o llin g ti m eo u t. e x a m p le / * c o n d itio n : r ea d r x fifo 1 b y t e an d s to r e in b i n c h ar b u f f er . */ u in t8 _ t b i n c h ar [ 1 ] ; dr v u ar t _ r ea d ( ua r t _ p o r t 0 , b i n c h ar , 1 ) ; drvu art _ w rite p ro t o t y pe in t3 2 _ t dr v u ar t _ w r ite ( e_ uart _ p or t u 3 2 p o r t u in t8 _ t * p u 8 t x b u f , u in t3 2 _ t u 3 2 w r iteb y te s ) ; descript io n t h e f u n c tio n i s to w r ite d ata i n to t x b u f f er to tr an s m it d ata b y u ar t p a ra m et er u 3 2p o rt [ in] sp ec if y u a r t _ p or t 0 / ua r t _ p or t 1 /ua r t _ p or t 2 pu 8 t x b uf [ in] sp ec if y th e b u f f er to s en d t h e d ata to ua r t tr an s m is s io n fifo. u3 2 writ eb y t es [ in] sp ec if y th e b y te n u m b er o f d a ta. i nclu de dr iv er /dr v u ar t .h ret urn va lue e _ suc c e ss : s u cc es s e _ dr vu a r t _ t i me ou t : f i fo p o llin g ti m eo u t e x a m p le / * c o n d itio n : se n d 1 b y te f r o m b i n c h ar b u f f er to t x fifo. */ u in t8 _ t b i n c h ar [ 1 ] = 0 x 5 5 ; dr v u ar t _ w r ite ( ua r t _ p or t 0 , b i n c h ar , 1 ) ; pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 69 - drvu art _ e nabl e p d m a p ro t o t y pe v o id dr v u ar t _ e n ab le p dm a ( e_ uart _ p or t u 3 2 p o r t ) ; descript io n t h e f u n c tio n i s u s ed to co n tr o l en ab le p dm a tr an s m it/re ce i v e c h an n el p a ra m et er u 3 2 p o rt [ in] sp ec if y u a r t _ p or t 0 / ua r t _ p or t 1 ( ua r t _ p or t 2 is n o s u p p o r ted . ) i nclu de dr iv er /dr v u ar t .h ret urn va lue no n e. e x a m p le /* e n ab le t x an d r x p dm a in u ar t 1 */ dr v u ar t _ e n ab le p dm a ( uart _ p or t 1 ) ; drvu art _ dis a ble p d m a p ro t o t y pe v o id dr v u ar t _ dis ab le p dm a ( e_ uart _ p or t u 3 2 p o r t ) ; descript io n t h e f u n c tio n i s u s ed to co n tr o l d is ab le p dm a tr an s m i t/re ce i v e c h a n n e l p a ra m et er u 3 2 p o rt [ in] sp ec if y u a r t _ p or t 0 / ua r t _ p or t 1 ( ua r t _ p or t 2 is n o s u p p o r ted . ) i nclu de dr iv er /dr v u ar t .h pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 70 - ret urn va lue no n e. e x a m p le /* dis ab le t x an d r x p dm a i n u a r t 1 */ dr v u ar t _ dis ab le p dm a ( uart _ p or t 1 ) ; drvu art _ s e tf nird a p ro t o t y pe v o id dr v u ar t _ setfn ir da ( e_ uart _ p or t u 3 2 p o r t st r _ i r c r _ t s tr _ i r c r ) ; descript io n t h e f u n c tio n i s u s ed to co n f i g u r e i r d a r elati v e s etti n g s . i t co n s is ts o f t x o r r x m o d e an d i n v er s e t x o r r x s ig n als. p a ra m et er u 3 2p o rt [ in] sp ec if y u a r t _ p or t 0 / ua r t _ p or t 1 /ua r t _ p or t 2 s t r_ i rcr [ in] t h e s tr u ctu r e o f i r d a i t in clu d es o f u 8 ct xselec t : 1 : e n ab le i r da tr a n s m it f u n ctio n . i t b ec o m es t x m o d e 0 : d is ab le i r da tr an s m it f u n ctio n . i t b ec o m e s r x m o d e. u 8 ci n v t x : i n v er t t x s i g n al f u n ct io n t r ue o r fa s l e u 8 ci n v r x : i n v er t r x s ig n al f u n ct io n ( def a u lt v al u e is t r u e ) t r ue o r fa s l e i nclu de dr iv er /dr v u ar t .h ret urn va lue no n e no t e b ef o r e u s i n g t h e a p i , y o u s h o u ld co n f ig u r e u a r t s etti n g f i r s tl y . a n d m a k e s u r e th e b au d - r ate s etti n g is u s ed m o d e 0 ( ua r t d iv id er is 1 6 ) in b au d - r ate co n f i g u r e. pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 71 - e x a m p le / * c h a n g e u ar t 1 to i r d a f u n ct io n an d i n v er s e t h e r x s i g n al s . */ st r _ i r c r _ t s i r d a; s i r d a. u 8 ct xselec t = e na b l e ; s i r d a. u 8 ci n v t x = fal se ; s i r d a. u 8 ci n v r x = t r ue ; dr v u ar t _ setfn i r d a ( u ar t _ p or t 1 , & s i r d a) ; drvu art _ s e tf nrs4 8 5 p ro t o t y pe v o id dr v u ar t _ op en r s4 8 5 ( e_ uart _ p or t u 3 2 p o r t , st r _ r s4 8 5 _ t * s tr _ r s4 8 5 ) ; descript io n t h e f u n c tio n i s u s ed to s et r s 4 8 5 r elativ e s ettin g p a ra m et er u 3 2p o rt [ in] sp ec if y u a r t _ p or t 0 / ua r t _ p or t 1 /ua r t _ p or t 2 s t r_ rs4 8 5 [ in] t h e s tr u ctu r e o f r s4 8 5 i t in clu d es o f u 8 cm o d eselec t : sele ct o p er atio n m o d e mo de _ r s4 8 5 _ nm m : rs - 4 8 5 no r m al m u lti - d r o p mo d e mo de _ r s4 8 5 _ aa d : rs - 4 8 5 a u to a d d r ess dete ct io n mo d e mo de _ r s4 8 5 _ a ud : rs - 4 8 5 a u to dir ec tio n mo d e u 8 c a d d r e n ab le : e n ab le o r dis ab le r s - 4 8 5 a d d r ess dete cti o n u 8 c a d d r valu e : set a d d r ess m atch v al u e u 8 cde la y t i m e : set tr an s m i t d ela y ti m e v al u e u 8 cr x dis ab le : e n ab le o r dis ab le r ec eiv er f u n ctio n . i nclu de dr iv er /dr v u ar t .h pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 72 - ret urn va lue no n e no t e no n e e x a m p le / * c o n d itio n : c h a n g e u a r t 1 to r s4 8 5 f u n c tio n . set r elati v e s ettin g as b elo w . * / st r _ r s4 8 5 _ t s p a r am _ r s4 8 5 ; s p ar am _ r s4 8 5 . u 8 ca d d r e n ab l e = e na b l e ; s p ar am _ r s4 8 5 . u 8 ca d d r valu e = 0 x c 0 ; / * a d d r ess * / s p ar am _ r s4 8 5 . u 8 cm o d eselec t = mo de _ r s4 8 5 _ aa d | mo d e _ r s4 8 5 _ a ud; s p ar am _ r s4 8 5 . u 8 cde la y t i m e = 0 ; s p ar am _ r s4 8 5 . u 8 crx dis ab le = t r ue ; dr v u ar t _ setfn r s4 8 5 ( ua r t _ p or t 1 , & s p ar am _ r s4 8 5 ) ; drvu art _ s e tf nlin p ro t o t y pe v o id dr v u ar t _ setfn l i n ( e_ uart _ p or t u 3 2 p o r t u in t1 6 _ t u 1 6 mo d e , u in t1 6 _ t u 1 6 b r ea k l en g t h ) ; descript io n t h e f u n c tio n i s u s ed to s et l i n r elativ e s ett in g p a ra m et er u 3 2p o rt [ in] sp ec if y u a r t _ p or t 0 / ua r t _ p or t 1 /ua r t _ p or t 2 u1 6 m o de [ in] sp ec if y l i n d ir ec tio n : mo d e _ t x an d / o r mo de _ r x u1 6 b re a k l eng t h [ in] sp ec if y b r ea k c o u n t v al u e. i t s h o u ld b e lar g er th a n 1 3 b it ti m e ac co r d in g l i n p r o to co l. i nclu de dr iv er /dr v u ar t .h ret urn va lue pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 73 - no n e e x a m p le /* c h a n g e u ar t 1 to l i n f u n ctio n an d s et t o tr an s m it t h e h e ad er in f o r m atio n . */ dr v u ar t _ setfn l i n( u ar t_ ch , mo de _ t x | mo de _ r x, 1 3 ) ; drv uart _ ge tve rs ion p ro t o t y pe in t3 2 _ t dr v u ar t _ getve r s io n ( v o id ) ; descript io n r etu r n th e c u r r en t v er s io n n u m b er o f d r i v er . i nclu de dr iv er /dr v u ar t .h ret urn va lue ver s io n n u m b er : 31:24 23:16 15:8 7:0 00000000 major_num minor_num build_num pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 74 - 4. timer/w dt driv er 4.1. t imer/wdt introduction t h e ti m er m o d u le i n cl u d es f o u r ch a n n el s, t i me r 0~ t i me r 3 , w h ic h allo w y o u to ea s i l y i m p le m en t a co u n ti n g s ch e m e f o r u s e. t h e ti m er ca n p er f o r m f u n c t io n s lik e f r eq u en c y m ea s u r e m e n t, e v en t co u n ti n g , in ter v al m ea s u r e m e n t, clo ck g e n er atio n , d ela y ti m in g , a n d s o o n . t he ti m er ca n g en er ate a n in ter r u p t si g n al u p o n t i m eo u t, o r p r o v id e th e cu r r en t v al u e o f co u n t d u r i n g o p er atio n . a n d f o r ex ter n al co u n t a n d ca p tu r e f u n ct io n s , o n l y nuc1 x 0 x x x b x an d nu c 1 x 0 x x x c x s er ies s u p p o r t ed , e x :nu c 1 4 0 r d2 b n an d nuc 1 4 0 ve 3 c n. p lease r ef er to n u mic r o tm nuc1 0 0 ser ies p r o d u cts selectio n g u id e o f a p p en d ix i n d etails . t h e p u r p o s e of w atc h d o g t i m er ( w dt ) is to p er f o r m a s y s te m r ese t af ter t h e s o f t w ar e r u n n i n g in to a p r o b lem . t h is p r ev en t s s y s te m f r o m h a n g in g f o r an in f i n ite p er io d of tim e . 4.2. t ime r /w dt fea tu re ? ? 4 sets of 32 - bit timers with 24 - bit up - timer and one 8 - bit pre - scale counter . ? ? ind ependent clock source for each timer . ? ? p r o v id es o n e - s h o t, p er io d ic, to g g le a n d co n ti n u o u s co u n ti n g o p er atio n m o d es . ? ? t im e o u t p er io d = ( p er io d o f ti m er clo ck in p u t ) * ( 8 - b it p r e - s ca le co u n ter + 1 ) * ( 2 4 - b it t c mp ) . ? ? ma x i m u m co u n ti n g c y cle ti m e = ( 1 / t mh z) * ( 2 ^8 ) * ( 2 ^2 4 ) , t is th e p er io d o f ti m er clo ck . ? ? 24 - b it ti m er v al u e i s r ea d ab le th r o u g h t dr ( t i m er data r e g is ter ) . ? ? su p p o r t e v en t c o u n ti n g f u n cti o n to co u n t t h e ev e n t f r o m ex t er n al p in . ? ? support input capture function to capture or reset counter value . ? ? 18 - bi t f r ee r u n n i n g co u n ter to av o id c p u f r o m w atc h d o g ti m er r eset b ef o r e th e d ela y tim e e x p ir es. ? ? selectable time - out interval (2^4 ~ 2^18) and the time out interval is 104 ms ~ 2 6.3168 s ( if wdt_clk = 1 0 k hz). ? ? r eset p er io d = ( 1 /1 0 k hz) * 6 3 , if w dt _ c l k = 1 0 k hz. 4.3. type definition e_ timer_channel enumeration identifier value description e_ tmr0 0x0 specify the timer channel - 0 pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 75 - e_ tmr1 0x1 specify the timer channel - 1 e_ tmr2 0x2 specify the timer channel - 2 e_ tmr3 0x3 specify the timer channel - 3 e_ time r_opmode enumeration identifier value description e_ oneshot_mode 0x0 set timer to one - shot mode e_ periodic_mode 0x1 set timer to periodic mode e_ toggle_mode 0x2 set timer to toggle mode e_ continuous_mode 0x3 set timer to continuous counting mode e_ tim er_ tx_phase enumeration identifier value description e_phase_falling 0x0 set falling edge of external count pin will be counted e_phase_rising 0x1 set raising edge of external count pin will be counted e_ timer_ tex_edge enumeration identifier value descr iption e_edge_falling 0x0 set 1 to 0 transition on tex will be detected e_edge_rising 0x1 set 0 to 1 transition on tex will be detected e_edge_both 0x2 either 1 to 0 or 0 to 1 transition on tex will be detected e_ timer_ rstcap_mode enumeration identifie r value description e_capture 0x0 tex transition is using as timer capture function e_reset 0x1 tex transition is using as timer counter reset function e_ wdt_cmd enumeration identifier value description e_ wdt_ioc_start_timer 0x0 start wdt counting e_ w dt_ioc_stop_timer 0x1 stop wdt counting pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 76 - e_ wdt_ioc_enable_int 0x2 enable wdt interrupt e_ wdt_ioc_disable_int 0x3 disable wdt interrupt e_ wdt_ioc_enable_ wakeup 0x 4 enable wdt time - out wake up function e_ wdt_ioc_disable_ wakeup 0x 5 disable wdt time - out wak e up function e_ wdt_ioc_reset_timer 0x 6 reset wdt counter e_ wdt_ioc_enable_reset_func 0x 7 enable wdt reset function when wdt time - out e_ wdt_ioc_disable_reset_func 0x 8 disable wdt reset function when wdt time - out e_ wdt_ioc_set_interval 0x 9 set the wdt time - out interval e_ wdt_interva l enumeration identifier value description e_ level0 0x0 set wdt time - out interval is 2^4 wdt_clk e_ level 1 0x1 set wdt time - out interval is 2^6 wdt_clk e_ level 2 0x2 set wdt time - out interval is 2^8 wdt_clk e_ level 3 0x3 s et wdt time - out interval is 2^10 wdt_clk e_ level 4 0x4 set wdt time - out interval is 2^12 wdt_clk e_ level 5 0x5 set wdt time - out interval is 2^14 wdt_clk e_ level 6 0x6 set wdt time - out interval is 2^16 wdt_clk e_ level 7 0x7 set wdt time - out interval is 2^18 wdt_clk 4.4. functions drvti m e r_i nit p ro t o t y pe v o id dr v t i me r _ i n it ( v o id ) descript io n user m u s t to ca ll t h is f u n ct io n b ef o r e an y t i m er o p er atio n s af ter s y s te m b o o t u p . p a ra m et er no n e pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 77 - i nclu de dr iv er / dr v t i me r .h ret urn va lue no n e e x a m p le: / * i n f o th e s y s te m ca n a cc ep t t im er a p i s af ter ca lli n g dr v t i me r _ i n it() * / dr v t i me r _ i n it (); drvti m e r_o pen p ro t o t y pe in t3 2 _ t dr v t i me r _ op en ( e_ t i me r _ c h a nne l ch , u in t3 2 _ t u t ick s p er seco n d , e_ t i me r _ op mo de o p _ m o d e ) descript io n op en th e s p ec i f ied t i m er ch a n n el w it h s p ec i f ied o p er atio n m o d e. p a ra m et er ch [ in] e_ ti m e r_ ch ann e l , it c o u ld b e e _ t mr0 / e _ t mr1 / e _ t mr2 / e _ t mr3 ut ic k s p er seco nd [ i n] t h is v alu e m ea n s h o w m a n y t i m er in ter r u p t tick s in o n e s ec o n d o p_ m o o de [ in] e_ t i m e r_ o p m o de , e_ o ne shot _ mo de / e_ period i c _ mo de / e_ t oggl e _ mo de / e_ c o nt i nuou s_ mo de i nclu de dr iv er / dr v t i me r .h ret urn va lue e _ suc c e ss : o p er atio n s u cc ess f u l e _ dr vt i me r _ c hann e l : i n v alid t i m er ch a n n el e _ dr vt i me r _ c l o c k_ r at e : c alcu late in it ial v al u e f ail e x a m p le / * usi n g t i me r 0 at p e r i od i c _ mo de , 2 tick s / s ec * / dr v t i me r _ op en ( e_ t mr0 , 2 , e_ p e r i odi c _ mo de ) ; pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 78 - drvti m e r_clos e p ro t o t y pe in t3 2 _ t dr v t i me r _ c lo s e ( e_ t i me r _ c ha nne l ch ) descript io n t h e f u n c tio n i s u s ed to clo s e t h e t i m er ch a n n el. p a ra m et er ch [ in] e_ ti m e r_ ch ann e l , it c o u ld b e e _ t mr0 / e _ t mr1 / e _ t mr2 / e _ t mr3 i nclu de dr iv er / dr v t i me r .h ret urn va lue e _ suc c e ss : o p er atio n s u cc ess f u l e _ dr vt i me r _ c hann e l : i n v alid t i m er ch a n n el e x a m p le / * c lo s e th e s p ec i f ied t i m er ch an n el */ dr v t i me r _ c lo s e ( e_ t mr0 ) ; drvti m e r_s e tt im e r e v e nt p ro t o t y pe in t3 2 _ t dr v t i me r _ se tt im er e v en t ( e_ t i me r _ c hann e l ch , u in t3 2 _t u i n ter r u p tt ick s , t i me r _ c al l b ac k p t im er c allb ac k , u in t3 2 _ t p ar am eter ) descript io n i n s tall t h e i n ter r u p t c allb ac k f u n ct io n o f t h e s p ec i f ied ti m er ch an n el . an d tr ig g er ti m er ca llb ac k f u n ctio n w h e n in ter r u p t o cc u r u i n terr u p tti ck s ti m es . p a ra m et er ch [ in] e_ ti m e r_ ch ann e l , it c o u ld b e e _ t mr0 / e _ t mr1 / e _ t mr2 / e _ t mr3 ui nte rr u pttic k s [ in] nu m b er o f ti m er i n ter r u p t o cc u r r ed p t i m er ca llb a c k [ in] t h e f u n c ti o n p o in ter of t h e i n t er r u p t c allb ac k f u n c ti on pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 79 - pa ra m et er [ in] a p ar a m eter o f t h e ca llb ac k f u n ctio n i nclu de dr iv er /dr v t i me r .h ret urn va lue u t i m er e v e n tno : t h e t i m er e v en t n u m b e r e _ dr vt i me r _ e ve nt _ full : t h e ti m er ev en t is f u l l e x a m p le / * i n s tall c allb ac k " t mr_ c allb ac k " an d tr ig g er ca llb ac k w h e n ti m er i n ter r u p t h ap p en t w ice * / u t i m er e v e n tno = dr v t i me r _ sett im er e v e n t ( e_ t mr0 , 2 , ( t i me r _ c al l b ac k) t mr_ c allb ac k , 0 ) ; drvti m e r_cle a rti me re v e nt p ro t o t y pe v o id dr v t i me r _ c lear t im er e v en t ( e_ t i me r _ c hann e l ch , u in t3 2 _ t u t i m e r e v e n tno ) descript io n c lear th e t i m er e v e n t o f t h e s p ec ified t i m er ch a n n el . p a ra m et er ch [ in] e_ ti m e r_ ch ann e l , it c o u ld b e e _ t mr0 / e _ t mr1 / e _ t mr2 / e _ t mr3 ut i m e r e v ent no [ in] t h e ti m er ev en t n u m b er i nclu de dr iv er /dr v t i me r .h ret urn va lue no n e e x a m p le / * c lo s e th e s p ec i f ied t i m e r ev en t * / dr v t i me r _ c lear t im er e v e n t ( e _ t mr0 , u t im er e v e n tno ); pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 80 - drvti m e r_ e nabl e int p ro t o t y pe in t3 2 _ t d r v t i me r _ e n ab lei n t ( e_ t i me r _ c ha nne l ch ) descript io n t h is f u n cti o n is u s ed to en ab le th e s p ec if ied t i m er i n ter r upt. p a ra m et er ch [ in] e_ ti m e r_ ch ann e l , it c o u ld b e e _ t mr0 / e _ t mr1 / e _ t mr2 / e _ t mr3 i nclu de dr iv er / dr v t i me r .h ret urn va lue e _ suc c e ss : o p er atio n s u cc ess f u l e _ dr vt i me r _ c hann e l : i n v alid t i m er ch a n n el e x a m p le / * e n ab le t i m er - 0 i n ter r u p t f u n ctio n * / dr v t i me r _ e n ab lei n t ( e_ t m r 0 ) ; drvti m e r_ dis a bl e int p ro t o t y pe in t3 2 _ t d r v t i me r _ dis ab le i n t ( e_ t i me r _ c ha n ne l ch ) descript io n t h is f u n ctio n is u s ed to d is ab le th e s p ec if ied t i m er i n ter r upt. p a ra m et er ch [ in] e_ ti m e r_ ch ann e l , it c o u ld b e e _ t mr0 / e _ t mr1 / e _ t mr2 / e _ t mr3 i nclu de dr iv er / dr v t i me r .h ret urn va lue e _ suc c e s s : o p er atio n s u cc ess f u l e _ dr vt i me r _ c hann e l : i n v alid t i m er ch a n n el e x a m p le / * dis ab le t i m er - 0 i n ter r u p t f u n ct io n * / dr v t i me r _ dis ale i n t ( e_ t m r 0 ) ; pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 81 - drvti m e r_g e tint fla g p ro t o t y pe in t3 2 _ t dr v t i me r _ geti n tfl a g ( e_ t i me r _ c h a nne l ch ) descript io n get th e i n ter r u p t fl ag s tatu s f r o m t h e s p ec i f ied t i m er ch a n n e l. p a ra m et er ch [ in] e_ ti m e r_ ch ann e l , it c o u ld b e e _ t mr0 / e _ t mr1 / e _ t mr2 / e _ t mr3 i nclu de dr iv er /dr v t i me r .h ret urn va lue ii n tst at u s : 0 is no in ter r u p t , 1 is i n ter r u p t o cc u r r ed e _ dr vt i me r _ c hann e l : i n v alid t i m er ch a n n el e x a m p le / * get t h e in ter r u p t f la g s tat u s f r o m t i m er - 0 * / u 3 2 t mr0 i n tfl ag = dr v t i me r _ geti n t flag ( e_ t mr0 ) ; drvti m e r_ cle a r intfla g p ro t o t y pe in t3 2 _ t dr v t i me r _ c lear i n tf lag ( e_ t i me r _ c ha nne l c h ) descript io n c lear th e i n ter r u p t f lag o f th e s p ec if ied t i m er ch a n n el . p a ra m et er ch [ in] e_ ti m e r_ ch ann e l , it c o u ld b e e _ t mr0 / e _ t mr1 / e _ t mr2 / e _ t mr3 i nclu de dr iv er /dr v t i me r .h ret urn va lue e _ suc c e ss : o p er atio n s u cc ess f u l e _ dr vt i me r _ c hann e l : i n v alid t i m er ch a n n el e x a m p le / * c lear t i m er - 0 i n ter r u p t f lag * / dr v t i me r _ c lear i n tfl a g ( e_ t mr0 ) ; pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 82 - drvti m e r_ s tart p ro t o t y pe in t3 2 _ t dr v t i me r _ star t ( e_ t i me r _ c ha nne l c h ) descript io n star t to co u n t t h e s p ec i f ied t im er ch a n n e l . p a ra m et er ch [ in] e_ ti m e r_ ch ann e l , it c o u ld b e e _ t mr0 / e _ t mr1 / e _ t mr2 / e _ t mr3 i nclu de dr iv er /dr v t i me r . h ret urn va lue e _ suc c e ss : o p er atio n s u cc ess f u l e _ dr vt i me r _ c hann e l : i n v alid t i m er ch a n n el e x a m p le / * star t to co u n t th e t i m er - 0 * / dr v t i me r _ star t ( e_ t mr0 ) ; drvti m e r_g e t int tic k s p ro t o t y pe u in 3 2 _ t dr v t i me r _ get i n t t ick s ( e_ t i me r _ c ha n ne l ch ) descript io n t h is f u n ctio n is u s ed to g et t h e n u m b er o f in ter r u p t o cc u r r ed af ter th e ti m er in ter r u p t f u n ctio n is e n ab led . p a ra m et er ch [ in] e_ ti m e r_ ch ann e l , it c o u ld b e e _ t mr0 / e _ t mr1 / e _ t mr2 / e _ t mr3 i nclu de dr iv er / dr v t i me r .h ret urn va lue u t i m er t ick : r etu r n th e i n ter r u p t tick s e _ dr vt i me r _ c hann e l : i n v alid t i m er ch a n n el e x a m p le pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 83 - / * get t h e cu r r en t i n ter r u p t tic k s f r o m t i m er - 1 * / u 3 2 t mr1 t ick s = dr v t i me r _ get i n t t ick s ( e_ t mr1 ) ; drvti m e r_re s e t int ti c k s p ro t o t y pe in t3 2 _ t dr v t i me r _ r eset i n t t ick s ( e_ t i me r _ c ha n ne l ch ) descript io n t h is f u n ctio n is u s ed to clea r in ter r u p t tic k s to 0 . p a ra m et er ch [ in] e_ ti m e r_ ch ann e l , it c o u ld b e e _ t mr0 / e _ t mr1 / e _ t mr2 / e _ t mr3 i nclu de dr iv er / dr v t i me r .h ret urn va lue e _ suc c e ss : o p er atio n s u cc ess f u l e _ dr vt i me r _ c hann e l : i n v alid t i m er ch a n n el e x a m p le / * r e s et th e i n ter r u p t tic k s o f t im er - 1 to 0 * / dr v t i me r _ r eset i n t t ick s ( e_ t mr1 ) ; drvti m e r_de la y p ro t o t y pe v o id dr v t i me r _ dela y ( e_ t i me r _ c h a n ne l c h , u i n t3 2 _ t u i n t t ick s ) descript io n t h is f u n ctio n is u s ed to ad d a d elay lo o p b y s p ec if ied in ter r u p t tick s o f t h e ti m e r ch a n n el. p a ra m et er ch [ in] e_ t i me r _ c hann e l , it c o u ld b e e _ t mr0 / e _ t mr1 / e _ t mr2 / e _ t mr3 u i nt t ic k s [ in] t h e d elay tic k s i nclu de dr iv er / dr v t i me r .h ret urn va lue pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 84 - no n e e x a m p le / * dela y t i m er - 0 3 0 0 0 tick s * / dr v t i me r _ dela y ( e_ t mr 0 , 3 0 0 0 ); drvti m e r_o pen cou nt er p ro t o t y pe in t3 2 _ t dr v t i me r _ op en c o u n ter ( e_ t i me r _ c hann e l ch , u in t3 2 _ t u c o u n ter b o u n d ar y , e_ t i me r _ op mo de o p _ m o d e ); descript io n t h is f u n ctio n is u s ed to o p en th e ti m er ch a n n el w i th t h e s p ec if ied o p er atio n m o d e. an d th e co u n ti n g s o u r ce o f ti m er is f r o m th e e x ter n al ev e n t /co u n ter . t h e t i me r clo ck s o u r ce s h o u ld b e s et as hc l k . no t e on l y nuc1 x 0 x x x b x an d nu c 1 x 0 x x x c x s er ies s u p p o r t th i s f u n c tio n , e x : nuc1 4 0 r d2 b n an d nuc1 4 0 ve 3 c n. p lease r ef er to nu mic r o tm nu c 1 0 0 ser ies p r o d u cts selec tio n gu id e o f a p p en d i x i n d etails . p a ra m et er ch [ in] e_ ti m e r_ ch ann e l , it c o u ld b e e _ t mr0 / e _ t mr1 / e _ t mr2 / e _ t mr3 uco un t er b o un da ry [ in] t h e p ar am eter is u s ed to d eter m i n e h o w m an y co u n ts o cc u r r ed w ill to g g le o n ce t i m er i n ter r u p t o p_ m o de [ in] e_ ti m e r_ o p m o de , it ? s i n clu d ed e_ one shot _ mo de / e_ p e r i odi c _ mo de / e_ c ont i nuou s_ mo de i nclu de dr iv er / dr v t i me r .h ret urn va lue e _ suc c e ss : o p er atio n s u cc ess f u l e _ dr vt i me r _ c hann e l : i n v alid t i m er ch a n n el e _ dr vt i me r _ e i o : t im er h as n o t b ee n i n itia lized e x a m p le pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 85 - / * set t i m er - 0 r u n i n on e - s h o t m o d e b y e x ter n a l c o u n ter . a n d w h en t h e co u n ter co u n tin g to 1 2 3 , t im er - 0 i n ter r u p t w il l o cc u r r ed * / dr v t i me r _ op en c o u n ter ( e _ t mr0 , 1 2 3 , e_ one shot _ mo de ) ; drvti m e r_ s tartc ount e r p ro t o t y pe in 3 2 _ t dr v t i me r _ star tc o u n ter ( e_ t i me r _ c ha nne l ch ) descript io n star t c o u n t in g o f t h e s p ec i f ied t i m er ch a n n el . no t e on l y nuc1 x 0 x x x b x an d nu c 1 x 0 x x x c x s er ies s u p p o r t th i s f u n c tio n , e x : nuc1 4 0 r d2 b n an d nuc1 4 0 ve 3 c n. p lease r ef er to nu mic ro tm nu c 1 0 0 ser ies p r o d u cts selec tio n gu id e o f a p p en d i x i n d etails . p a ra m et er ch [ in] e_ ti m e r_ ch ann e l , it c o u ld b e e _ t mr0 / e _ t mr1 / e _ t mr2 / e _ t mr3 i nclu de dr iv er / dr v t i me r .h ret urn va lue e _ suc c e ss : o p er atio n s u cc ess f u l e _ dr vt i me r _ c hann e l : i n v alid t i m er c h a n n el e x a m p le / * star t to co u n t th e t i m er - 0 b y ex ter n al co u n ter * / dr v t i me r _ star tc o u n ter ( e _ t mr0 ); drvti m e r_g e t cou nt e rs p ro t o t y pe u in 3 2 _ t dr v t i me r _ get c o u n ter s ( e_ t i me r _ c hann e l ch ) descript io n t h is f u n ctio n is u s ed to g et t h e cu r r en t c o u n ter s o f t h e s p ec i f ied t i m er ch an n el . on l y nuc1 x 0 x x x b x an d nu c 1 x 0 x x x c x s er ies s u p p o r t th i s f u n c tio n , e x : nuc1 4 0 r d2 b n an d nuc1 4 0 ve 3 c n. p lease r ef er to nu mic r o tm nu c 1 0 0 ser ies p r o d u cts selec tio n gu id e o f a p p en d i x i n d etails . p a r a m et er ch [ in] e_ ti m e r_ ch ann e l , it c o u ld b e e _ t mr0 / e _ t mr1 / e _ t mr2 / e _ t mr3 pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 86 - i nclu de dr iv er / dr v t i me r .h ret urn va lue u 3 2 c o u n ter s : r etu r n cu r r en t c o u n ter s e _ dr vt i me r _ c hann e l : i n v alid t i m er ch a n n el e x a m p le: / * get t h e cu r r en t c o u n t s o f t im er - 0 * / u 3 2 t mr 0 e x t t ick s = dr v t i m e r _ getco u n ter s ( e_ t mr0 ); drvti m e r_o pen capt ure p ro t o t y pe in t3 2 _ t dr v t i me r _ op en c ap tu r e ( e_ t i me r _ c hann e l ch , e _ t i me r _ r st c a p _ mo de m o d e ); descript io n t h is f u n ctio n is u s ed to in it ial th e ex ter n al ti m er ca p tu r e s o u r ce an d s et to s tar t c atp u r e o r r eset sp ec if ied ti m er co u n ter . t h e t i me r clo ck s o u r ce s h o u ld b e s et as hc l k . on l y nuc1 x 0 x x x c x s er ies s u p p o r t th is f u n ctio n , e x :n uc 1 4 0 ve 3 c n. p a ra m et er ch [ in] e_ ti m e r_ ch ann e l , it c o u ld b e e _ t mr0 / e _ t mr1 / e _ t mr2 / e _ t mr3 m o de [ i n] e _ t i m e r_ rs t cap _ m o de , e _ c a p t ur e : ru n ca p tu r e f u n ct io n e _ r e set : r eset c o u n ter v a l u e o f s p ec i f ied ti m er ch an n el i nclu de dr iv er / dr v t i me r .h ret urn va lue e _ suc c e ss : o p er atio n s u cc ess f u l e _ dr vt i me r _ c hann e l : i n v alid t i m er ch a n n el e x a m p le / * op en e x ter n al t i m er - 0 ca p tu r e f u n ct i o n * / dr v t i me r _ op en c ap tu r e ( e _ t mr0 , e _ c a p t ur e ) ; pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 87 - drvti m e r_ clos e cap tu re p ro t o t y pe in t3 2 _ t dr v t i me r _ c lo s ecap tu r e ( e_ t i me r _ c hann e l ch , ); descript io n t h is f u n ctio n is u s ed to clo s e th e ex ter n al ti m er ca p tu r e s o u r ce . on l y nuc1 x 0 x x x c x s er ies s u p p o r t th is f u n ctio n , e x :n uc 1 4 0 ve 3 c n. p a ra m et er ch [ in] e_ ti m e r_ ch ann e l , it c o u ld b e e _ t mr0 / e _ t mr1 / e _ t mr2 / e _ t mr3 i nclu de dr iv er / dr v t i me r .h ret urn va lue e _ suc c e ss : o p er atio n s u cc ess f u l e _ dr vt i me r _ c hann e l : i n v alid t i m er ch a n n el e x a m p le / * c lo s e ex ter n al t im er - 0 c ap tu r e f u n ct io n * / dr v t i me r _ c lo s ecap tu r e ( e _ t mr0 ) ; drvti m e r_ s e l e c te x terna lmod e p ro t o t y pe in t3 2 _ t dr v t i me r _ selecte x t er n alm o d e ( e_ t i me r _ c hann e l ch , e _ t i me r _ r st c a p _ mo de m o d e ); descript io n t h is f u n ctio n is u s ed to s elec t to r u n ca p tu r e f u n ctio n o r r ese t th e ti m er co u n ter . on l y nuc1 x 0 x x x c x s er ies s u p p o r t th is f u n ctio n , e x :n uc 1 4 0 ve 3 c n. p a ra m et er ch [ in] e_ ti m e r_ ch ann e l , it c o u ld b e e _ t mr0 / e _ t mr1 / e _ t mr2 / e _ t mr3 m o de [ i n] e _t i m e r_ rs t cap _ m o d e , pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 88 - e _ c a p t ur e : ru n ca p tu r e f u n ct io n e _ r e set : r eset c o u n ter v a l u e o f s p ec i f ied ti m er ch an n el i nclu de dr iv er / dr v t i me r .h ret urn va lue e _ suc c e ss : o p er atio n s u cc ess f u l e _ dr vt i me r _ c hann e l : i n v alid t i m er ch a n n el e x a m p le / * select t i m er - 0 r u n s in ca p t u r e f u n ct io n * / dr v t i me r _ selecte x ter n al m o d e ( e _ t mr0 , e _ c a p t ur e ) ; d rv timer_ s e l e c tc a p tu re e dge p ro t o t y pe in t3 2 _ t dr v t i me r _ op en c ap tu r e ( e_ t i me r _ c hann e l ch , e _ t i me r _ t e x_ e dge ed g e ); descript io n t h is f u n ctio n is u s ed to co n f i g u r e th e d etec t e d g e o f ti m er ca p tu r e m o d e . on l y nuc1 x 0 x x x c x s er ies s u p p o r t th is f u n ctio n , e x: n uc 1 4 0 ve 3 c n. p a ra m et er ch [ in] e_ ti m e r_ ch ann e l , it c o u ld b e e _ t mr0 / e _ t mr1 / e _ t mr2 / e _ t mr3 edg e [ in] e_ t i m e r_ t e x_ e d g e , e_ e dge _ fall i ng : 1 to 0 tr an s itio n o n t e x w ill b e d etec ted . e_ e dge _ r i sin g : 0 to 1 tr a n s it io n o n t e x w ill b e d etec te d . e_ e dge _ b o t h : eith er 0 to 1 o r 1 to 0 tr an s itio n o n t e x w il l b e d etec ted . i nclu de dr iv er / dr v t i me r .h ret urn va lue e _ suc c e ss : o p er atio n s u cc ess f u l e _ dr vt i me r _ c hann e l : i n v alid t i m er ch a n n el e x a m p le pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 89 - / * c o n f i g u r e ti m er - 0 ca p tu r e d etec t o cc u r r d w h e n 0 to 1 tr an s itio n o n e x te r n a l c ap tu r e p in * / dr v t i me r_ selectcap tu r ee d g e ( e _ t mr0 , e _ e dge _ r i sin g ) ; drvti m e r_ e nabl e ca pt ure int p ro t o t y pe in t3 2 _ t dr v t i me r _ e n ab lec ap tu r ei n t ( e_ t i me r _ c hann e l ch , ); descript io n t h is f u n ctio n is u s ed to en ab le th e ti m er ex ter n a l in ter r u p t f u n ctio n . i f an y tr an s itio n o n t e x p in an d m atc h ed w ith t h e e_ t i m e r_ t e x_ e dg e s et tin g s , s y s t e m w il l c au s e th e e x ter n al i n ter r u p t f lag ( t e xi f) to 1 . on l y nuc1 x 0 x x x c x s er ies s u p p o r t th is f u n ctio n , e x :n uc 1 4 0 ve 3 c n. p a ra m et er ch [ in] e_ ti m e r_ ch ann e l , it c o u ld b e e _ t mr0 / e _ t mr1 / e _ t mr2 / e _ t mr3 i nclu de dr iv er / dr v t i me r .h ret urn va lue e _ suc c e ss : o p er atio n s u cc ess f u l e _ dr vt i me r _ c hann e l : i n v alid t i m er ch a n n el e x a m p le / * e n ab le e x ter n al ti m er - 0 ca p tu r e d etec t in ter r u p t f u n ctio n * / dr v t i me r _ e n ab lec ap tu r ei n t ( e _ t mr0 ) ; drvti m e r _ dis a bl e ca pt ure int p ro t o t y pe in t3 2 _ t dr v t i me r _ dis ab lec ap tu r ei n t ( e_ t i me r _ c hann e l ch , ); descript io n t h is f u n ctio n is u s ed to d is ab le th e ti m er ex ter n a l in ter r u p t f u n ct io n . on l y nuc1 x 0 x x x c x s er ies s u p p o r t th is f u n ctio n , e x :n uc 1 4 0 ve 3 c n. p a ra m et er ch [i n] pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 90 - e_ ti m e r_ ch ann e l , it c o u ld b e e _ t mr0 / e _ t mr1 / e _ t mr2 / e _ t mr3 i nclu de dr iv er / dr v t i me r .h ret urn va lue e _ suc c e ss : o p er atio n s u cc ess f u l e _ dr vt i me r _ c hann e l : i n v alid t i m er ch a n n el e x a m p le / * dis ab le e x ter n al t i m er - 0 ca p tu r e d etec t in ter r u p t f u n ctio n * / dr v t i me r_ dis ab le c ap tu r ei n t ( e _ t mr0 ) ; drvti m e r_ e nabl e ca pt ure p ro t o t y pe in t3 2 _ t dr v t i me r _ e n ab lec ap tu r e ( e_ t i me r _ c hann e l ch , ); descript io n t h is f u n ctio n is u s ed to en ab le th e s p ec if ied ca p tu r e f u n ct io n . on l y nuc1 x 0 x x x c x s er ies s u p p o r t th is f u n ctio n , e x :n uc 1 4 0 ve 3 c n. p a ra m et er ch [ in] e_ ti m e r_ ch ann e l , it c o u ld b e e _ t mr0 / e _ t mr1 / e _ t mr2 / e _ t mr3 i nclu de dr iv er / dr v t i me r .h ret urn va lue e _ suc c e ss : o p er atio n s u cc ess f u l e _ dr vt i me r _ c hann e l : i n v alid t i m er ch a n n el e x a m p le / * e n ab le e x ter n al ti m er - 0 ca p tu r e f u n c tio n * / dr v t i me r _ e n ab lec ap tu r e ( e _ t mr0 ) ; drvti m e r_ dis a bl e ca pt ure p ro t o t y pe in t3 2 _ t dr v t i me r _ dis ab lec ap tu r e ( e_ t i me r _ c hann e l ch , pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 91 - ); descript io n t h is f u n ctio n is u s ed to d is ab le th e s p ec if ied ca p tu r e f u n ct io n . on l y nuc1 x 0 x x x c x s er ies s u p p o r t th is f u n cti on , e x :n uc 1 4 0 ve 3 c n. p a ra m et er ch [ in] e_ ti m e r_ ch ann e l , it c o u ld b e e _ t mr0 / e _ t mr1 / e _ t mr2 / e _ t mr3 i nclu de dr iv er / dr v t i me r .h ret urn va lue e _ suc c e ss : o p er atio n s u cc ess f u l e _ dr vt i me r _ c hann e l : i n v alid t i m er ch a n n el e x a m p le / * dis ab le e x ter n al t i m er - 0 ca p tu r e f u n ctio n * / dr v t i me r_ dis ab lec ap tu r e ( e _ t mr0 ) ; drvti m e r_ ge tc a pt ur e data p ro t o t y pe in t3 2 _ t dr v t i me r _ getcap tu r eda ta ( e_ t i me r _ c hann e l ch , ); descript io n t h is f u n ctio n is u s ed to g et t h e ca p tu r e v alu e o f th e s p ec if ie d ti m er ch a n n el . an d th e r et u r n d ata is v alid o n l y i f th e ca p t u r e in ter r u p t f lag s et to 1 b y h. w . on l y nuc1 x 0 x x x c x s er ies s u p p o r t th is f u n ctio n , e x :n uc 1 4 0 ve 3 c n. p a ra m et er ch [ in] e_ ti m e r_ ch ann e l , it c o u ld b e e _ t mr0 / e _ t mr1 / e _ t mr2 / e _ t mr3 i nclu de dr iv er / dr v t i me r .h ret urn va lue c ap tu r e v al ue : r et u r n ca p tu r e v alu e e _ dr vt i me r _ c hann e l : i n v alid t i m er ch a n n el e x a m p le pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 92 - / * get t h e ex ter n al ti m er - 0 ca p tu r e in ter r u p t stat u s * / u in t3 2 _ t u 3 2 i n tst at u s , u 3 2 c u r data ; u 3 2 i n tst at u s = dr v t i me r_ getcap tu r ei n tfl a g ( e _ t mr0 ) ; if ( u 3 2 i n ts tatu s == 1 ) { / * get t h e cu r r en t c ap t u r e d ata f r o m ti m er - 0 * / u 3 2 c u r data = dr v t i me r _ getcap tu r eda ta ( e _ t mr0 ); } drvti m e r_ ge tc a pt ur e intfla g p ro t o t y pe in t3 2 _ t dr v t i me r _ getcap tu r ei n tfl ag ( e_ t i me r _ c hann e l ch , ); descript io n get th e ex ter n al i n ter r u p t f lag s tatu s f r o m th e s p ec if ied ti m er ch an n el . on l y nuc1 x 0 x x x c x s er ies s u p p o r t th is f u n ctio n , e x :n uc 1 4 0 ve 3 c n. p a ra m et er ch [ in] e_ ti m e r_ ch ann e l , it c o u ld b e e _ t mr0 / e _ t mr1 / e _ t mr2 / e _ t mr3 i nclu de dr iv er / dr v t i me r .h ret urn va lue e x ter n al i n ter r u p t f lag : 0 :no in ter r u p t / 1 :i n ter r u p t o cc u r r ed e _ dr vt i me r _ c hann e l : i n v alid t i m er ch a n n el e x a m p le / * get t h e ex ter n al ti m er - 0 ca p tu r e in ter r u p t stat u s * / u in t3 2 _ t u 3 2 i n tst at u s , u 3 2 c u r data ; u 3 2 i n tst at u s = dr v t i me r_ getcap tu r ei n tfl a g ( e _ t mr0 ) ; if ( u 3 2 i n ts tatu s == 1 ) { / * get t h e cu r r en t c ap t u r e d ata f r o m ti m er - 0 * / u 3 2 c u r data = dr v t i me r _ getcap tu r eda ta ( e _ t mr0 ); } drvti m e r_ cle a rc a pt ure intfla g p ro t o t y pe pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 93 - in t3 2 _ t dr v t i me r _ getcap tu r ei n tfl ag ( e_ t i me r _ c hann e l ch , ); descript io n c lear th e e x ter n al i n ter r u p t f la g o f t h e s p ec if ied ti m er ch a n n el . on l y nuc1 x 0 x x x c x s er ies s u p p o r t th is f u n ctio n , e x :n uc 1 4 0 ve 3 c n. p a ra m et er ch [ in] e_ ti m e r_ ch ann e l , it c o u ld b e e _ t mr0 / e _ t mr1 / e _ t mr2 / e _ t mr3 i nclu de dr iv er / dr v t i me r .h ret urn va lue e _ suc c e ss : o p er atio n s u cc ess f u l e _ dr vt i me r _ c hann e l : i n v alid t i m er ch a n n el e x a m p le / * get t h e ex ter n al ti m er - 0 ca p tu r e in ter r u p t stat u s * / u in t3 2 _ t u 3 2 i n tst at u s , u 3 2 c u r data ; u 3 2 i n tst at u s = dr v t i me r_ getcap tu r ei n tfl a g ( e _ t mr0 ) ; if ( u 3 2 i n ts tatu s == 1 ) { / * get t h e cu r r en t c ap t u r e d ata f r o m ti m er - 0 * / u 3 2 c u r data = dr v t i me r _ getcap t u r eda ta ( e _ t mr0 ); / * c lear ca p tu r e i n ter r u p t sta tu s to r ec eiv e th e n ex t v alid ca p t u r e v al u e * / dr v t i me r _ c lear c ap tu r ei n t f lag ( e _ t mr0 ); } drvti m e r_ e nabl e ca pt ure debounce p ro t o t y pe in t3 2 _ t dr v t i me r _ e n ab lec ap tu r ede b o u n ce ( e_ t i me r _ c hann e l ch , ); descript i on e n ab le th e d eb o u n ce f u n ctio n o f s p ec if ied e x ter n al ca p t u r e in p u t so u r ce . on l y nuc1 x 0 x x x c x s er ies s u p p o r t th is f u n ctio n , e x :n uc 1 4 0 ve 3 c n. p a ra m et er ch [ in] pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 94 - e_ ti m e r_ ch ann e l , it c o u ld b e e _ t mr0 / e _ t mr1 / e _ t mr2 / e _ t mr3 i nclu de dr iv er / dr v t i me r .h ret urn va l ue e _ suc c e ss : o p er atio n s u cc ess f u l e _ dr vt i me r _ c hann e l : i n v alid t i m er ch a n n el e x a m p le / * e n ab le e x ter n al ti m er - 0 ca p tu r e d eb o u n ce f u n ctio n * / dr v t i me r _ e n ab lec ap tu r ede b o u n ce ( e _ t mr0 ) ; drvti m e r_ dis a bl e ca pt ure debounce p ro t o t y pe in t3 2 _ t dr v t i me r _ dis ab lec ap tu r ede b o u n ce ( e_ t i me r _ c hann e l ch , ); descript io n dis ab le th e d eb o u n ce f u n ct io n o f s p ec if ied ex ter n al ca p tu r e i n p u t so u r ce . on l y nuc1 x 0 x x x c x s er ies s u p p o r t th is f u n ctio n , e x :n uc 1 4 0 ve 3 c n. p a ra m et er ch [ in] e_ ti m e r_ ch ann e l , it c o u ld b e e _ t mr0 / e _ t mr1 / e _ t mr2 / e _ t mr3 i nclu de dr iv er / dr v t i me r .h ret urn va lue e _ suc c e ss : o p er atio n s u cc ess f u l e _ dr vt i me r _ c hann e l : i n v alid t i m er ch a n n el e x a m p le / * dis ab le e x ter n al t i m er - 0 ca p tu r e d eb o u n ce f u n ct io n * / dr v t i me r_ dis a b lec ap tu r ed eb o u n ce ( e _ t mr0 ) ; drvti m e r_ e nabl e cou nt e rdebounc e p ro t o t y pe in t3 2 _ t dr v t i me r _ e n ab lec o u n ter deb o u n ce ( e_ t i me r _ c hann e l ch , pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 95 - ); descript io n e n ab le th e d eb o u n ce f u n ctio n o f s p ec if ied e x ter n al co u n ter i n p u t so u r ce . on l y nuc1 x 0 x x x c x s er ies s u p p o r t th is f u n ctio n , e x :n uc 1 4 0 ve 3 c n. p a ra m et er ch [ in] e_ ti m e r_ ch ann e l , it c o u ld b e e _ t mr0 / e _ t mr1 / e _ t mr2 / e _ t mr3 i nclu de dr iv er / dr v t i me r .h ret urn va lue e _ suc c e ss : o p er atio n s u cc ess f u l e _ dr vt i me r _ c hann e l : i n v alid t i m er ch a n n el e x a m p le / * e n ab le e x ter n al ti m er - 0 co u n ter d eb o u n ce f u n ctio n * / dr v t i me r _ e n ab le c o u n ter d eb o u n ce ( e _ t mr0 ) ; drvti m e r_ dis a bl e cou nt e rdebounc e p ro t o t y pe in t3 2 _ t dr v t i me r _ dis ab lec o u n ter deb o u n ce ( e_ t i me r _ c hann e l ch , ); descript io n dis ab le th e d eb o u n ce f u n ct io n o f s p ec if ied ex ter n al co u n ter i n p u t so u r ce . on l y nuc1 x 0 x x x c x s er ies s u p p o r t th is f u n ctio n , e x :n uc 1 4 0 ve 3 c n. p a ra m et er ch [ in] e_ ti m e r_ ch ann e l , it c o u ld b e e _ t mr0 / e _ t mr1 / e _ t mr2 / e _ t mr3 i nclu de dr iv er / dr v t i me r .h ret urn va lue e _ suc c e ss : o p er atio n s u cc ess f u l e _ dr vt i me r _ c hann e l : i n v alid t i m er ch a n n el e x a m p le pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 96 - / * dis ab le e x ter n al t i m er - 0 co u n ter d eb o u n ce f u n ct io n * / dr v t i me r_ dis a b le c o u n ter d eb o u n ce ( e _ t mr0 ) ; drvti m e r_ s e l e c tc ount e rdete c tpha s e p ro t o t y pe in t3 2 _ t dr v t i me r _ selectco u n ter de tectp h ase ( e_ t i me r _ c hann e l ch , e _ t i me r _ t x_ p ha se p h ase ); descript io n t h is f u n ctio n is u s ed t o co n f i g u r e th e co u n ter d etec t p h ase o f s p ec if ied s o u r ce . on l y nuc1 x 0 x x x c x s er ies s u p p o r t th is f u n ctio n , e x :n uc 1 4 0 ve 3 c n. p a ra m et er ch [ in] e_ ti m e r_ ch ann e l , it c o u ld b e e _ t mr0 / e _ t mr1 / e _ t mr2 / e _ t mr3 edg e [ in] e_ t i m e r_ t x_ p h as e , e _ p ha se_ f al l i ng : a f al l in g ed g e o f ex ter n al co u n ter p i n w ill b e co u n ted . e _ p ha se_ r i sin g : a r is i n g ed g e o f ex ter n a l c o u n ter p in w il l b e co u n ted . i nclu de dr iv er / dr v t i me r .h ret urn va lue e _ suc c e ss : o p er atio n s u cc ess f u l e _ dr vt i me r _ c hann e l : i n v alid t i m er ch a n n el e x a m p le / * c o n f i g u r e ti m er - 0 co u n ter d etec t p h ase is f r o m lo w to h i g h * / dr v t i me r_ selectco u n ter det ec tp h ase ( e _ t mr0 , e _ p ha se_ r i sin g ) ; drvt imer _ ge tve rs io n p ro t o t y pe u in t3 2 _ t dr v t i me r _ getve r s io n ( v o id ) descript io n get th e v er s io n n u m b er o f t im er /w dt d r iv er . i nclu de dr iv er /dr v t i mer .h pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 97 - return value version number : 31:24 23:16 15:8 7:0 00000000 major_num minor_num build_num e x a m p le / * get t h e cu r r en t v er s io n o f t i m er dr iv er * / u 3 2 ver s io n = dr v t i me r _ getve r s io n (); drvwd t_o pen p ro t o t y pe i n t3 2 _ t dr v w dt _ op en ( e_ w dt _ i n t e r va l w dt lev el ) descript io n e n ab le w dt en g in e clo ck a n d s et w dt t im e - o u t i n ter v al. a ll b it s in w dt r eg is ter ar e w r ite - p r o tecte d . user m u s t to ch ec k th e r e gw r p r ot b it is en ab led o r d is ab led if w r ite th e s p ec if ied w dt b it f ail. p a ra m et er wdt lev el [ in] e_ w d t _ i n t e r val , en u m e r ate th e w dt t im e - o u t i n ter v a l . r ef er to w dt _ i n t e r val e n u m er ati o n f o r d etail ti m e - o u t v al u e. i nclu de dr iv er / dr v t i me r . h ret urn va lue e _ suc c e ss : o p er atio n s u cc ess f u l e _ dr vw dt _ o p e n : w d t o p en f ail e x a m p le / * set t h e w dt tim e - o u t in ter v al is ( 2 ^1 6 )* w dt _ c l k */ dr v w dt _ op en ( e_ w d t _ l e ve l 6 ) ; drvwd t_cl ose p ro t o t y pe v o id dr v w dt _ c lo s e ( v o id ) descript io n t h e f u n c tio n i s u s ed to s to p /d i s ab le w dt r elativ e f u n c tio n s . a ll b it s in w dt r eg is ter ar e w r ite - p r o tecte d . user m u s t to ch ec k th e r e gw r p r ot b it is en ab led o r d is ab led if w r ite th e s p ec if ied w dt b it f ail. pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 98 - p a ra m et er no n e i nclu de dr iv er / dr v t i me r .h ret urn va lue no n e e x a m p le / * c lo s e w atch do g t i m er * / dr v w dt _ c lo s e (); drvwd t_i nsta ll is r p ro t o t y pe v o id dr v w dt _ i n s talli sr ( w dt _ c a l l b ac k pvw dt i sr ) descript io n t h e f u n c tio n i s u s ed to in s tall w dt in ter r u p t ser v ice r o u tin e . a ll b it s in w dt r eg is ter ar e w r ite - p r o tecte d . user m u s t to ch ec k th e r e gw r p r ot b it is en ab led o r d is ab led if w r ite th e s p ec if ied w dt b it f ail. p a ra m et er pv wdt i sr [ in] t h e f u n c tio n p o in ter o f t h e i n t er r u p t s er v ice r o u ti n e i nclu de dr iv er /dr v t i me r .h ret urn va lue no n e e x a m p le / * i n s tall t h e w dt ca llb ac k f u n ctio n * / dr v w dt _ i n s talli sr ( ( w dt _ c al l b ac k) w dt _ c allb ac k ) ; drvwd t_i octl p ro t o t y pe in t3 2 _ t dr v w d t _ i o ctl ( e_ w dt _ c md u w dt c m d , u i n t3 2 _ t u a r g u m e n t) descript io n t h e f u n c tio n i s u s ed to o p er ate m o r e w dt ap p licatio n s , it c o u ld b e th e s tar t/s to p th e w dt , en ab le/d is ab le w d t in ter r u p t f u n ctio n , en ab le/d is ab le w dt tim e - o u t w a k e u p f u n ctio n , en ab le/d is a b le s y s te m r eset w h e n w dt ti m e - o u t a n d s et th e w dt ti m e - o u t pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 99 - in ter v a l. a ll b it s in w dt r eg is ter ar e w r ite - p r o tecte d . user m u s t to ch ec k th e r e gw r p r ot b it is en ab led o r d is ab led if w r ite th e s p ec if ied w dt b it f ail. p a ra m et er u wdt c m d [ i n] e_ w dt _ cm d co m m a n d s , it co u ld b e th e o n e o f th e f o llo w co m m a n d s e_ w d t _ i oc _ s t a r t _ t i me r e_ w d t _ i oc _ s t op _ t i me r e_ w dt _ i oc _ e na b l e _ i n t e_ w d t _ i oc _ di sa b l e _ i n t e_ w d t _ i oc _ e na b l e _ w a ke up e_ w d t _ i oc _ di sa b l e _ w a ke up e_ w d t _ i oc _ r e set _ t i me r e_ w d t _ i oc _ e na b l e _ r e set _ func e_ w d t _ i oc _ di sa b l e _ r e set _ fun c e_ w d t _ i oc _ se t _ i n t e r val uar g u m ent [ in] set th e a r g u m e n t f o r th e s p ec if ied w dt co m m a n d i nclu de dr iv er / dr v t i me r .h ret urn va lue e _ suc c e ss : o p er atio n s u cc ess f u l e_ dr vw dt _ c md : i n v alid w dt c o m m a n d e x a m p le / * star t to co u n t w dt b y ca lli n g w dt _ i oc _ st a r t _ t i m e r co m m an d * / dr v w dt _ i o ctl ( e_ wd t _ i o c _ st a r t _ t i me r , 0 ) ; pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 100 - 5. gpio dr iver 5.1. gpio introduction nuc1 00 me d iu m de n s i t y ser ies h a s u p to 80 gen er al p u r p o s e i /o p in s ca n be s h ar ed w ith o th e r f u n ctio n p in s ; it d ep en d s o n t h e ch ip co n f i g u r atio n . t h ese 8 0 p in s ar e ar r an g ed in 5 p o r ts n a m ed w ith gp i oa , gp i ob , gpi oc , gp i od an d gp i oe . e ac h p o r t eq u ip s m ax i m u m 16 p in s . nuc1 0 0 l o w den s it y ser ies h as u p to 65 ge n er al p u r p o s e i /o p in s can be s h ar ed w i th o t h er f u n ct io n p in s ; it d ep en d s o n t h e ch ip co n f ig u r atio n a n d p ac k ag e. t h es e 65 p in s ar e ar r an g ed in 5 p o r ts . gp i oa , gp i ob , g p i oc an d gp i od w it h ea c h p o r t e q u ip s m ax i m u m 1 6 p in s an d gp i oe w it h 1 p in gp e [ 5 ] . 5.2. g pio fea tu re ? ? e ach one of the gpio pins is independent and has the corresponding register bits to control the pin mode function and data. ? ? t h e i /o t y p e o f e ac h o f i /o p in s ca n b e i n d ep en d en tl y s o f t w ar e co n f i g u r ed as in p u t, o u tp u t, o p en - d r ain o r q u asi - b id ir ec tio n al mo de . 5.3. type definition e_ drvgpio_port enumeration identifier value description e_ gpa 0 define gpio port a e_ gpb 1 define gpio port b e_ gpc 2 de fine gpio port c e_ gpd 3 define gpio port d e_ gpe 4 define gpio port e e_ d rvgpio_io enumeration identifier value description e_ io_inpit 0 set gpio as input mode e_ io_output 1 set gpio as output mode e_ io_opendrain 2 set gpio as open - drain mode e_ io _quasi 3 set gpio as quasi - bidirectional mode pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 101 - e_ drvgpio_int_type enumeration identifier value description e_ io_rising 0 set interrupt enable by rising edge or level high e_ io_falling 1 set interrupt enable by falling edge or level low e_ io_both_edge 2 set interrupt enable by both edges(rising and falling) e_ drvgpio_int_mode enumeration identifier value description e_ mode_edge 0 set interrupt mode is edge trigger e_ mode_level 1 set interrupt mode is level trigger e_ drvgpio_dbclksrc enumeration ident ifier value description e_ dbclksrc_hclk 0 de - bounce counter clock source is from hclk e_ dbclksrc_10k 1 de - bounce counter clock source is from internal 10 khz e_ drvgpio_func enumeration identifier pins assignment description e_ func_gpio all gpio pins se t all gpio pins as gpio functions e_ func_clko gpb.12 enable clock driver output function e_ func_i2c0 / e_ func_i2c1 gpa.8~9 / gpa.10~11 enable i2c0 and i2c1 function s e_ func_i2s gpa.15, gpc.0~3 enable i2s function e_ func_can0 gpd.6, gpd.7 enable can 0 f unction e_ func_acmp0 / e_ func_acmp1 gpc.6~7 / gpc.14~15 enable acmp0 and acmp1 function e_ func_spi0 gpc.0~3 enable spi0 ss0, clk, miso0 and mosi0 e_ func_spi0 _ss1 gp b . 10 enable spi0 ss1 function e_ func_spi0 _2bit_mode gp c . 4 and gpc.5 enable spi0 miso1 an d mosi1 e_ func_spi 1 gpc. 8 ~ 11 enable spi 1 ss0, clk, miso0 and mosi0 e_ func_spi 1_ss1 gp b . 9 enable spi 1 ss1 function e_ func_spi 1_2bit_mode gp c . 12 and gpc.13 enable spi 1 miso1 and mosi1 e_ func_spi 2 gp d .0~3 enable spi 2 ss0, clk, miso0 and mosi0 e_ func_spi 2 _ss1 gp a . 7 enable spi 2 ss1 function e_ func_spi 2_2bit_mode gp d . 4 and gpc.5 enable spi 2 miso1 and mosi1 e_ func_spi 3 gp d . 8 ~ 11 enable spi 3 ss0, clk, miso0 and mosi0 e_ func_spi 3_ss1 gp b . 14 enable spi 3 ss1 function e_ func_spi 3_2bit_mode gp d . 12 and gpd.13 ena ble spi 3 miso1 and mosi1 e_ func_spi0 _qfn36pin gpc.0~3 enable spi0 ss0, clk, miso0 and mosi0 for qfn36 package pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 102 - e_ func_spi0 _ss1_qfn36pin gp d . 1 enable spi0 ss1 for qfn36 package e_ func_spi0 _2bit_mode_ qfn36pin gp d . 2 and gp d . 3 enable spi0 miso1 and mosi1 fo r qfn36 package e_ func_adc0 / e_ func_adc1 / e_ func_adc2 / e_ func_adc3 / e_ func_adc4 / e_ func_adc5 / e_ func_adc6 / e_ func_adc7 gpa.0 ~7 enable adc0/adc1/adc2/adc3/ adc4/adc5/adc6/adc7 function s e_ func_extint0 / e_ func_extint1 gpb.14 / gpb.15 enable externa l int0/int1 function s e_ func_tmr0 / e_ func_tmr1 / e_ func_tmr2 / e_ func_tmr3 g p b . 8 ~11 enable timer0/timer1/timer2/ timer3 as toggle/counter mode e_ func_t0 ex / e_ func_t1 ex / e_ func_t2 ex / e_ func_t3 ex gpb. 15, gpe.5, gpb.2 and gpb.3 enable timer0/timer1/time r2/ timer3 as external capture mode e_ func_uart0 gpb.0~3 enable uart0 rx, tx, rts and cts e_ func_uart0 _rx_tx gpb.0~ 1 enable uart0 rx, tx e_ func_uart0 _rts_cts gpb. 2 ~ 3 enable uart0 rts, cts e_ func_uart 1 gpb. 4 ~ 7 enable uart 1 rx, tx, rts and cts e_ func_ua rt 1_rx_tx gpb. 4 ~ 5 enable uart 1 rx, tx e_ func_uart 1 _rts_cts gpb. 6 ~ 7 enable uart 1 rts, cts e_ func_uart2 gpd.14~15 enable uart 2 rx, tx e_ func_pwm01 / e_ func_pwm23 / e_ f unc _p w m4 5 / e_ func_pwm67 gpa.12~13 / gpa.14~15 / gpb.11, gpe.5 / gpe.0~1 enable pwm0 1/p wm23/pwm45/ pwm67 function s e_ func_pwm 0 / e_ func_pwm1 / e_ func_pwm 2 / e_ func_pwm 3 / e_ func_pwm 4 / e_ func_pwm 5 / e_ func_pwm 6 / e_ func_pwm 7 gpa.12 / gpa. 13 / gpa.14 / gpa. 15 / gpb.11 / gpe.5 / gpe.0 / gpe. 1 enable pwm0/p w m 1 /pwm 2 / pwm3/ p w m4 /p w m5 /p wm6/ pwm7 f unction s e_ func_ebi_8b gpb.12~13 ,g pc.14~15 gpc.6~ 7, gpa.6~7, gpb.6~7, gpa10~11 enable ebi with 8 b i t address w i dth e_ func_ebi_16b gpb.12~13 ,g pc.14~15 gpc.6~ 7, gpa.6~7, gpa.5~1,gpa.12~14, gpb.6~7, gpa10~11 gpb.2~3 e na bl e e b i wi th 16 bit address w i dth 5.4. macr os _ dr v gp io _ dout p ro t o t y pe _ dr vgp i o_ dout ( p o r tnu m , p in n u m ) descript io n t h is m ac r o is u s ed to co n tr o l i /o b it ou tp u t /i n p u t c o n tr o l r eg is ter o f t h e s p ec i f ied p in . us er ca n s et o u tp u t d ata v al u e o f t h e s p ec if ied p in b y ca lli n g _ dr vgp i o_ dout m ac r o , if th e pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 103 - gp i o p in is co n f i g u r ed as o u t p u t m o d e. or g et th e i n p u t d ata v alu e b y ca l lin g _ dr vgp i o_ dout d ir ec tly , if t h e gp i o p in is co n f ig u r ed as in p u t m o d e. no t e on l y nuc1 x 0 x x x b x an d nu c 1 x 0 x x x c x s er ies s u p p o r t th i s f u n c tio n , e x : nuc1 4 0 r d2 b n an d nuc1 4 0 ve 3 c n. p lease r ef er to nu mic r o tm nu c 1 0 0 ser ies p r o d u cts selec tio n gu id e o f a p p en d i x i n d etails . p a ra m et er p o rt nu m [ in] sp ec if y th e gp i o p o r t. i t c o u ld b e 0 ~ 4 to co r r esp o n d to th e gp i o - a/b /c /d/e. p innu m [ in] sp ec if y p i n o f t h e gp i o p o r t. i t c o u ld b e 0 ~1 5 . i nclu de dr iv er /dr v gp i o .h e x a m p le / * c o n f i g u r e gp a - 1 to o u tp u t m o d e * / dr v gp i o_ op en ( e_ gp a , 1 , e_ i o_ ou t p u t ) ; / * set g p a - 1 to h i g h * / _ dr vgp i o_ dout ( e _ gp a , 1 ) = 1 ; / * . . . . . . * / / * c o n f i g u r e gp b - 3 to in p u t m o d e * / u in t8 _ t u 8 p in val u e ; dr v gp i o_ op en ( e_ gp b , 3 , e_ i o_ in p ut ) ; / * get gp b - 3 p in v al u e * / u 8 p in val u e = _ dr vgp i o_ dout ( e _ gp b , 3 ) ; gp a_[n] / g p b_[n ] / gp c_[n] / g p d_[n ] / gp e _ [n ] p ro t o t y pe gp a _ 0 ~gp a _ 1 5 / g p b _ 0 ~g p b _ 1 5 / g p c _ 0 ~gp c _ 1 5 / g p d_ 0 ~g p d_ 1 5 / gp e _ 0 ~g p e _ 1 5 descript io n t h ese m ac r o s ar e th e s a m e as _ dr vgp i o_ dout m ac r o b u t w it h o u t a n y p ar a m eter s . user ca n u s e th e m ac r o d ef i n e d ir ec tly l ik e gp a _ 0 to o u tp u t d ata to th e s p ec if ied p in , o r g et p in v alu e f r o m t h i s s p ec if i ed p in . no t e on l y nuc1 x 0 x x x b x an d nu c 1 x 0 x x x c x s er ies s u p p o r t t h i s f u n c tio n , e x : nuc1 4 0 r d2 b n an d nuc1 4 0 ve 3 c n. p lease r ef er to nu mic r o tm nu c 1 0 0 ser ies p r o d u cts selec tio n gu id e o f a p p en d i x i n d etails . p a ra m et er no n e pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 104 - i nclu de dr iv er /dr v gp i o .h e x a m p le / * c o n f i g u r e gp a - 1 to o u t p u t m o d e * / dr v gp i o_ op en ( e_ gp a , 1 , e_ i o_ ou t p u t ) ; / * set g p a - 1 to h i g h * / gp a _ 1 = 1 ; / * . . . . . . * / / * c o n f i g u r e gp b - 3 to in p u t m o d e * / u in t8 _ t u 8 p in valu e ; dr v gp i o_ op en ( e_ gp b , 3 , e_ i o_ in p ut ) ; / * get gp b - 3 p in v al u e * / u 8 p in val u e = gp b _ 3 ; 5.5. functions drvg p io _o pen p ro t o t y pe in t3 2 _ t dr v gp i o_ op en ( e _ dr vgp i o_ p or t p o r t, in t3 2 _ t i3 2 b it, e _ dr vgp i o_ i o m o d e ) descript io n set th e s p ec i f ied gp i o p in to th e s p ec if ied gp i o o p er ati o n m o d e . p a ra m et er po rt [ in] e_ drv g p i o _ p o rt , s p ec i f y gp i o p o r t. i t c o u ld b e e_ g p a , e_ gp b , e_ gp c , e_ gp d an d e _ g p e . i3 2 b it [ in] sp ec if y p i n o f t h e gp i o p o r t. i t c o u ld b e 0 ~1 5 . m o de [ i n] e_ drv g p i o _ i o , s et t h e s p e cif ied gp i o p in to b e e_ i o_ i np ut , e_ i o _ out p u t , e_ i o_ op e ndra i n o r e _ i o _ quasi m o d e . i nclu de dr iv er /dr v gp i o. h ret urn va lue pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 105 - e _ suc c e ss : o p er atio n s u cc ess f u l e _ dr vgp i o_ a r gum e nt : i n co r r ec t ar g u m e n t e x a m p le / * c o n f i g u r e gp a - 0 to gp i o o u tp u t m o d e an d gp a - 1 to g p i o in p u t m o d e * / dr v gp i o_ op en ( e_ gp a , 0, e_ i o_ ou t p u t ) ; drvgpio_open ( e_ gpa, 1 , e_ io_ in put); drvg p io _ clos e p ro t o t y pe in t3 2 _ t dr v gp i o_ c lo s e ( e_ dr vgp i o_ p or t p o r t, in t3 2 _ t i3 2 b it) descript io n c lo s e th e s p ec if ied gp i o p in f u n ctio n an d s et t h e p in to q u a s i - b id ir ec tio n a l m o d e . p a ra m et er po rt [ in] e_ drv g p i o _ p o rt , s p ec i f y gp i o p o r t. i t c o u ld b e e_ g p a , e_ gp b , e_ gp c , e_ gp d an d e _ g p e . i3 2 b it [ in] sp ec if y p i n o f t h e gp i o p o r t. i t c o u ld b e 0 ~1 5 . i nclu de dr iv er /dr v gp i o. h ret urn va lue e _ suc c e ss : o p er atio n s u cc ess f u l e _ dr vgp i o_ a r gum e nt : i n co r r ec t ar g u m e n t e x a m p le / * c lo s e gp a - 0 f u n c tio n a n d s et to d ef au lt q u asi - b id ir ec tio n al m o d e * / dr v gp i o_ c lo s e ( e _ gp a , 0 ); drvg p io _ s e tb it p ro t o t y pe in t3 2 _ t dr v gp i o_ setb it ( e_ dr vgp i o_ p or t p o r t, in t3 2 _ t i3 2 b it) descript io n set th e s p ec i f ied gp i o p in to 1. p a ra m et er po rt [ in] pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 106 - e_ drv g p i o _ p o rt , s p ec i f y gp i o p o r t. i t c o u ld b e e_ g p a , e_ gp b , e_ gp c , e_ gp d an d e _ g p e . i3 2 b it [i n] sp ec if y p i n o f t h e gp i o p o r t. i t c o u ld b e 0 ~1 5 . i nclu de dr iv er /dr v gp i o. h ret urn va lue e _ suc c e ss : o p er atio n s u cc ess f u l e _ dr vgp i o_ a r gum e nt : i n co r r ec t ar g u m e n t e x a m p le / * c o n f i g u r e gp a - 0 as gp i o o u tp u t m o d e * / dr v gp i o_ op en ( e_ gp a , 0, e_ i o_ ou t p u t ) ; / * set g p a - 0 to 1 ( h i g h ) * / drvgpio_setbit ( e_ gpa, 0); drvg p io _ ge t bit p ro t o t y pe in t3 2 _ t dr v gp i o_ get b it ( e_ dr vgp i o_ p or t p o r t, in t3 2 _ t i3 2 b it) descript io n get th e p in v al u e f r o m t h e s p e cif ied in p u t g p i o p in . p a ra m et er po rt [ in] e_ drv g p i o _ p o rt , s p ec i f y gp i o p o r t. i t c o u ld b e e_ g p a , e_ gp b , e_ gp c , e_ gp d an d e _ g p e . i3 2 b it [ in] sp ec if y p i n o f t h e gp i o p o r t. i t c o u ld b e 0 ~1 5 . i nclu de dr iv er /dr v gp i o. h ret urn va lue t h e s p ec if ied in p u t p i n v al u e : 0 / 1 e _ dr vgp i o_ a r gum e nt : n co r r ec t ar g u m en t e x a m p le in t3 2 _ t i3 2 b itvalu e; / * c o n f i g u r e gp a - 1 as gp i o in p u t m o d e * / dr v gp i o_ op en ( e_ gp a , 1 , e_ i o_ in p ut ) ; i3 2 b itvalu e = dr v gp i o_ get b it ( e_ gp a , 1 ); pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 107 - if ( u 3 2 b itvalu e == 1 ) { p r in tf ( gp a - 1 p in s ta tu s is h i g h . \ n ); } else { p r in tf ( gp a - 1 p in s ta tu s is lo w . \ n ); } drvg p io _ clr bit p ro t o t y pe in t3 2 _ t dr v gp i o_ c lr b it ( e_ dr vgp i o_ p or t p o r t, in t3 2 _ t i3 2 b it) descript io n set th e s p ec i f ied gp i o p in to 0 . p a ra m et er po rt [ in] e_ drv g p i o _ p o rt , s p ec i f y gp i o p o r t. i t c o u ld b e e_ g p a , e_ gp b , e_ gp c , e_ gp d an d e _ g p e . i3 2 b it [ in] sp ec if y p i n o f t h e gp i o p o r t. i t c o u ld b e 0 ~1 5 . i nclu de dr iv er /dr v gp i o. h ret urn va lue e _ suc c e ss : o p er atio n s u cc ess f u l e _ dr vgp i o_ a r gum e nt : i n co r r ec t ar g u m e n t s e x a m p le / * c o n f i g u r e gp a - 0 as gp i o o u tp u t m o d e */ dr v gp i o_ op en ( e_ gp a , 0, e_ i o_ ou t p u t ) ; / * set gp a - 0 to 0 ( lo w ) * / dr v gp i o_ c lr b it ( e_ gp a , 0 ) ; drvg p io _ s e tport bits p ro t o t y pe in t3 2 _ tdr v gp i o_ setp o r tb its ( e_ dr vgp i o_ p or t p o r t, in t3 2 _ t i3 2 data ) descript io n set th e o u tp u t p o r t v alu e to t h e s p ec if ied gp i o p o r t . p a ra m et er pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 108 - po rt [ in] e_ drv g p i o _ p o rt , s p ec i f y gp i o p o r t. i t c o u ld b e e_ g p a , e_ gp b , e _ gp c , e_ gp d an d e _ g p e . i3 2 da t a [ in] t h e d ata o u tp u t v alu e . i t c o u ld b e 0 ~ 0 x ff ff . i nclu de d r iv er /dr v gp i o. h ret urn va lue e _ suc c e ss : o p er atio n s u cc ess f u l e _ dr vgp i o_ a r gum e nt : i n co r r ec t ar g u m e n t e x a m p le / * set t h e o u tp u t v al u e o f gp a p o r t to 0 x 1 2 3 4 * / dr v gp i o_ s etp o r tb its ( e_ g pa , 0 x 1 2 3 4 ) ; drvg p io _ g e tport bit s p ro t o t y pe in t3 2 _ t d r v gp i o_ getp o r tb its ( e_ dr vgp i o_ p or t p o r t) descript io n get th e i n p u t p o r t v al u e f r o m t h e s p ec if ied gp i o p o r t . p a ra m et er po rt [ in] e_ drv g p i o _ p o rt , s p ec i f y gp i o p o r t. i t c o u ld b e e_ g p a , e_ gp b , e_ gp c , e_ gp d an d e _ g p e . i nclu de dr iv er /dr v gp i o. h ret urn va lue t h e s p ec if ied in p u t p o r t v al u e: 0 ~ 0 x ff ff e _ dr vgp i o_ a r gum e nt : i n co r r ec t ar g u m e n t e x a m p le / * get t h e gp a p o r t in p u t d ata v alu e * / in t3 2 _ t i3 2 po r tvalu e; i3 2 p o r tvalu e = dr v gp i o_ g etp o r tb its ( e_ gp a ) ; drvg p io _ ge td out bit p ro t o t y pe pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 109 - in t3 2 _ t dr v gp i o_ getdo u tb it ( e_ dr vgp i o_ p or t p o r t, i n t3 2 _ t i3 2 b it ) descript io n get th e b it v al u e f r o m t h e s p e cif ied d ata o u tp u t val u e r e g i s ter . i f th e b it v a lu e i s 1 , it ? s m ea n in g t h e p in is o u tp u t d ata to h ig h . oth er w i s e, it ? s o u tp u t d ata to lo w . p a ra m et er po rt [ in] e_ drv g p i o _ p o rt , s p ec i f y gp i o p o r t. i t c o u ld b e e_ g p a , e_ gp b , e_ gp c , e_ gp d an d e _ g p e . i3 2 b it [ in] sp ec if y p i n o f t h e gp i o p o r t. i t c o u ld b e 0 ~1 5 . i nclu de dr iv er /dr v gp i o. h ret urn va lue t h e b it v alu e o f t h e s p ec if ied r eg is ter : 0 / 1 e _ dr vgp i o_ a r gum e nt : i n co r r ec t ar g u m e n t e x a m p le / * get t h e gp a - 1 d ata o u tp u t v alu e * / in t3 2 _ t i3 2 b itvalu e; i3 2 b itvalu e = dr v gp i o_ get do u tb it ( e_ gp a , 1 ); drvg p io _ g e tport do ut bit s p ro t o t y pe in t3 2 _ t dr v gp i o_ getp o r t do u t b its ( e_ dr vgp i o_ p or t p o r t) d escript io n get th e p o r t v alu e f r o m t h e s p ec if ied d ata o u tp u t val u e r e g is ter . i f t h e co r r esp o n d in g b it o f th e r etu r n p o r t v alu e is 1 , it m ea n s t h e co r r esp o n d in g b it i s o u tp u t d ata to h i g h . oth er w i s e, it ? s o u tp u t d ata to lo w . p a ra m et er po rt [ in] e_ drv g p i o _ p o rt , s p ec i f y gp i o p o r t. i t c o u ld b e e_ g p a , e_ gp b , e_ gp c , e_ gp d an d e _ g p e . i nclu de dr iv er /dr v gp i o. h ret urn va lue t h e p o r tt v alu e o f t h e s p ec i f ie d r eg is ter : 0 ~ 0 x ff f f pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 110 - e _ dr vgp i o_ a r gum e nt : i n co r r ec t ar g u m e n t e x a m p le / * get t h e gp a p o r t d ata o u tp u t v al u e * / in t3 2 _ t i3 2 po r tvalu e; i3 2 p o r tvalu e = dr v gp i o_ getp o r t do u tb it s ( e_ gp a ) ; drvg p io _ s e tb itm a s k p ro t o t y pe in t3 2 _ t d r v gp i o_ setb itmask ( e_ dr vgp i o_ p or t p o r t, i n t 32 _ t i3 2 b it) descript io n t h is f u n ctio n is u s ed to p r o tec t th e w r ite d ata f u n c tio n o f t h e co r r esp o n d in g gp i o p in . w h en s et th e b it m as k , th e w r ite s ig n al is m a s k ed an d w r ite d ata to th e p r o tect b it is ig n o r ed . p a ra m et er po rt [ in] e_ drv g p i o _ p o rt , s p ec i f y gp i o p o r t. i t c o u ld b e e_ g p a , e_ gp b , e_ gp c , e_ gp d an d e _ g p e . i3 2 b it [ in] sp ec if y p i n o f t h e gp i o p o r t. i t c o u l d b e 0 ~1 5 . include driver/drvgpio.h ret urn va lue e _ suc c e ss : o p er atio n s u cc ess f u l e x a m p le / * p r o tect gp a - 0 w r ite d ata f u n ctio n * / dr v gp i o_ setb itmask ( e_ gp a , 0) ; drvg p io _ ge tb itm a s k p ro t o t y pe in t3 2 _ t d r v gp i o_ getb it ma s k ( e_ dr vgp i o_ p or t p o r t, in t 32 _ t i3 2 b it) de s cr iptio n get th e b it v al u e f r o m t h e s p e cif ied d ata o u tp u t w r ite ma s k r e g is ter . i f t h e b it v a lu e i s 1 , it m ea n s t h e co r r esp o n d in g b it is p r o tecte d . a n d w r ite d ata to th e b it is i g n o r ed . p a ra m et er po rt [ in] pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 111 - e_ drv g p i o _ p o rt , s p ec i f y gp i o p o r t. i t c o u ld b e e_ g p a , e_ gp b , e_ gp c , e_ gp d an d e _ g p e . i3 2 b it [ in] sp ec if y p i n o f t h e gp i o p o r t. i t c o u ld b e 0 ~1 5 . i nclu de dr iv er /dr v gp i o. h ret urn va lue t h e b it v alu e o f t h e s p ec if ied r eg is ter : 0 / 1 e x a m p le / * get t h e b it v al u e f r o m gp a data ou tp u t w r ite ma s k r e s i s ter * / in t 3 2 _ t i3 2 ma s k val u e; i3 2 ma s k val u e = dr v gp i o_ g et b it t ma s k ( e_ gp a , 0 ) ; /* if (i32maskvalue = 1), its meaning gpa - 0 is write protected */ drvg p io _ clrbitm a s k p ro t o t y pe in t3 2 _ t d r v gp i o_ c lr b itmask ( e_ dr vgp i o_ p or t p o r t, i n t 32 _ t i3 2 b it) descript io n t h is f u n ctio n is u s ed to r e m o v e th e w r ite p r o tect f u n ctio n o f th e th e co r r esp o n d in g gp i op in . af ter r e m o v e th e b it m as k , w r ite d ata to th e co r r esp o n d in g b it is w o r k ab le. p a ra m et er po rt [ in] e_ drv g p i o _ p o rt , s p ec i f y gp i o p o r t. i t c o u ld b e e_ g p a , e_ gp b , e_ gp c , e_ gp d an d e _ g p e . i3 2 b it [ in] sp ec if y p i n o f t h e gp i o p o r t. i t c o u ld b e 0 ~1 5 . i nclu de dr iv er /dr v gp i o. h ret urn va lue e _ suc c e ss : o p er atio n s u cc ess f u l e x a m p le / * r e m o v e t h e gp a - 0 w r ite p r o tect f u n ctio n * / dr v gp i o_ c lr b itmask ( e_ gp a , 0) ; pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 112 - drvg p io _ s e tport m a s k p ro t o t y pe in t3 2 _ t d r v gp i o_ setp o r tma s k ( e_ dr vgp i o_ p or t p o r t, in t3 2 _ t i3 2 ma s k data ) descript io n t h is f u n ctio n is u s ed to p r o tec t th e w r ite d ata f u n c tio n o f t h e co r r esp o n d in g gp i o p in s . w h e n s et t h e b its ar e m a s k ed , w r ite d ata to th e p r o tect b its ar e ig n o r ed . p a ra m et er po rt [ in] e _ drv g p i o _ p o rt , s p ec i f y gp i o p o r t. i t c o u ld b e e_ g p a , e_ gp b , e_ gp c , e_ gp d an d e _ g p e . i3 2 m a s k da t a [ in] sp ec if y p i n s o f th e gp i o p o r t . i t c o u ld b e 0 ~ 0 x ff f f . i nclu de dr iv er /dr v gp i o. h ret urn va lue e _ suc c e ss : o p er atio n s u cc ess f u l e _ dr vgp i o_ a r gum e nt : i n co r r ec t ar g u m e n t e x a m p le /* protect gpa - 0/4 write data function */ dr v gp i o_ setp o r tma s k ( e_ gp a , 0 x 1 1 ) ; drvg p io _ ge tport m a s k p ro t o t y pe in t3 2 _ t d r v gp i o_ get p o r tma s k ( e_ dr vgp i o_ p or t p o r t) descript io n get th e p o r t v alu e f r o m t h e s p ec if ied d ata o u tp u t w r ite ma s k r eg i s ter . i f t h e co r r esp o n d in g b it o f th e r etu r n p o r t v alu e i s 1 , it ? s m ea n in g t h e b its ar e p r o tecte d . a n d w r ite d ata to th e b i ts ar e ig n o r ed . p a ra m et er po rt [ in] e_ drv g p i o _ p o rt , s p ec i f y gp i o p o r t. i t c o u ld b e e_ g p a , e_ gp b , e_ gp c , e_ gp d an d e _ g p e . i nclu de dr iv er /dr v g p i o. h pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 113 - ret urn va lue t h e p o r tt v alu e o f t h e s p ec i f ie d r eg is ter : 0 ~ 0 x ff f f e x a m p le / * get t h e p o r t v alu e f r o m gp a data o u tp u t w r ite ma s k r e s is ter * / in t3 2 _ t i3 2 ma s k val u e; i3 2 ma s k val u e = dr v gp i o_ g etp o r t ma s k ( e_ gp a ); /* if (i32maskvalue = 0x11), its meaning gp a - 0/4 are protected */ drvg p io _ clrp ortm a s k p ro t o t y pe in t3 2 _ t d r v gp i o_ c lr p o r t ma s k ( e_ dr vgp i o_ p or t p o r t, in t3 2 _ t i3 2 ma s k data ) descript io n t h is f u n ctio n is u s ed to r e m o v e th e w r ite p r o tect f u n ctio n o f th e co r r esp o n d in g gp i o p in s . af ter r e m o v e th o s e b it s m a s k , w r ite d ata to th e co r r esp o n d in g b its ar e w o r k ab le. p a ra m et er po rt [ in] e_ drv g p i o _ p o rt , s p ec i f y gp i o p o r t. i t c o u ld b e e_ g p a , e_ gp b , e_ gp c , e_ gp d an d e _ g p e . i3 2 m a s k da t a [ in] sp ec if y p i n s o f th e gp i o p o r t . i t c o u ld b e 0 ~ 0 x ff f f . i nclu de dr iv er /dr v gp i o. h ret urn va lue e _ suc c e ss : o p er atio n s u cc ess f u l e x a m p le / * r e m o v e t h e gp a - 0 /4 w r ite p r o tect f u n ct io n * / dr v gp i o_ c lr p o r tma s k ( e_ gp a , 0 x 1 1 ) ; drvg p io _ e nabl e digital input bit p ro t o t y pe in t3 2 _ t dr v gp i o_ e n ab le dig i tali n p u tb it ( e_ dr vgp i o_ p or t p o r t, e _ dr vgp i o_ p i n i3 2 b it ) descript io n e n ab le i o d ig ital i n p u t p ath o f th e s p ec if ied gp i o in p u t p in . pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 114 - p a ra m et er po rt [ in] e_ drv g p i o _ p o rt , s p ec i f y gp i o p o r t. i t c o u ld b e e _ g p a , e _ gp b , e _ gp c , e _ g p d an d e _ gp e . pin [ in] sp ec if y p i n o f t h e gp i o p o r t. i t c o u ld b e b e 0 ~ 15 . i nclu de dr iv er /dr v gp i o. h ret urn va lue e _ suc c e ss : o p er atio n s u cc ess f u l e x a m p le: / * e n ab le gp a . 0 i o d ig ital in p u t p ath */ dr v gp i o_ e n ab le dig ita li n p u t b it ( e _ gp a , 0 ) ; drvg p io _ dis a bl e digi tali nput bit p ro t o t y pe in t3 2 _ t dr v gp i o_ dis ab ledig itali n p u tb it ( e _ dr vgp i o_ p or t p o r t, e _ dr vgp i o_ p i n i3 2 b it ) descript io n dis ab le i o d ig ital i n p u t p at h o f th e s p ec if ied gp i o in p u t p in . p a ra m et er po rt [ in] e_ drv g p i o _ p o rt , s p ec i f y gp i o p o r t. i t c o u ld b e e _ g p a , e _ gp b , e _ gp c , e _ g p d an d e _ gp e . pin [ in] sp ec i f y p i n o f t h e gp i o p o r t. i t c o u ld b e b e 0 ~1 5 . i nclu de dr iv er /dr v gp i o. h ret urn va lue e _ suc c e ss : o p er atio n s u cc ess f u l e x a m p le: / * dis ab le gp a . 0 i o d ig ital i n p u t p ath */ dr v gp i o_ dis ab le dig i tali n p u tb it ( e _ gp a , 0 ) ; pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 115 - drvg p io _ e nabl e deb ounce p ro t o t y pe in t3 2 _ t dr v gp i o_ e n ab le deb o u n ce ( e_ dr vgp i o_ p or t p o r t , in t3 2 _ t i 32 b it) descript io n e n ab le th e d e - b o u n ce f u n ctio n o f th e s p ec i f ied gp i o in p u t p in . p a ra m et er po rt [ in] e_ drv g p i o _ p o rt , s p ec i f y gp i o p o r t. i t c o u ld b e e_ g p a , e_ gp b , e_ gp c , e_ gp d an d e _ g p e . i 32 b it [ in] s p ec if y p i n o f t h e gp i o p o r t. i t c o u ld b e 0 ~1 5 . i nclu de dr iv er /dr v gp i o. h ret urn va lue e _ suc c e ss : o p er atio n s u cc ess f u l e x a m p le / * e n ab le gp a - 0 i n ter r u p t d e - b o u n ce f u n ctio n * / dr v gp i o_ e n ab lede b o u n ce ( e_ gp a , 0 ) ; drvg p io _ dis a bl e deb ounce p ro t o t y pe in t3 2 _ t dr v gp i o_ dis ab lede b o u n ce ( e_ dr vgp i o_ p or t p o r t, in t3 2 _ t i 32 b it ) descript io n dis ab le th e d e - b o u n ce f u n ctio n o f t h e s p ec if ied gp i o in p u t p in . p a ra m et er po rt [ in] e_ drv g p i o _ p o rt , s p ec i f y gp i o p o r t. i t c o u ld b e e_ g p a , e_ gp b , e_ gp c , e_ gp d an d e _ g p e . i 32 b it [ in] sp ec if y p i n o f t h e gp i o p o r t. i t c o u ld b e 0 ~1 5 . i nclu de dr iv er /dr v gp i o. h ret urn va lue pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 116 - e _ suc c e ss : o p er atio n s u cc ess f u l e x a m p le / * dis ab le gp a - 0 in ter r u p t d e - b o u n ce f u n ct io n * / dr v gp i o_ dis ab le deb o u n ce ( e_ gp a , 0 ) ; drvg p io _ s e td e boun c e time p ro t o t y pe in t3 2 _ t dr v gp i o_ s etde b o u n ce t im e ( u in t3 2 _ t u 3 2 c y clese lectio n , e_ dr vgp i o_ db c l ks r c c lo ck so u r ce ) descript io n set th e i n ter r u p t d e - b o u n ce s a m p lin g ti m e b ased o n t h e d e - b o u n ce co u n ter clo ck s o u r ce . i f th e d e - b o u n ce clo ck s o u r ce is f r o m i n ter n al 1 0 khz an d s a m p lin g c y cle s el ec t io n is 4 . t h e tar g et d e - b o u n ce ti m e is ( 2 ^4 ) * ( 1 /( 1 0 * 1 0 0 0 ) ) s = 1 6 * 0 . 0 0 0 1 s = 1 6 0 0 u s , an d s y s te m w ill s a m p li n g in ter r u p t in p u t o n ce p er 1 6 0 0 u s . p a ra m et er u3 2 cy clesele ct io n [ in] t h e n u m b er o f s a m p li n g c y cle s elec tio n , t h e r an g e o f v al u e i s f r o m 0 ~ 1 5 . t h e tar g et de - b o u n ce ti m e is ( 2 ^( u 3 2 c y c leselec tio n ) ) * ( c lo ck so u r ce ) s ec o n d . clo ckso urce [ in] e_ d rv g p i o _ db cl k sr c , it c o u ld b e db c l ks r c _ h c l k o r db c l ks r c _ 1 0 k . i nclu de dr iv er /dr v gp i o. h ret urn va lue e _ suc c e ss : o p er atio n s u cc ess f u l e _ dr vgp i o_ a r gum e nt : i n co r r ec t a r g u m e n t e x a m p le / * set de - b o u n ce s a m p li n g t i m e to 1 6 0 0 u s . ( 2^ 4) *( 1 0 khz ) * / dr v gp i o_ setdeb o u n ce t i m e ( 4 , e_ d b c l ks r c _ 1 0 k ); drvg p io _ ge td e boun c e s a mple cy c le p ro t o t y pe in t3 2 _ t dr v gp i o_ getde b o u n ce sa m p le c y cle ( v o id ) descript io n pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 117 - t h is f u n ctio n is u s ed to g et t h e nu m b er o f d e - b o u n ce s a m p l i n g c y cle s elec tio n . p a ra m et er no n e i nclu de dr iv er /dr v gp i o. h ret urn va lue nu m b er o f t h e s a m p li n g c y cle s elec tio n : 0 ~ 1 5 e x a m p le in t3 2 _ t i 3 2 c y clesele ct io n ; i 3 2 c y clesele c tio n = dr v gp i o_ getde b o u n ce sa m p le c y cle (); / * i f i 3 2 c y clesele c t io n is 4 an d clo ck s o u r ce f r o m 1 0 khz . */ / * i t ? s m ea n i n g to s a m p le i n ter r u p t in p u t o n ce p er 1 6 * 1 0 0 u s . */ drvg p io _ e nabl e int p ro t o t y pe in t3 2 _ t dr v gp i o_ e n ab lei n t ( e_ dr vgp i o_ p or t p o r t, in t3 2 _ t i 32 b it , e_ dr vgp i o_ i nt _ t yp e t r i g g er t y p e, e_ dr vgp i o_ i nt _ mo de mo d e ) descript io n e n ab le th e i n ter r u p t f u n ctio n o f th e s p ec if ied gp i o p in . e x c p et f o r gp b . 1 4 an d g p b . 1 5 p i n s . p a ra m et er po rt [ in] e_ drv g p i o _ p o rt , s p ec i f y gp i o p o r t. i t c o u ld b e e_ g p a , e_ gp b , e_ gp c , e_ gp d an d e _ g p e . i 32 b it [ in] sp ec if y p i n o f t h e gp i o p o r t. i t co u ld b e 0 ~1 5 . b u t th e gp b . 1 4 /1 5 is o n ly u s ed f o r ex ter n al i n ter r u p t 0 /1 . t rig g er t y pe [ in] e_ d rv g p i o _ i n t _ t yp e , s p ec if y t h e i n ter r u p t tr ig g er t y p e. i t c o u ld b e e_ i o_ r i sin g, e_ i o_ fa l l i ng o r e_ i o_ b o t h_ e dge a n d i t ? s m ea n i n g t h e in ter r u p t f u n ctio n en ab le b y r i s in g ed g e / h i g h le v el, f alli n g e d g e/lo w le v el o r b o th r i s i n g ed g e an d f all in g ed g e . i f t h e i n ter r u p t m o d e is e _ mo de _ l e ve l an d i n ter r u p t t y p e i s e _ b o t h_ e dge th en ca lli n g th i s a p i is ig n o r ed . m o de [ in] pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 118 - e_ dr v g p i o _ i n t _ m o de , s p ec if y th e i n ter r u p t m o d e . i t co u ld b e e_ mo de _ e dge o r e_ mo de _ l e ve l to co n tr o l th e in ter r u p t i s b y ed g e tr i g g er o r b y lev e l tr ig g er . i f th e in ter r u p t m o d e is e _ m od e _ l e ve l a n d in ter r u p t t y p e i s e _ b ot h _ e dge th en ca llin g th is a p i is ig n o r ed . i nclu de dr iv er /dr v gp i o. h ret urn va lue e _ suc c e ss : o p er atio n s u cc ess f u l e _ dr vgp i o_ a r gum e nt : i n co r r ec t ar g u m e n t e x a m p le /* enable gpb - 13 interrupt function and its rising and edge t rigger. */ drvgpio_enableint ( e_ gpb, 13, e_ io_rising, e_ mode_edge); drvg p io _ dis a bl e int p ro t o t y pe in t3 2 _ t dr v gp i o_ dis a b lei n t ( e_ dr vgp i o_ p or t p o r t, in t3 2 _ t i 32b it) descript io n dis ab le th e i n ter r u p t f u n ctio n o f th e s p ec i f ied gp i o p in . e x cp et f o r gp b . 1 4 an d g p b . 1 5 p in s . p a ra m et er po rt [ in] e_ drv g p i o _ p o rt , s p ec i f y gp i o p o r t. i t c o u ld b e e_ g p a , e_ gp b , e_ gp c , e_ gp d an d e _ g p e . i 32 b it [ in] sp ec if y p i n o f t h e gp i o p o r t. i t c o u ld b e 0 ~1 5 . b u t th e gp b . 1 4 /1 5 is o n ly u s ed f o r ex ter n al i n ter r u p t 0 /1 . i nclu de dr iv er /dr v gp i o. h ret urn va lue e _ suc c e ss : o p er atio n s u cc ess f u l e x a m p le / * dis ab le gp b - 1 3 in ter r u p t f u n ct io n . * / dr v gp i o_ dis a b lei n t ( e_ gp b , 1 3 ) ; pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 119 - drvg p io _ s e tint cal lb a c k p ro t o t y pe v o id dr v gp i o_ seti n tc a llb ac k ( gp i o_ gp a b _ c al l b ac k p f gp a b c allb ac k , gp i o_ gp c de _ c al l b ac k p f g p c de c al lb ac k ) descript io n i n s tall t h e i n ter r u p t ca llb ac k f u n ct io n f o r gp a / gp b p o r t a n d gp c /gp d/gp e p o r t, e x ce p t gp b . 1 4 an d gpb . 1 5 p in s . p a ra m et er pfg p ab ca llb a c k [ in] , t h e f u n ctio n p o in ter o f gp a / g p b ca llb ac k f u n ct io n . pfg p cd e ca llb a c k [ in] , t h e f u n ctio n p o in ter o f gp c/ gp d/gp e ca llb ac k f u n ctio n . i nclu de dr iv er /dr v gp i o. h ret urn va lue no n e e x a m p le / * set g p a /b an d gp c /d/e i n ter r u p t c allb ac k f u n ctio n s * / dr v gp i o_ seti n tc a llb ac k ( gp a b c a llb ac k , gp c de c a llb ac k ) ; drvg p io _ e nabl e e in t0 p ro t o t y pe v o id dr v gp i o_ e n ab lee i nt 0 ( e_ dr vgp i o_ i nt _ t yp e t r i g g er t y p e, e_ dr vgp i o_ i nt _ mo de mo d e, gp i o_ e i n t 0 _ c al l b a c k p f e i nt 0 c allb ac k ) descript io n e n ab le th e i n ter r u p t f u n ctio n f o r ex ter n al gp i o in ter r u p t f r o m /i nt 0 ( g pb . 14) p in . p a ra m et er t rig g er t y pe [ in] e_ dr v g p i o _ i n t _ t yp e , s p ec if y th e i n ter r u p t tr ig g er t y p e. i t co u ld b e e_ i o_ r i sin g, e_ i o_ fall i ng o r e_ i o_ b ot h_ e dge an d i t ? s m ea n i n g th e in ter r u p t f u n c tio n e n ab le b y r i s in g ed g e / h i g h le v el, f alli n g ed g e/lo w lev el o r b o th r i s i n g ed g e an d f alli n g ed g e . i f pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 120 - th e in ter r u p t m o d e is e _ mo d e _ l e ve l a n d in ter r u p t t y p e i s e _ b ot h _ e dge th en ca llin g th is a p i is ig n o r ed . m o de [ in] e_ dr v g p i o _ i n t _ m o de , s p ec if y th e i n ter r u p t m o d e . i t co u ld b e e_ mo de _ e dge o r e_ mo de _ l e ve l to co n tr o l th e in ter r u p t i s b y ed g e tr i g g er o r b y lev e l tr ig g er . i f th e in ter r u p t m o d e is e _ mo de _ l e ve l an d i n ter r u p t t y p e i s e _ b ot h_ e dge th e n ca lli n g th is a p i is i g n o r ed pf e i n t 0 ca llb a c k [ in] it ? s t h e f u n ctio n p o in ter o f t h e ex ter n al i nt 0 ca llb ac k f u n cti o n . i nclu de dr iv er /dr v gp i o. h ret urn va lue no n e e x a m p le / * e n ab le e x ter n al i nt 0 in ter r u p t a s f al lin g a n d b o th - ed g e tr ig g er . * / dr v gp i o_ e n ab lee i nt 0 ( e_ i o_ b ot h _ e dge , e_ mo de _ e dge , e i nt 1 c allb ac k ) ; drvg p io _ dis a bl e e in t0 p ro t o t y pe v o id dr v gp i o_ dis ab lee i nt 0 ( v o id ) descript io n dis ab le th e i n ter r u p t f u n ctio n f o r ex ter n al gp i o in ter r u p t f r o m /i nt 0 ( g pb . 14 ) p in . p a ra m et er no n e i nclu de dr iv er /dr v gp i o. h ret urn va lue no n e e x a m p le / * dis ab le e x ter n al i nt 0 in ter r u p t f u n ctio n . * / dr v gp i o_ dis ab lee i nt 0 () ; drvg p io _ e nabl e e in t1 p ro t o t y pe v o id dr v gp i o_ e n ab lee i nt 1 ( pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 121 - e_ dr vgp i o_ i nt _ t yp e t r i g g er t y p e, e_ dr vgp i o_ i nt _ mo de mo d e, gp i o_ e i n t 0 _ c al l b a c k p f e i nt 0 c allb ac k ) descript io n e n ab le th e i n ter r u p t f u n ctio n f o r ex ter n al gp i o in ter r u p t f r o m /i nt 1 ( g pb . 1 5 ) p in . p a ra m et er t rig g er t y pe [ in] e_ drv g p i o _ i n t _ t yp e , s p ec if y th e i n ter r u p t tr ig g er t y p e. i t co u ld b e e_ i o_ r i sin g, e_ i o_ fall i n g o r e_ i o_ b ot h_ e dge an d i t ? s m ea n i n g th e in ter r u p t f u n c tio n e n ab le b y r i s in g ed g e / h i g h le v el, f alli n g ed g e/lo w lev el o r b o th r i s i n g ed g e an d f alli n g ed g e . i f th e in ter r u p t m o d e is e _ mo d e _ l e ve l a n d in ter r u p t t y p e i s e _ b ot h _ e dge th en ca llin g th is a p i is ig n o r ed . m o de [ in] e_ drv g p i o _ i n t _ m o de , s p ec if y th e i n ter r u p t m o d e . i t co u ld b e e_ mo de _ e dge o r e_ mo de _ l e ve l l to co n tr o l th e i n ter r u p t is b y ed g e tr ig g er o r b y lev el tr i g g er . i f th e in ter r u p t m o d e is e _ mo d e _ l e ve l a n d in ter r u p t t y p e i s e _ b ot h _ e dge th en ca llin g th is a p i is ig n o r ed pf e i n t 1 ca llb a c k [ in] it ? s t h e f u n ctio n p o in ter o f t h e ex ter n al i nt 1 ca llb ac k f u n cti o n . i nclu de dr iv er /dr v gp i o. h ret urn va lue no n e e x a m p le / * e n ab le e x ter n al i nt 1 in ter r u p t a s lo w lev el tr i g g er . * / dr v gp i o_ e n ab lee i nt 1 ( e_ i o_ fall i ng, e_ mo de _ l e ve l , e i nt 1 c allb ac k ) ; drvg p io _ dis a bl e e in t1 p ro t o t y pe v o id dr v gp i o_ dis ab lee i nt 1 ( v o id ) descript io n dis ab le th e i n ter r u p t f u n ctio n f o r ex ter n al gp i o in ter r u p t f r o m /i nt 1 ( g pb . 1 5 ) p in . p a ra m et er no n e i nclu de pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 122 - dr iv er /dr v gp i o. h r et urn va lue no n e e x a m p le / * dis ab le e x ter n al i nt 1 in ter r u p t f u n ctio n . * / dr v gp i o_ dis ab lee i nt 1 () ; drvg p io _ ge tint s tatu s p ro t o t y pe u in t3 2 _ t dr v gp i o_ geti n tst at u s ( e_ dr vgp i o_ p or t p o r t) descript io n get th e p o r t v alu e f r o m t h e s p ec if ied i n ter r u p t t r ig g er so u r ce i n d icato r r eg is ter . i f th e co r r esp o n d in g b it o f th e r et u r n p o r t v alu e is 1 , it ? s m ea n i n g t h e in ter r u p t o cc u r r ed at th e co r r esp o n d in g b it. oth er w i s e, n o in ter r u p t o cc u r r ed at th at b i t. p a ra m et er po rt [ in] e_ drv g p i o _ p o rt , s p ec i f y gp i o p o r t. i t c o u ld b e e_ g p a , e_ gp b , e_ gp c , e_ gp d an d e _ g p e . i nclu de dr iv er /dr v gp i o. h ret urn va lue t h e p o r tt v alu e o f t h e s p ec i f ie d r eg is ter : 0 ~ 0 x ff f f e x a m p le / * get gp a in ter r u p t stat u s . * / in t3 2 _ t i3 2 i n t statu s ; i3 2 i n t statu s = dr v gp i o_ geti n tst at u s ( e _ gp a ) ; drvg p io _ initfunctio n pr o t o t y pe in t3 2 _ t dr v gp i o_ i n itf u n ctio n ( e_ dr vgp i o_ func f u n ct io n ) descript io n i n itialize t h e s p ec i f ied f u n c tio n an d co n f i g u r e t h e r elativ e p i n s f o r s p ec if ied f u n ctio n u s ed . no t e no t a ll th e ch ip s s u p p o r t th ese f u n ctio n s . p lease r ef er to nu mic r o tm nuc1 0 0 ser ies p r o d u cts selec tio n gu id e o f ap p en d ix in d etail s . pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 123 - p a ra m et er f un ct io n [ in] dr vgp i o_ func , s p ec if ied t h e r elativ e gp i o p in s a s s p ec i al f u n ctio n p in s . i t c o u ld be : e_ func _ gp i o, e_ func _ c l ko , e_ func _ i 2 c 0 / e _ func _ i 2 c 1 , e_ func _ i 2 s, e_ func _ c an0 , e_ func _ a c mp 0 / e _ func _ a c mp 1 , e_ func _ sp i 0 / e _ func _ sp i 0 _ ss 1 / e _ func _ sp i 0 _ 2 b i t _ mo de , e_ func _ sp i 1 / e _ func _ sp i 1 _ ss 1 / e _ func _ sp i 1 _ 2 b i t _ mo de , e_ func _ sp i 2 / e _ func _ sp i 2 _ ss 1 / e _ func _ sp i 2 _ 2 b i t _ mo de , e_ func _ sp i 3 / e _ func _ sp i 3 _ ss 1 / e _ func _ sp i 3 _ 2 b i t _ mo de , e_ func _ sp i 0 _ qfn3 6 p i n / e _ func _ sp i 0 _ ss 1 _ qfn3 6 p i n / e_ func _ sp i 0 _ 2 b i t _ mo de _ qfn3 6 p i n, e_ func _ a d c 0 / e _ func _ a d c 1 / e _ func _ a d c 2 / e _ func _ a d c 3 / e_ func _ a d c 4 / e_ func _ a d c 5 / e _ func _ a d c 6 / f unc_ a d c 7 , e_ func _ e xt i n t 0 / e _ func _ e xt i n t 1 , e_ func _ t mr0 / e _ func _ t mr 1 / e _ func _ t mr 2 / e _ func _ t mr 3, e_ func _ t 0 ex / e _ func _ t 1 ex / e _ func _ t 2 ex / e _ func _ t 3 ex , e_ func _ u ar t 0 / e _ func _ uart 0 _ r x_ t x / e _ func _ uart 0 _ r t s_ c t s , e_ func _ u ar t 1 / e _ func _ uart 1 _ r x_ t x / e _ func _ uart 1 _ r t s_ c t s , e_ func _ u ar t 2 / e _ func _ uart 2 _ r x _ t x / e _ func _ uart 2 _ r t s_ c t s , e_ func _ p w m0 1 / e _ func _ p w m 2 3 / e _ func _ p w m 4 5 / e _ func _ p w m 67 , e_ func _ p w m0 / e _ func _ p w m 1 / e_ func _ p w m 2 / e _ func _ p w m 3 / e_ func _ p w m 4 / e _ func _ p w m 5 / e_ func _ p w m 6 / e _ func _ p w m 7, e_ func _ e b i _ 8 b / e _ func _ e b i _ 1 6 b , i nclu de dr iv er /dr v gp i o. h ret urn va lue e _ suc c e ss : o p er atio n s u cc ess f u l e _ dr vgp i o_ a r gum e nt : i n co r r ec t ar g u m e n t e x a m p le / * i n it u ar t 0 r x, t x, r t s an d c t s f u n ctio n * / dr v gp i o_ i n itf u n ctio n ( e_ func _ u ar t 0 ) ; drvg p io _ ge tv e rs ion p ro t o t y pe u in t3 2 _ t dr v g p i o _ getve r s io n ( v o id ) descript io n t h is f u n ctio n is u s ed to r etu r n th e v er s io n n u m b er o f gp i o d r iv er . i nclu de pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 124 - dr iv er /dr v gp i o. h ret urn va lue t h e v er s io n n u m b er o f gp i o d r iv er : 31:24 23:16 15:8 7:0 00000000 major_num minor_num build_num e x a m p le / * get t h e cu r r en t v er s io n o f g p i o dr iv er * / in t3 2 _ t i 3 2 gp i ove r ; i3 2 gp i ove r = dr v g pio _ getve r s io n ( ) ; pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 125 - 6. adc dr iver 6.1. adc introduction n u mic r o tm nu c 1 0 0 s er ies co n tai n o n e 12 - b it s u cc ess iv e ap p r o x i m atio n a n alo g - to - d ig ita l c o n v er ter s ( s ar a / d co n v er ter ) w it h 8 in p u t c h an n el s . i t tak es ab o u t 2 7 a d c clo ck c y c les to co n v er t o n e s a m p le, an d t h e m ax i m u m i n p u t c lo ck to adc is 16 mh z at 5 . 0 v . t h e a /d co n v er ter s u p p o r ts th r ee o p er atio n m o d es: s in g le, s in g le - c y c le s ca n an d co n ti n u o u s s ca n m o d e. t h e a /d co n v er t er s ca n b e s tar ted b y s o f t w a r e an d ex ter n al st a dc /p b . 8 p in . i n th i s d o cu m en t, w e w ill i n tr o d u ce h o w t o u s e th e a d c d r iv er . 6.2. a d c f eat ure the analog to digital converter includes following features: ? ? an alog input voltage range: 0~ vref (max to 5.0v). ? ? 12 bits resolution . ? ? up to 8 an alo g in p ut channels. ? ? ma x i m u m a d c clo ck f r eq u e n cy is 16 mhz . ? ? three operating modes ? ? single mode ? ? sin g le - c y c le scan mode ? ? continuous scan mode ? ? an a/d conversion can be started by ? ? software write 1 to adst bit ? ? e x ter n al pin stadc ? ? conversion result can be compared with specify value and provide interrupt functi on when conversion result matches the compare register setting s . ? ? t he apis include setting conditions and getting conversion data for adc application s. ? ? c h a n n el 7 s u p p o r ts 3 i n p u t s o u r ce s : e x ter n al an alo g v o lta g e, i n ter n al f ix ed b a n d g ap v o ltag e a n d internal temperature sensor output. ? ? support self - calibrat ion to minim ize conversion error . ? ? su p p o r t sin g le en d a n d d if f er e n tial i n p u t s ig n al. pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 126 - 6.3. type definition e_ adc_input_mode enumeration identifier v alue description adc_single_end 0 adc single end input adc_diffe rential 1 adc differential input e_ adc_operation_mode enumeration identifier v alue description adc_single_op 0 single operation mode adc_single_cycle_op 1 single cycle scan mode adc_continuous_op 2 continuous scan mode e_ adc_clk_src enumeration identi fier v alue description ext ernal _12mhz 0 external 12mhz clock int ernal _pll 1 internal pll clock internal_hclk 2 system clock int ernal _rc22mhz 3 internal 22 .1184 mhz clock e_ adc_ext_tri_cond enumeration identifier v alue description low_level 0 low level trigger high_level 1 high level trigger falling_edge 2 falling edge trigger rising_edge 3 rising edge trigger e_ adc_ch7_src enumeration identifier v alue description ext ernal _input_signal 0 external input signal int ernal _bandgap 1 internal bandgap vo ltage int ernal _temperature_sensor 2 internal temperature sensor e_ adc_c mp_condition enumeration identifier v alue description less_than 0 less than compare data greater_or_equal 1 greater or equal to compare data e_ adc_diff_mode_output_format enumerati on identifier v alue description unsigned_output 0 unsigned format twos_complement 1 2 ? s complement format pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 127 - 6.4. macr os _ dr v ad c_conv p ro t o t y pe v o id _ dr v a d c _ c onv ( v o id ) ; descript io n i n f o r m adc to s tar t an a /d c o n v er s io n . i nclu de dr iv er /dr v a dc .h ret urn va lue n o n e. e x a m p le / * star t a n a /d co n v er s io n * / _ dr v a d c _ c onv( ) ; _ dr v ad c_ ge t_ ad c_i nt_fla g p ro t o t y pe u in t3 2 _ t _ dr vadc_ ge t _ ad c _ i nt _ fl ag ( v o id ) ; descript io n get th e s ta tu s o f a d c in ter r u p t f lag . i nclu de dr iv er /dr v a dc .h ret urn va lue 0 : a d c in ter r u p t d o es n o t o cc u r . 1 : a d c in ter r u p t o cc u r s . e x a m p le / * get t h e s tat u s o f a dc i n ter r u p t f la g * / if ( _ dr v adc_ ge t _ a d c _ i nt _ fl a g () ) p r in tf ( a d c i n ter r u p t o cc u r s . \ n ); pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 128 - _ dr v ad c_ ge t_ cm p 0 _ int_ fla g p ro t o t y pe u in t3 2 _ t _ dr vadc_ ge t _ c mp 0 _ i n t _ fla g ( v o id ) ; descript io n get th e s ta tu s o f a d c co m p ar ato r 0 in ter r u p t f lag . i nclu de dr iv er /dr v a dc .h ret urn va lue 0 : a d c co m p ar ato r 0 in ter r u p t d o es n o t o cc u r . 1 : a d c co m p ar ato r 0 in ter r u p t o cc u r s . e x a m p le / * get t h e s tat u s o f a dc co m p ar ato r 0 in ter r u p t f la g * / if ( _ dr v adc_ ge t _c mp 0 _ i nt _ fl a g () ) p r in tf ( a d c co m p ar ato r 0 in ter r u p t o cc u r s . \ n ); _ dr v ad c_ ge t_ cm p 1 _ int_ fla g p ro t o t y pe u in t3 2 _ t _ dr vadc_ ge t _ c mp 1 _ i n t _ fla g ( v o id ) ; descript io n get th e s ta tu s o f a d c co m p ar ato r 1 in ter r u p t f lag . i nclu de dr iv er /dr v a dc .h ret urn va lue 0 : a d c co m p ar ato r 1 in ter r u p t d o es n o t o cc u r . 1 : a d c co m p ar ato r 1 in ter r u p t o cc u r s . e x a m p le / * get t h e s tat u s o f a dc co m p ar ato r 1 in ter r u p t f la g * / if ( _ dr v adc_ ge t _c mp 1 _ i nt _ fl a g () ) p r in tf ( a d c co m p ar ato r 1 in ter r u p t o cc u r s . \ n ); _ dr v ad c_clear_ad c_i nt_fla g p ro t o t y pe pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 129 - v o id _ dr v a d c _ c l e a r _ ad c _ i nt _ fl ag ( v o id ) ; descript io n c lear th e a d c i n ter r u p t f la g . i nclu de dr iv er /dr v a dc .h ret urn va lue n o n e. e x a m p le / * c lear t h e a d c in ter r u p t f la g * / _ dr v a d c _ c l e a r _ a d c _ i nt _ fl a g () ; _ dr v ad c_clear_cm p 0 _ int_ fla g p ro t o t y pe v o id _ dr v a d c _ c l e a r _ c mp 0 _ i n t _ fla g ( v o id ) ; descri ptio n c lear th e a d c co m p ar ato r 0 in ter r u p t f lag . i nclu de dr iv er /dr v a dc .h ret urn va lue n o n e. e x a m p le / * c lear t h e a d c co m p ar ato r 0 in ter r u p t f la g * / _ dr v a d c _ c l e a r _ c mp 0 _ i nt _ fl a g () ; _ dr v ad c_clear_cm p 1 _ int_ fla g p ro t o t y pe v o id _ dr v a d c _ c l e a r _ c mp 1 _ i n t _ fla g ( v o id ) ; descript io n c lear th e a d c co m p ar ato r 1 in ter r u p t f lag . i nclu de dr iv er /dr v a dc .h ret urn va lue pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 130 - n o n e. e x a m p le / * c lear t h e a d c co m p ar ato r 1 in ter r u p t f la g * / _ dr v a d c _ c l e a r _ c mp 1 _ i nt _ fl a g () ; 6.5. fu n ctio ns dr v adc_ ope n p ro t o t y pe v o id dr v a d c _ op en ( e_ a d c _ i np ut _ mo de i n p u tmo d e , e_ a d c _ op e r a t i on_ mo d e op mo d e , u in t8 _ t u8c h an n else lb it w is e , e_ a d c _ c l k_ sr c c lo ck src , u in t8 _ t u8 a d cdiv i s o r ) ; descript io n e n ab le th e a d c f u n ctio n a n d co n f i g u r e th e r elate d s etti n g s . p a ra m et er s i np utm o de [ in] sp ec if y th e t y p e o f th e a n alo g in p u t s ig n al. i t m ig h t b e s i n g le - en d o r d if f er en tial i n p u t. a d c _ sin g l e _ e nd : sin g le - en d i n p u t m o d e a d c _ di ff e r e nt i al : d if f er e n tial i n p u t m o d e o pm o de [ in] s p ec if y th e o p er atio n m o d e. i t m ig h t b e s i n g le, s i n g le c y cle s ca n o r co n tin u o u s s ca n m o d e. a d c _ sin g l e _ op : sin g le m o d e a d c _ sin g l e _ c y c l e _ op : s in g le c y cle s ca n m o d e a d c _ c o nt i nuou s_ op : co n tin u o u s s ca n m o d e u8 cha nn else lb it w is e [ in] s p ec if y th e i n p u t c h a n n el s . i f s o f t w ar e en ab le s m o r e th a n o n e c h an n el i n s i n g le m o d e, o n l y t h e ch a n n el w it h th e l o west n u m b er w il l b e co n v er ted an d th e o th er e n ab led ch an n el s w il l b e ig n o r ed . fo r ex a m p le, if u s er en ab le ch a n n el 2 , 3 an d 4 in s in g le m o d e, o n l y ch an n el 2 w ill b e co n v er ted . i n d if f er en t ial in p u t m o d e, o n l y th e ev e n n u m b er o f t h e t w o co r r esp o n d in g ch a n n e ls n ee d s to b e e n ab led . t h e co n v er s io n r esu lt w il l b e p lace d to th e co r r esp o n d in g d ata r eg is ter o f th e s elec t ed c h an n el. fo r ex a m p l e, in s in g le - en d i n p u t pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 131 - m o d e, 0 x 4 m ea n s th e c h an n el 2 is s elec ted ; in d i f f er e n tial i n p u t m o d e, it m ea n s c h an n el p air 1 is s elec ted . clo cksrc [ in] s p ec if y th e clo c k s o u r ce o f adc clo ck . e xt e r nal _ 1 2 mh z : e x ter n al 1 2 mh z cr y s tal i nt e r nal _ p l l : in ter n a l p l l o u tp u t i nt e r nal _ hc l k : s y s te m clo c k i nt e r nal _ r c 2 2 mh z : in ter n a l 2 2 . 1 1 8 4 mh z r c o s cillato r u8 adcdiv is o r [ in] dete r m i n e th e adc clo ck f r e q u en c y . t h e r an g e o f u 8 a d cd iv is o r is 0 ~ 0 x f f. a d c clo ck f r eq u e n c y = a d c clo ck s o u r ce f r eq u e n c y / ( u8 a d cdi v is o r + 1 ) i nclu de d r iv er /dr v adc .h ret urn va lue no n e. e x a m p le / * s i n g le en d i n p u t, s i n g le o p e r atio n m o d e, ch an n el 5 is s e le cted , a dc clo c k f r eq u e n c y = 1 2 mh z /( 5 +1 ) */ dr v a d c _ op en ( a dc _ sin g l e _ e nd, a dc _ sin g l e _ op , 0 x 2 0 , e x t e r nal _ 1 2 mh z , 5 ) ; drva dc _ clos e p ro t o t y pe v o id dr v a dc _ c lo s e ( v o id ) ; descript io n c lo s e a d c f u n ctio n s . dis ab le a d c , a dc e n g in e clo c k an d a d c i n ter r u p t. i nclu de d r iv er /dr v adc .h ret urn va lue no n e. ex a m p le / * c lo s e th e a d c f u n ctio n * / dr v a dc _ c lo s e () ; pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 132 - drvadc _ s e ta dc channe l p ro t o t y pe v o id dr v a d c _ set a dc c h a n n el ( u in t8 _ t u8 c h an n else lb it w is e, e_ a d c _ i np ut _ mo de i n p u tmo d e ) ; descript io n select a dc i n p u t c h a n n e ls . p a ra m et er s u8 cha nn else lb it w is e [ in] s p ec if y th e i n p u t c h a n n el s . i f s o f t w ar e en ab le s m o r e th a n o n e c h an n el i n s i n g le m o d e, o n l y t h e ch a n n el w it h th e l o west n u m b er w ill b e co n v er ted an d th e o th er e n ab led ch an n el s w il l b e ig n o r ed . fo r ex a m p le, if u s er en ab le ch a n n el 2 , 3 an d 4 in s in g le m o d e, o n l y ch an n e l 2 w ill b e co n v er ted . i n d if f er en t ial in p u t m o d e, o n l y th e ev e n n u m b er o f t h e t w o co r r esp o n d in g ch a n n e ls n ee d s to b e en ab led . t h e co n v er s io n r esu lt w il l b e p lace d to th e co r r esp o n d in g d ata r eg is ter o f th e s elec t ed c h an n el. fo r ex a m p le, in s in g le - en d i n p u t m o d e, 0 x 4 m ea n s th e c h an n el 2 is s elec ted ; in d i f f er e n tial i n p u t m o d e, it m ea n s c h an n el p air 1 is s elec ted . i np utm o de [ in] sp ec if y th e t y p e o f th e a n alo g in p u t s ig n al. i t m ig h t b e s i n g le - en d o r d if f er en tial i n p u t. a d c _ sin g l e _ e nd : sin g le - en d i n p u t m o d e a d c _ di ff e r e nt i al : d if f er e n tial i n p u t m o d e i nclu de d r iv er /dr v adc .h ret urn va lue no n e. e x a m p le / * i n s in g le - en d i n p u t m o d e, th is f u n ctio n s elec t c h a n n el 0 a n d ch an n el 2 ; i n d i f f er e n tial i n p u t m o d e, it se lect ch a n n el p air 0 an d ch an n el p air 1 . * / dr v a d c _ set a d c c h a n n el ( 0 x 5 ) ; drvadc _ con figa dc channe l7 p ro t o t y pe v o id dr v a d c _ c o n f i g a d c c h an n el7 ( e_ adc_ c h7 _ sr c c h 7 src ) ; descript io n s elec t th e i n p u t s i g n al s o u r ce o f adc c h an n el 7 . pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 133 - p a ra m et er s ch7 src [ in] s p ec if y th e a n alo g i n p u t s o u r c e . e xt e r nal _ i np ut _ sig nal : e x ter n al a n alo g i n p u t i nt e r nal _ b a nd g a p : in t er n al b an d g ap v o lta g e i nt e r nal _ t e mpe r a t ur e _ sensor : in ter n a l te m p er at u r e s en s o r i nclu de d r iv er /dr v adc .h ret urn va lue no n e. e x a m p le /* select the external analog input as the source of channel 7 */ drvadc_ configa dc channel7 ( ext ernal _input_signal ) ; drvadc _ s e ta dc input m ode p ro t o t y pe v o id dr v a d c _ set a dc i n p u t mo d e ( e_ a dc _ i np ut _ mo de i n p u tmo d e ) ; descript io n set th e a d c i n p u t m o d e . p a ra m et er s i np utm o de [ in] s p e cif y th e i n p u t m o d e . a d c _ sin g l e _ e nd : sin g le - en d i n p u t m o d e a d c _ di ff e r e nt i al : d if f er e n tial i n p u t m o d e i nclu de d r iv er /dr v adc .h ret urn va lue no n e. e x a m p le / * t h e f o llo w in g s tate m en t i n d icate s th at t h e ex ter n al a n alo g in p u t is a s i n g le - en d i n p u t * / dr v a d c _ set a dc i n p u tmo d e ( a d c _ sin g l e _ e nd ) ; pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 134 - drvadc _ s e ta dc ope ra tionm ode p ro t o t y pe v o id d r v a d c _ set a dc op er atio n mo d e ( e_ a dc _ op e r a t i on_ mo de op mo d e ) ; descript io n set th e a d c o p er atio n m o d e . p a ra m et er s o pm o de [ in] s p ec if y th e o p er atio n m o d e . a d c _ sin g l e _ op : sin g le m o d e a d c _ sin g l e _ c y c l e _ op : s in g le c y cle s ca n m o d e a d c _ c o nt i nuou s_ op : co n tin u o u s s ca n m o d e i nclu de d r iv er /dr v adc .h ret urn va lue no n e. e x a m p le / * t h e f o llo w in g s tate m en t c o n f ig u r es t h e s i n g le m o d e as t h e o p er atio n m o d e * / dr v a d c _ set a dc op er atio n mo d e( a dc _ sin g l e _ op ) ; drvadc _ s e ta dc clk s rc p ro t o t y pe v o id dr v a d c _ set a dc c l k sr c ( e_ a dc _ c l k_ s r c c lo c k src ) ; descript io n select th e a d c clo ck s o u r ce . p a ra m et er s clo cksrc [ in] s p ec if y th e a d c clo ck s o u r ce . e xt e r nal _ 1 2 mh z : e x ter n al 1 2 mh z cr y s tal i nt e r nal _ p l l : in ter n a l p l l o u tp u t i nt e r nal _ hc l k : s y s te m clo c k i nt e r nal _ r c 2 2 mh z : in ter n a l 2 2 . 1 1 8 4 mh z r c o s ci llato r i nclu de d r iv er /dr v adc .h pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 135 - ret urn va lue no n e. e x a m p le /* select the external 12mhz crystal as the clock source of adc */ drvadc_seta dc clksrc (ext ernal _12mhz) ; drvadc _ s e ta dc div is or p ro t o t y pe v o id dr v a d c _ set a dc di v is o r ( u in t8 _ t u8 a d cdi v is o r ) ; descript io n s et th e d iv is o r v al u e o f a d c clo ck to d eter m in e t h e a d c cl o ck f r eq u e n c y . a d c clo ck f r eq u e n c y = a d c clo ck s o u r ce f r eq u e n c y / ( u8 a d cdi v is o r + 1 ) p a ra m et er s u8 adcdiv is o r [ in] s p ec if y th e d i v is o r v al u e . t h e r an g e o f u 8 a d cdiv is o r is 0 ~ 0 x ff . i nclu de d r iv er /d r v adc.h ret urn va lue no n e. e x a m p le / * t h e clo ck s o u r ce o f a d c is f r o m ex ter n al 1 2 mh z cr y s tal. t h e a dc clo c k f r eq u e n c y i s 2 mh z. * / dr v a d c _ set a dc c l k src ( e x t e r nal _ 1 2 mh z ) ; dr v a d c _ set a dc di v is o r ( 5 ) ; drva dc _ e nabl e adc i nt p ro t o t y pe v o id dr v a dc _ e n ab le a d c i n t ( dr v a d c _ a d c _ c al l b a c k c allb ac k , u in t3 2 _ t u 3 2 user data ) ; descript io n pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 136 - e nable adc inter r upt and setup the callback function . as an adc interrupt occurs, the callback function will be executed. when the adc interrupt function is enabled and one of the following cond itions happens, the adc interrupt will be asserted. ? ? the a/d conversion of the specified channel is completed in single mode. ? ? t h e a /d co n v er s io n s o f all s el ec ted ch an n els ar e co m p leted i n s i n g le c y cle s ca n m o d e o r co n tin u o u s s ca n m o d e. p a ra m et er s c a llb a c k [ in] t h e ca llb ac k f u n ctio n o f th e a dc in ter r u p t . u3 2 userda t a [ in] t h e p ar am eter o f th e ca l lb ac k f u n ctio n . i nclu de d r iv er /dr v adc .h ret urn va lue no n e. e x a m p le / * a d c in ter r u p t c allb ac k f u n ctio n * / v o id a d ci n t c allb ac k ( u i n t3 2 _ t u 3 2 user data ) { g u 8 a d ci n t fla g = 1 ; } / * e n ab le t h e a dc i n ter r u p t a n d s etu p t h e ca llb ac k f u n ctio n . t h e p ar am eter 0 w ill b e p ass e d to th e ca llb ac k f u n ctio n . */ dr v a d c _ e n ab le a dc i n t( a d c i n tc allb ac k , 0 ) ; drva dc _ dis a ble adc int p ro t o t y pe v o id dr v a dc _ dis ab le a d ci n t ( v o id ) ; descript io n d is ab le th e ad c i n ter r u p t . p a ra m et er s no n e i nclu de d r iv er /dr v adc .h pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 137 - ret urn va lue no n e. e x a m p le / * dis ab le t h e a d c in ter r u p t * / dr v a dc _ dis ab le a d c i n t () ; drva dc _ e nabl e a dcc mp0 int p ro t o t y pe v o id dr v a dc _ e n ab le a d c c m p 0 i n t ( dr v a d c _ a d c mp 0 _ c al l b a c k c allb ac k , u in t3 2 _ t u 3 2 user data ) ; descript io n e n ab le th e a d c co m p ar ato r 0 in ter r u p t a n d s et u p ca llb ac k f u n ct io n . i f t h e co n v er s io n r es u lt s atis f ies t h e co m p ar e co n d itio n s s e t in dr v a d c _ e n ab le a d c c m p 0 ( ) , a co m p ar ato r 0 in ter r u p t w ill b e as s er ted an d th e ca llb ac k f u n ctio n w ill b e ex ec u ted . p a ra m et er s c a llb a c k [ in] t h e ca llb ac k f u n ctio n o f th e a dc co m p ar ato r 0 in ter r u p t . u3 2 userda t a [ in] t h e p ar am eter o f th e ca l lb ac k f u n ctio n . i nclu de d r iv er /dr v adc .h ret urn va lue no n e. e x a m p le / * a d c co m p ar ato r 0 in ter r u p t c allb ac k f u n ctio n * / v o id c m p 0 i n t c allb ac k ( u i n t3 2 _ t u 3 2 user data ) { g u 8 a d cc m p 0 i n t flag = 1 ; } in t3 2 _ t m ai n ( ) { pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 138 - / * e n ab le t h e a dc co m p ar ato r 0 in ter r u p t a n d s etu p t h e ca ll b ac k f u n ct io n . t h e p ar am eter 0 w ill b e p ass ed to th e ca llb ac k f u n ctio n . */ dr v a d c _ e n ab le a d c c m p 0 i n t( c m p 0 i n tc a llb ac k , 0 ) ; } drva dc _ dis a ble a dc c mp0 int p ro t o t y pe v o id dr v a dc _ dis ab le a d c m p 0 i n t ( v o id ) ; descript io n d is ab le th e a d c co m p ar ato r 0 in ter r u p t . p a ra m et er s no n e. i nclu de d r iv er /dr v adc .h ret urn va lue no n e. e x a m p le / * dis ab le t h e a d c co m p ar at o r 0 in ter r u p t * / dr v a dc _ dis ab le a d c c m p 0 i n t () ; drva dc _ e nabl e a dcc mp1 int p ro t o t y pe v o id dr v a dc _ e n ab le a d c c mp 1 i n t ( dr v a d c _ a d c mp 1 _ c al l b a c k c allb ac k , u in t3 2 _ t u 3 2 user data ) ; descript io n e n ab le th e a d c co m p ar ato r 1 in ter r u p t a n d s et u p ca llb ac k f u n ct io n . i f t h e co n v er s io n r es u lt s atis f ies t h e co m p ar e co n d itio n s s e t in dr v a d c _ e n ab le a d c c m p 1 ( ) , a co m p ar ato r 1 in ter r u p t w ill b e as s er ted an d th e ca llb ac k f u n ctio n w ill b e ex ec u ted . p a ra m et er s c a llb a c k [ in] t h e ca llb ac k f u n c t i on o f th e a dc co m p ar ato r 1 in ter r u p t . u3 2 userda t a [ in] pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 139 - t h e p ar am eter o f th e ca l lb ac k f u n ctio n . i nclu de d r iv er /dr v adc .h ret urn va lue no n e. e x a m p le / * a d c co m p ar ato r 1 in ter r u p t c allb ac k f u n ctio n * / v o id c m p 1 i n t c allb ac k ( u i n t3 2 _ t u 3 2 user data ) { g u 8 a d cc m p 1 i n t flag = 1 ; } in t3 2 _ t m ai n ( ) { / * e n ab le t h e a dc co m p ar ato r 1 in ter r u p t a n d s e tu p t h e ca ll b ac k f u n ct io n . t h e p ar am eter 0 w ill b e p ass ed to th e ca llb ac k f u n ctio n . */ dr v a d c _ e n ab le a d c c mp 1 i n t( c m p 1 i n tc a llb ac k , 0 ) ; } drva dc _ dis a ble a dc c mp 1 int p ro t o t y pe v o id dr v a dc _ dis ab le a d c c mp 1 i n t ( v o id ) ; descript io n d is ab le th e a d c co m p ar ato r 1 in ter r u p t . p a ra m et er s no n e. i nclu de d r iv er /dr v adc .h ret urn va lue no n e. e x a m p le / * dis ab le t h e a d c co m p ar at o r 1 in ter r u p t * / dr v a dc _ dis ab le a d c c mp 1 i n t () ; pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 140 - drvadc _ ge tc onve rs ionrate p ro t o t y pe u in t3 2 _ t dr v adc_ get c o n v er s io n r ate ( v o id ) ; descript io n g et th e a /d co n v er s io n r ate . t h e a d c tak e s ab o u t 2 7 adc clo ck c y cles f o r co n v er t i n g o n e s a m p le . p a ra m et er s no n e. i nclu de d r iv er /dr v adc .h ret urn va lue r etu r n th e co n v er s io n r ate . t h e u n it i s s a m p le/s ec o n d . e x a m p le / * t h e clo ck s o u r ce o f a d c is f r o m ex ter n al 1 2 mh z cr y s tal. t h e a dc clo c k f r eq u e n c y i s 2 mh z. t h e co n v er s io n r ate is ab o u t 7 4 k s a m p le/s ec o n d * / dr v a d c _ set a dc c l k src ( e x t e r nal _ 1 2 mh z ) ; dr v a d c _ set a dc di v is o r ( 5 ) ; / * get t h e co n v er s io n r ate * / p r in tf ( " c o n v er s io n r ate: %d s a m p les/ s ec o n d \ n " , dr v a d c _ g etc o n v er s io n r ate( ) ) ; drvadc _ e nabl e e x tt rigge r p ro t o t y pe v o id dr v a d c _ e n ab lee x tt r ig g er ( e_ a d c _ e xt _ t r i _ c ond t r ig g er c o n d itio n ) ; descript io n a llo w t h e ex ter n al tr i g g er p i n ( p b 8 ) to b e th e tr ig g er s o u r ce o f adc . t h e ex ter n al tr ig g er p in m u s t b e co n f ig u r ed as a n i n p u t p in in ad v a n ce . p a ra m et e rs t rig g er co nd it io n [ in] s p ec if y th e tr i g g er co n d it io n . t h e tr ig g er co n d itio n co u ld b e lo w - lev e l / h i g h - le v el / f alli n g - ed g e / p o s itiv e - ed g e. l ow _ l e ve l : lo w le v el. hi gh_ l e ve l : h ig h le v el. f a l l i ng_ e dge : f alli n g ed g e. r i sin g_ e dge : r is in g ed g e. pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 141 - i nclu de d r iv er /dr v adc .h ret urn va lue no n e e x a m p le / * use p b 8 p in as th e ex ter n al tr ig g er p in . t h e tr ig g er co n d it io n is lo w lev e l tr ig g er . * / dr v a d c _ e n ab lee x tt r ig g er ( l ow _ l e ve l ); drvadc _ dis a ble e x tt rigge r p ro t o t y pe v o id dr v a d c _ dis ab lee x tt r i g g er ( v o id ) ; descript io n p r o h ib it th e ex ter n al adc tr i g g er . p a ra m et er s no n e. i nclu de d r iv er /dr v adc .h ret urn va lue no n e. e x a m p le / * dis ab le t h e a d c ex ter n al tr ig g er s o u r ce * / dr v a d c _ dis ab lee x tt r ig g er (); drvadc _ s tartc onve r t p ro t o t y pe v o id dr v a d c _ star tc o n v er t( v o id ) ; descript io n c lear th e a d c i n ter r u p t f la g ( a d f) an d s tar t a /d co n v er ti n g . p a ra m et er s no n e . i nclu de d r iv er /dr v adc .h pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 142 - ret urn va lue no n e. e x a m p le / * c lear a d f b it a n d s tar t c o n v er tin g * / dr v a d c _ star tc o n v er t (); drvadc _ s t op con v e rt p ro t o t y pe v o id dr v a d c _ st op c o n v er t( v o id ) ; descript i on st op a /d co n v er ti n g . p a ra m et er s no n e . i nclu de d r iv er /dr v adc .h ret urn va lue no n e. e x a m p le / * sto p co n v er ti n g * / dr v a d c _ st op c o n v er t (); drvadc _ is con v e rs iondo ne p ro t o t y pe u in t3 2 _ t dr v adc_ i s c o n v er s i o n do n e ( v o id ) ; descript io n c h ec k w h eth er t h e co n v er s io n ac ti o n is f in i s h ed o r n o t . p a ra m et er s no n e. i nclu de d r iv er /dr v adc .h ret urn va lue t ur e c o n v er s io n f i n is h ed pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 143 - f a l se in co n v er ti n g e x a m p le / * i f t h e a d c in ter r u p t is n o t en ab led , u s er ca n ca ll t h i s f u n ctio n to ch ec k t h e s tate o f co n v er s io n ac tio n * / / * star t a /d co n v er s io n * / dr v a d c _ star tc o n v er t( ) ; / * w ait co n v er s io n d o n e */ w h ile( ! dr v adc_ i s c o n v er s io n do n e ()); drvadc _ ge tc onve rs ion d at a p ro t o t y pe in t3 2 _ t dr v a d c _ getco n v er s io n d at a ( u i n t8 _ t u8 c h a n n el n u m ) ; descript io n g et th e co n v er s io n r es u lt o f th e s p ec if ied a dc c h a n n el . p a ra m et er s u8 cha nn eln u m [ in] s p ec if y th e a d c c h an n el . t h e r an g e o f t h is v al u e is 0 ~7 . i nclu de d r iv er /dr v adc .h ret urn va lue a 3 2 - b it c o n v er s io n r esu l t . i t is g e n er ated b y e x te n d in g th e o r ig in a l 1 2 b its co n v er s io n r es u lt. e x a m p le / * get t h e co n v er s io n r e s u lt o f a d c ch a n n el 3 * / p r in tf ( c o n v er s io n r es u lt o f c h an n el 3 : %d \ n , dr v a d c _ g etc o n v er s io n d at a( 3 ) ) ; drvadc _ e nabl e p dm a p ro t o t y pe v o id dr v a d c _ e n ab le p dm a ( v o id ) ; descript io n e n ab le p dm a tr an s f er . user ca n tr an s f er t h e a /d co n v er s io n r esu lt to u s er - s p ec i f ied m e m o r y s p ac e b y p dm a w it h o u t c p u in ter v e n tio n . i n s i n g le m o d e, o n l y t h e co n v er s io n r es u lt o f t h e s elec ted ch a n n el w i ll b e tr an s f er r ed . i n s in g le c y cle s ca n m o d e o r c o n tin u o u s s ca n m o d e, th e co n v er s io n r esu lts o f all e n ab l ed ch an n e ls w il l b e tr an s f er r ed b y p dm a . p a ra m et er s pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 144 - no n e. i nclu de d r iv er /dr v adc .h ret urn va lue no n e e x a m p le / * e n ab le p dm a tr an s f er * / dr v a d c _ e n ab le p dm a ( ) ; drvadc _ dis a ble p dm a p ro t o t y pe v o id dr v a d c _ dis ab le p dm a ( v o id ) ; descript io n dis ab le p dm a tr a n s f er . p a ra m et er s no n e. i nclu de d riv er /dr v adc .h ret urn va lue no n e e x a m p le / * dis ab le p dm a tr an s f er * / dr v a d c _ dis ab le p dm a ( ) ; drvadc _ is data v a li d p ro t o t y pe u in t3 2 _ t dr v adc_ i s data vali d ( u in t8 _ t u8c h an n eln u m ) ; descript io n c h ec k w h eth er t h e co n v er s io n d ata is v alid o r n o t . p a ra m et er s u8 cha nn eln u m [ in] s p ec if y th e a d c c h an n el . t h e r an g e o f t h is v al u e is 0 ~7 . pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 145 - i nclu de d r iv er /dr v adc .h ret urn va lue t ur e : d ata is v alid f a l se : d ata is i n v al id e x a m p le / * c h ec k if t h e d ata o f ch a n n el 3 is v alid . * / i f ( dr v a d c _ i s data valid ( 3 ) ) u 3 2 c o n v er s io n da ta = dr v a d c _ getco n v er s io n data ( u 8 c h a n n el nu m ) ; / * get t h e d ata * / drvadc _ is data ov e rr un p ro t o t y pe u in t3 2 _ t dr v adc_ i s data ov e r r u n ( u i n t8 _ t u8 c h a n n el nu m ) ; descript io n c h ec k w h eth er t h e co n v er s io n d ata is o v er r u n o r n o t . p a ra m et er s u8 cha nn eln u m [ in] s p ec if y th e a d c c h an n el . t h e r an g e o f t h is v al u e is 0 ~7 . i nclu de d r iv er /dr v adc .h ret urn va lue t ur e o v er r u n f a l se n o n - o v er r u n e x a m p le / * c h ec k if t h e d ata o f ch a n n el 3 is o v er r u n . * / i f( dr v a d c _ i s data o v er r u n ( 3 ) ) p r in tf ( t h e d ata h as b ee n o v er w r itte n . \ n ); drvadc _ e nabl e ad cc mp0 p ro t o t y pe in t3 2 _ t dr v a d c _ e n ab le a d c c m p 0 ( u in t8 _ t u8c m p c h an n eln u m , e_ a d c _ c mp _ c ondi t i on c m p c o n d itio n , pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 146 - u in t1 6 _ t u 1 6 c m p data , u in t8 _ t u8c m p ma tch c o u n t ) ; descript io n e n ab le th e a d c co m p ar ato r 0 an d c o n f i g u r e th e n ec e s s ar y s ettin g s . p a ra m et er s u8 c m pc ha nn eln u m [ in] s p ec if y th e c h an n el n u m b er th at w a n ts to co m p ar e . t h e r an g e o f th is v al u e is 0 ~7 . c m pco n ditio n [ in] s p ec if y th e co m p ar e co n d itio n . l e s s_ t ha n : less t h an t h e co m p ar e d ata . gr e a t e r _ or _ e qu al : g r ea ter o r eq u al to th e co m p a r e d ata. u1 6 c m pda t a [ in] s p ec if y th e co m p ar e d ata . t h e r an g e is 0 ~ 0 x f ff . u8 c m pm a t chco un t [ in] s p ec if y th e co m p ar e m atch co u n t . t h e r an g e is 0 ~ 1 5 . w h en th e s p ec if ied a /d c h an n el an alo g co n v er s io n r esu l t m atc h es t h e co m p ar e co n d itio n , t h e in ter n al m atc h co u n ter w ill in cr ea s e 1 . w h en t h e in ter n al co u n ter r ea ch e s th e v al u e to ( u8 c m p ma tc h c o u n t +1 ) , th e co m p ar ato r 0 in ter r u p t f lag w i ll b e s et. i nclu de d r iv er /dr v adc .h ret urn va lue e _ suc c e ss : s u cc es s. t h e co m p ar e f u n ctio n i s en ab led . e _ dr v a dc _ ar gum e nt : o n e o f t h e in p u t a r g u m en t s is o u t o f th e r a n g e e x a m p le u 8 c m p c h an n eln u m = 0 ; u 8 c m p ma tch c o u n t = 5 ; / * e n ab le a d c co m p ar ato r 0 . c o m p ar e co n d itio n : c o n v er s io n r esu lt < 0 x 8 0 0 . * / dr v a d c _ e n ab le a d c c m p 0 ( u 8 c m p c h an n eln u m , l e ss _ t han, 0 x 8 0 0 , u 8 c m p ma tch c o u n t) ; drvadc _ dis a ble ad c cmp0 p ro t o t y pe v o id dr v a d c _ dis ab le a d c c m p 0 ( v o id ) ; descript io n pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 147 - d is ab le th e a d c co m p ar ato r 0 . p a ra m et er s no n e. i nclu de d r iv er /dr v adc .h ret urn va lue no n e. e x a m p le /* disable the adc comparator 0 */ drvadc_ disableadccmp0 (); drvadc _ e nabl e ad cc mp1 p ro t o t y pe in t3 2 _ t dr v a d c _ e n ab le a d c c m p 1 ( u in t8 _ t u8c m p c h an n eln u m , e_ a d c _ c mp _ c ondi t i on c m p c o n d itio n , u in t1 6 _ t u 1 6 c m p data , u in t8 _ t u8c m p ma tch c o u n t ) ; descript io n e n ab le th e a d c co m p ar ato r 1 an d c o n f i g u r e th e n ec e s s ar y s ettin g s . p a ra m et er s u8 c m pc ha nn eln u m [ in] s p ec if y th e c h an n el n u m b er th at w a n ts to co m p ar e . t h e r an g e o f th is v al u e is 0 ~7 . c m pco n ditio n [ in] s p ec if y th e co m p ar e co n d itio n . l e s s_ t ha n : less t h a n th e c o m p ar e d ata . gr e a t e r _ or _ e qu al : g r ea ter o r eq u al to th e co m p ar e d ata. u1 6 c m pda t a [ in] s p ec if y th e co m p ar e d ata . t h e r an g e is 0 ~ 0 x f ff . u8 c m pm a t chco unt [ in] s p ec if y th e co m p ar e m atch co u n t . t h e r an g e is 0 ~ 1 5 . w h en th e s p ec if ied a /d c h an n el an alo g co n v er s io n r esu l t m atc h es t h e co m p ar e co n d itio n , t h e in ter n al m atc h co u n ter w ill in cr ea s e 1 . w h en t h e in ter n al co u n ter r ea ch e s th e v al u e to ( u8 c m p ma tc h c o u n t +1 ) , th e in ter r u p t f lag o f co m p ar ato r 1 w il l b e s et. pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 148 - i nclu de d r iv er /dr v adc .h ret urn va lue e _ suc c e ss : s u cc es s . t h e co m p ar e f u n ctio n i s en ab led . e _ dr v a dc _ ar gum e nt : o n e o f t h e in p u t a r g u m en t s is o u t o f th e r a n g e e x a m p le u 8 c m p c h an n eln u m = 0 ; u 8 c m p ma tch c o u n t = 5 ; /* enable adc comparator 1 . compare condition: conversion result < 0x800. */ drvadc_ enableadccmp1 (u8cmpchannelnum, less_than, 0x800, u8cmpmatchcount); drvadc _ dis a ble ad c cmp1 p ro t o t y pe v o id dr v a d c _ dis ab le a d c c m p 1 ( v o id ) ; descript io n d is ab le th e a d c co m p ar ato r 1. p a ra m et er s no n e. i nclu de d r iv er /dr v adc .h ret urn va lue no n e. e x a m p le / * dis ab le t h e a d c co m p ar at o r 1 * / dr v a d c _ dis ab le a d c c m p 1 (); drvadc _ e nabl e s e lfcal ibra tion p ro t o t y pe v o id dr v a d c _ e n ab lesel f c a li b r atio n ( v o id ) ; descript io n e n ab le th e s el f ca lib r at io n f u n ctio n f o r m i n i m izi n g th e a/d co n v er s io n er r o r . w h en ch ip p o w er o n o r s o f t w ar e s w itc h es th e a dc i n p u t t y p e b et w ee n s in g le - en d m o d e a n d d if f er e n t ial m o d e, u s er n ee d s to ca ll t h is f u n ct io n to en ab le t h e s el f ca lib r atio n . af ter ca ll t h is f u n ctio n , pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 149 - u s er ca n ca ll dr v a d c _ i s c al i b r atio n do n e ( ) to ch ec k i f th e s elf ca lib r atio n i s d o n e b ef o r e an y a / d co n v er s io n . p a ra m et er s no n e. i nclu de d r iv er /dr v adc .h ret urn va lue no n e. e x a m p le /* e nable the self calibration function */ drvadc_ enableselfcalibration (); drvadc _ is cal ibr a tiond one p ro t o t y pe u in t3 2 _ t dr v adc_ i s c alib r ati o n do n e ( v o id ) ; descript io n c h ec k w h eth er t h e s el f ca lib r a tio n ac tio n i s f i n i s h ed o r n o t . p a ra m et er s no n e. i nclu de d r iv er /dr v adc .h ret urn va lue t ur e : th e s el f ca lib r atio n ac ti o n is f in i s h ed . f a l se : t h e s el f ca lib r atio n ac tio n is i n p r o g r ess . e x a m p le if ( dr v a d c _ i s c alib r atio n do n e ( ) ) p r in tf ( sel f ca lib r atio n d o n e. \ n ); drvadc _ dis a ble s e lf cal ibra tion p ro t o t y pe v o id dr v a d c _ dis ab lesel f c al ib r atio n ( v o id ) ; descript io n pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 150 - dis ab le th e s e lf ca l ib r atio n f u n ctio n . pa ra m et er s no n e. i nclu de d r iv er /dr v adc .h ret urn va lue no n e. e x a m p le /* disable the self calibration function */ drvadc_ disableselfcalibration (); drvadc _ diff m odeo u tp ut forma t p ro t o t y pe v o id dr v a d c _ dif f mo d eou tp u tfo r m a t ( e_ a d c _ di ff _ mo de _ out p u t _ for m a t ou tp u tfo r m a t ); descript io n select th e o u tp u t f o r m at o f d i f f er en tia l in p u t m o d e . on l y n uc 1 0 1 an d lo w d en s it y v er s io n o f nu mic r o tm nu c 1 0 0 s er ies p r o d u ct s s u p p o r t th is f u n ctio n . p lease r ef er to nu mic r o tm nuc1 0 0 ser ies p r o d u cts selec tio n gu id e o f a p p en d i x . p a ra m et er s o utput f o r m a t [ in] s p ec if y th e o u tp u t f o r m at. i t c o u ld b e u n s i g n ed f o r m at ( un sig ne d_ out p u t ) o r 2 ? s co m p le m e n t f o r m at ( t w os_ c om p l e me nt .) i nclu de d r iv er /dr v adc .h ret urn va lue no n e e x a m p le / * 2 ? s co m p le m e n t f o r m at * / dr v a d c _ dif f mo d eou tp u tfo r m at ( t w os_ c om p l e me nt ); drv a dc _ ge tve rs ion p ro t o t y pe pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 151 - u in t3 2 _ t d r v a dc _ getve r s io n ( v o id ); descript io n r etu r n th e c u r r en t v er s io n n u m b er o f adc d r iv er . p a ra m et er s no n e. i nclu de dr iv er /dr v adc .h return value version number : 31:24 23:1 6 15:8 7:0 00000000 major_num minor_num build_num e x a m p le p r in tf ( " dr iv er v er s io n : % x \ n " , dr v a dc _ get ver s io n ( ) ) ; pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 152 - 7. s pi drive r 7.1. sp i int ro du c tio n t h e ser ial p er ip h er al i n ter f ac e ( sp i ) is a s y n ch r o n o u s s er ial d ata co m m u n icat io n p r o to co l w h ic h o p er ates in f u ll d u p lex m o d e. dev ice s co m m u n icate i n m a s ter /s la v e m o d e with 4 - w ir e b i - d ir ec tio n i n ter f ac e. nu mic r o tm nuc1 00 s er ies co n tai n f o u r s ets o f sp i co n tr o ller p er f o r m i n g a s er ial - to - p ar allel co n v er s io n o n d ata r ec eiv ed f r o m a p er ip h er al d ev ice , an d a p ar allel - to - se r ial co n v er s io n o n d ata tr an s m itted to a p er ip h er al d ev ice . e ac h sp i s et ca n d r iv e u p to 2 ex ter n al p er ip h er als . i t a ls o ca n b e d r iv en as t h e s la v e d ev ice w h en t h e sla ve b it ( c nt r l [ 1 8 ] ) is s et. e ac h co n tr o ller ca n g e n er ate a n in d i v id u al i n ter r u p t s ig n al w h en d ata tr an s f er is f i n i s h ed a n d ca n b e clea r ed b y w r iti n g 1 to th e r esp ec tiv e i n te r r u p t f lag . t h e ac tiv e le v el o f d ev ice/sla v e s elec t s ig n al ca n b e p r o g r am m ed to lo w ac ti v e o r h ig h ac ti v e o n s sr [ ss _ l v l ] b it , w h ic h d ep en d s o n t h e co n n ec ted p er ip h er al . w r i tin g a d iv i s o r in to di vi de r r eg i s ter ca n p r o g r a m t h e f r eq u e n c y o f s er ial clo ck o u tp u t w h e n it is as t h e m aster . i f t h e var c l k_ e n b it in sp i _ c n t r l [ 2 3 ] is en ab l ed , th e s er ial clo ck ca n b e s et as t w o p r o g r am m ab le f r eq u e n cies w h ic h ar e d ef in ed i n di v i de r an d d iv i de r 2 . t h e f o r m at o f th e v ar iab le f r eq u en c y i s d ef i n ed in v ar c l k . e ac h sp i co n tr o ller co n tain s t w o 32 - b it tr an s m i s s io n b u f f er s ( t x0 an d t x1 ) an d tw o r ec e p tio n b u f f er s ( r x0 an d r x1 ) , an d ca n p r o v id e b u r s t m o d e o p er atio n . i t also s u p p o r ts v ar iab le len g t h tr an s f er . t h e co n tr o ller also s u p p o r ts tw o b its tr a n s f er m o d e w h ich i s d ef i n ed in t h e sp i _ c nt l [ 2 2 ] . w h en th e t w ob b it, in sp i _ c nt l [ 2 2 ] , is en ab l ed , it c an tr an s m it a n d r ec eiv e t wo b it ser ial d ata v ia th e tr an s m i s s io n /r ec e p tio n b u f f er s . t h e 1 st b it ch an n el tr an s m it s th e d ata f r o m t x0 an d r ec eiv es t h e d ata in to r x0 . t h e 2 nd b it c h an n el tr an s m it s th e d ata f r o m t x1 a n d r ec eiv es t h e d ata in to r x1 . i n th i s d o cu m e n t, w e w ill i n tr o d u ce h o w to u s e t h e sp i d r iv er . 7.2. spi feat ure ? up to f o u r s ets o f sp i co n tr o ll er . ? su p p o r t m aster / s lav e m o d e o p er atio n . ? su p p o r t 1 - or 2 - b it ser ial d ata i n/out . ? c o n f i g u r ab le d ata len g t h o f tr an s f er w o r d u p to 3 2 b its . ? var iab le o u tp u t s er ial clo ck f r eq u en c y in m as ter m o d e . ? p r o v id e b u r s t m o d e o p er atio n , tr an s m it/re ce i v e ca n b e ex ec u ted u p to tw o ti m e s i n o n e tr an s f er . ? msb o r l sb f ir s t d ata tr an s f e r . ? 2 s lav e/d ev ice s elec t li n es in t h e m a s ter m o d e . ? su p p o r t b y te r eo r d er f u n ct io n . ? c o m p atib le w it h mo to r o la sp i an d natio n al se m ico n d u cto r mic r o w ir e b u s . pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 153 - 7.3. t y pe defi nit i on e_ drvspi _port enumeration ident ifier v alue description edrvspi_port0 0 spi port 0 edrvspi_port1 1 spi port 1 edrvspi_port 2 2 spi port 2 edrvspi_port 3 3 spi port 3 e_drvspi_mode enumeration identifier v alue description edrvspi_master 0 master mode edrvspi_slave 1 slave mode e_drv spi_trans_type enumeration identifier v alue description edrvspi_type0 0 spi transfer type 0 edrvspi_type 1 1 spi transfer type 1 edrvspi_type 2 2 spi transfer type 2 edrvspi_type 3 3 spi transfer type 3 edrvspi_type 4 4 spi transfer type 4 edrvspi_type 5 5 spi transfer type 5 edrvspi_type 6 6 spi transfer type 6 edrvspi_type 7 7 spi transfer type 7 e_drvspi_endian enumeration identifier v alue description edrvspi_lsb_first 0 send lsb first edrvspi_msb_first 1 send msb first e_drvspi_byte_reorder enumera tion identifier v alue description edrvspi_byte_reorder_suspend_disable 0 both byte reorder function and byte suspend function are disabled edrvspi_byte_reorder_suspend 1 both byte reorder function and byte suspend function are enabled pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 154 - enumera tion identifier v alue description edrvspi_byte_ reord er 2 enable the byte reorder function edrvspi_byte_suspend 3 enable the byte suspend function e_drvspi_ssltrig enumeration identifier v alue description edrvspi_edge_trigger 0 edge trigger edrvspi_level_trigger 1 level trigger e_drvspi_ss_act_type enum eration identifier v alue description edrvspi_active_low_falling 0 low - level/falling - edge active edrvspi_active_high_rising 1 high - level/rising - edge active e_drvspi_slave_sel enumeration identifier v alue description edrvspi_none 0 no slave device was se lected edrvspi_ss0 1 select the 1 st slave select pin edrvspi_ss1 2 select the 2 nd slave select pin edrvspi_ss0_ss1 3 both pins are selected e_ drvspi _dma_mode enumeration identifier v alue description edrvspi_tx_dma 0 enable tx dma edrvspi_rx_dma 1 ena ble rx dma pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 155 - 7.4. fu n ctio ns drvs p i _ ope n p ro t o t y pe in t3 2 _ t d r v sp i _ op en ( e _ dr vsp i _ p or t esp i p o r t , e _ dr vsp i _ mo de em o d e , e _ dr vsp i _ t r a ns_ t yp e e t y p e , in t3 2 _ t i3 2 b itl en g th ) ; descript io n t h is f u n ctio n is u s ed to o p en sp i m o d u le. i t d ec id es th e sp i to w o r k in m a s ter o r s lav e m o d e, sp i b u s ti m i n g an d b it len g t h p er tr an s f er . t h e au to m atic s la v e s elec t f u n ctio n w ill b e en ab led . p a ra m et er s espipo rt [ in] sp ec if y th e sp i p o r t . edrvsp i _ p or t 0 : sp i 0 edrvsp i _ p or t 1 : sp i 1 edrvsp i _ p or t 2 : sp i 2 edrvsp i _ p or t 3 : sp i 3 em o de [i n] t o w o r k in ma s ter (e dr vsp i _ ma st e r ) or slav e (e dr v s p i _ sl a ve ) m o d e ety pe [ in] t r an s f er t y p es, i.e . th e b u s ti m in g . i t c o u ld b e edrv sp i _ t yp e 0 ~ edrv sp i _ t ype7 . edrv sp i _ t ype0 : th e clo ck id le s tate is lo w ; d r iv e d ata at r is in g - ed g e o f s er ial clo ck ; latch d ata a t r is i n g - ed g e o f s er ial clo ck . dr iv e d ata an d latc h d ata at th e s a m e ed g e. no t r ec o m m e n d to u s e t h is tr a n s f e r ty p e. edrv sp i _ t ype 1 : th e clo ck id le s tate is lo w ; d r iv e d ata at f allin g - ed g e o f s er ial clo c k ; latch d ata at r is i n g - ed g e o f s er ial clo ck . edrv sp i _ t ype 2 : th e clo ck id le s tate is lo w ; d r iv e d ata at r is in g - ed g e o f s er ial clo ck ; latch d ata at f all in g - ed g e o f s e r ial clo ck . edrv sp i _ t ype 3 : th e clo ck id le s tate is lo w ; d r iv e d ata at f allin g - ed g e o f s er ial clo c k ; latch d ata at f all in g - ed g e o f s e r ial clo ck . dr iv e d ata an d latc h d ata at th e s a m e ed g e. no t r ec o m m e n d to u s e t h is tr a n s f e r ty p e. pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 156 - edrv sp i _ t ype 4 : th e clo ck id le s tate is h i g h ; d r iv e d ata at r is in g - ed g e o f s er ial clo c k ; latch d ata at r is i n g - ed g e o f s er ial clo ck . dr iv e d ata an d latc h d ata at th e s a m e ed g e . no t r ec o m m e n d to u s e t h is tr a n s f e r ty p e. edrv sp i _ t ype 5 : th e clo ck id le s tate is h i g h ; d r iv e d ata at f alli n g - ed g e o f s er ial clo ck ; latch d ata at r is i n g - ed g e o f s er ial clo ck . edrv sp i _ t ype 6 : th e clo ck id le s tate is h i g h ; d r iv e d ata at r is in g - ed g e o f s er ial clo c k ; latch d ata at f all in g - ed g e o f s e r ial clo ck . edrv sp i _ t ype 7 : th e clo ck id le s tate is h i g h ; d r iv e d ata at f alli n g - ed g e o f s er ial clo ck ; latch d ata at f all in g - ed g e o f s e r ial clo ck . dr iv e d ata an d latc h d ata at th e s a m e ed g e. no t r ec o m m e n d to u s e t h is tr a n s f e r ty p e. i3 2 b it l eng t h [ in] b it len g t h p er tr an s ac tio n . t h e r an g e is 1 ~3 2 . i nclu de dr iv er /dr v sp i . h ret urn va lue e _ suc c e ss : s u cc es s . e _ dr vsp i _ e r r _ i ni t : t h e s p ec if ied sp i p o r t h as b ee n o p en ed b ef o r e. e _ dr vsp i _ e r r _ b i t _ l e ngt h : t h e b it len g t h is o u t o f r an g e. e _ dr vsp i _ e r r _ b usy : t h e s p ec i f ied sp i p o r t is in b u s y s tatu s . e x a m p le /* configure spi0 as a master, 32 - bit transaction, not qfn 36 - pin package */ drvspi_open(edrvspi_port0, ed rvspi_master, edrvspi_type1, 32 ); drvs p i _ clo s e p ro t o t y pe v o id dr v sp i _ c lo s e ( e _ dr vsp i _ p or t esp i p o r t ) ; descript io n c lo s e th e s p ec if ied sp i m o d u l e an d d is ab le th e sp i in ter r u p t . p a ra m et er s espipo rt [ in] sp ec if y th e sp i p o r t . edrvsp i _ p or t 0 : sp i 0 edrvsp i _ p or t 1 : sp i 1 edrvsp i _ p or t 2 : sp i 2 pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 157 - edrvsp i _ p or t 3 : sp i 3 i nclu de dr iv er /dr v sp i .h ret urn va lue no n e e x a m p le / * c lo s e sp i 0 * / dr v sp i _ c lo s e ( edrv sp i _ p o r t 0 ); drvs p i_ s e t2bit tra n s fer m ode p ro t o t y pe v o id dr v sp i _ set2 b it t r an s f er mo d e ( e _ dr vsp i _ p or t esp i p o r t , u in t8 _ t b e n ab le ) ; descript io n set 2 - b it tr an s f er m o d e. p a ra m et er s espipo rt [ in] sp e cif y th e sp i p o r t . edrvsp i _ p or t 0 : sp i 0 edrvsp i _ p or t 1 : sp i 1 edrvsp i _ p or t 2 : sp i 2 edrvsp i _ p or t 3 : sp i 3 be na ble [ i n] e n ab le ( t r ue ) / d is ab le ( fal se) i nclu de dr iv er /dr v sp i . h ret urn va lue no n e e x a m p le /* e n ab le 2 - b it tr a n s f er m o d e o f sp i 0 * / dr v sp i _ set2 b it tra n s f er mo d e ( edrvsp i _ p or t 0 , t r ue ); pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 15 8 - drvs p i_ s e tendi a n p ro t o t y pe v o id dr v sp i _ seten d ian ( e _ dr vsp i _ p or t esp i p o r t , e _ dr vsp i _ e ndi a n ee n d ia n ) ; descript io n t h is f u n ctio n is u s ed to co n f i g u r e th e b it o r d er o f ea ch tr an s a ctio n . p a ra m et er s espipo rt [ in] sp ec if y th e s p i p o r t . edrvsp i _ p or t 0 : sp i 0 edrvsp i _ p or t 1 : sp i 1 edrvsp i _ p or t 2 : sp i 2 edrvsp i _ p or t 3 : sp i 3 een dia n [ i n] sp ec if y l sb f ir s t ( ed r vsp i _ l sb _ fir st ) o r msb f ir s t ( edrvsp i _ msb _ firs t .) i nclu de dr iv er /dr v sp i . h ret urn va lue no n e e x a m p le /* t h e tr an s f er o r d er o f sp i 0 i s l sb f ir s t * / dr v sp i _ seten d ian ( ed r vsp i _ p or t 0 , edrvsp i _ l sb _ firs t ); drvs p i_ s e tb itlengt h p ro t o t y pe in t3 2 _ t dr v sp i _ setb itl e n g t h ( e _ dr vsp i _ p or t esp i p o r t , in t3 2 _ t i3 2 b itl en g th ) ; descript io n t h is f u n ctio n is u s ed to co n f i g u r e th e b it le n g t h o f sp i tr an s f er . pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 159 - p a ra m et er s espipo rt [ in] sp ec if y th e sp i p o r t . edrvsp i _ p or t 0 : sp i 0 edrvsp i _ p or t 1 : sp i 1 edrvsp i _ p or t 2 : sp i 2 edrvsp i _ p or t 3 : sp i 3 i3 2 b it l eng t h [ in] sp ec if y th e b it le n g th . t h e r an g e is 1 ~3 2 b its. i nclu de dr iv er /dr v sp i . h ret urn va lue e _ suc c e ss : s u cc es s . e _ dr vsp i _ e r r _ b i t _ l e ngt h : t h e b it len g t h is o u t o f r an g e. e x a m p le /* t h e tr an s f er b it len g t h o f s p i 0 is 8 - b it * / dr v sp i _ setb itl e n g th ( ed r vs p i _ p or t 0 , 8 ); drvs p i _ s e tb y tere or der p ro t o t y pe in t3 2 _ t d r v sp i _ setb y te r eo r d er ( e _ dr vsp i _ p or t esp i p o r t , e _ dr vsp i _ b y t e _ r e or de r eop tio n ) ; descript io n t h is f u n ctio n is u s ed to en ab le /d is ab le b y te r eo r d er f u n ctio n . p a ra m et er s espipo rt [ in] sp ec if y th e sp i p o r t . edrvsp i _ p or t 0 : sp i 0 edrvsp i _ p or t 1 : sp i 1 edrvsp i _ p or t 2 : sp i 2 edrvsp i _ p or t 3 : sp i 3 eo ptio n [ in] pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 160 - t h e o p tio n s o f b y te r eo r d er f u n ct io n an d b y te su s p en d f u n ctio n . t h e b y te s u s p e n d f u n ctio n is o n l y a v ailab le in 3 2 - b it tr an s ac t io n . edrvsp i _ b yt e _ r e or de r _ susp e nd_ di sa b l e : b o th b y te r eo r d er f u n c tio n a n d b y te su s p en d f u n ctio n ar e d is ab led . edrvsp i _ b yt e _ r e or de r _ susp e nd : b o th b y te r eo r d er f u n c tio n a n d b y te su s p en d f u n ctio n ar e en ab led . edrvsp i _ b yt e _ r e or de r : o n l y en ab le t h e b y te r eo r d er f u n ctio n . edrvsp i _ b yt e _ susp e nd : o n l y en ab le t h e b y te s u s p en d f u n ctio n . i nclu de dr iv er /dr v sp i . h ret urn va lue e _ suc c e ss : s u cc es s . e _ dr vsp i _ e r r _ b i t _ l e ngt h : t h e b it len g t h mu st b e 8 /1 6 /2 4 /3 2 . e x a m p le /* t h e tr an s f er b it len g t h o f s p i 0 is 3 2 - b it * / dr v sp i _ setb itl e n g th ( ed r vs p i _ p or t 0 , 32 ); / * e n ab le t h e b y te r eo r d er f u n ctio n o f sp i 0 * / dr v sp i _ setb y te r eo r d er ( edr vsp i _ p or t 0 , edrvsp i _ b yt e _ r e or de r ); drvs p i_ s e tsus p e ndc y c le p ro t o t y pe in t3 2 _ t dr v sp i _ setsu s p en d c y cle ( e _ dr vsp i _ p or t esp i p o r t , in t3 2 _ t i3 2 i n ter v al ) ; descript io n set th e n u m b er o f clo ck c y cle o f th e s u s p e n d in ter v al. i n s la v e m o d e, ex ec u ti n g th i s f u n ctio n is u n m ea n i n g f u l . p a ra m et er s espipo rt [ in] sp ec if y th e sp i p o r t . edrvsp i _ p or t 0 : sp i 0 edrvsp i _ p or t 1 : sp i 1 pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 161 - edrvsp i _ p or t 2 : sp i 2 edrvsp i _ p or t 3 : sp i 3 i3 2 i nte rv a l [ in] i n fifo m o d e an d b u r s t tr an s f er m o d e, th i s v al u e s p ec i f ied t h e d ela y clo ck n u m b er b et w ee n s u cc ess iv e tr a n s ac tio n s . i f t h e b y te s u s p e n d f u n c ti o n is en ab le d , it sp ec i f ied th e d elay clo c k n u m b er am o n g ea ch b y te. p lease r ef er to t r m f o r th e ca lcu latio n o f th e s u s p en d in ter v al. i nclu de dr iv er /dr v sp i . h ret urn va lue e _ suc c e ss : s u cc es s . e _ dr vsp i _ e r r _ susp e nd _ i nt e r val : t h e s u s p en d i n ter v al s etti n g i s o u t o f r a n g e . e x a m p le /* the suspend interval is 10 spi clock cycles */ drvspi_setsuspendcycle ( edrvspi_port0 , 10 ); drvs p i_ s e tt rigge rm ode p ro t o t y pe v o id dr v sp i _ sett r ig g er mo d e ( e _ dr vsp i _ p or t esp i p o r t , e _ dr vsp i _ ss l t r i g esst r ig g er mo d e ) ; descript io n s et th e tr i g g er m o d e o f s lav e s elec t p in . i n m a s ter m o d e, ex e cu ti n g t h i s f u n c tio n i s f u n ctio n les s . p a ra m et er s espipo rt [ in] sp ec if y th e sp i p o r t . edrvsp i _ p or t 0 : sp i 0 edrvsp i _ p or t 1 : sp i 1 edrvsp i _ p or t 2 : sp i 2 edrvsp i _ p or t 3 : sp i 3 esst rig g er m o de [ in] sp ec if y th e tr i g g er m o d e. edrvsp i _ e dge _ t r i gge r : e d g e tr ig g er . pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 162 - edrvsp i _ l e ve l _ t r i gge r : le v e l tr ig g er . i nclu de dr iv er /dr v sp i . h ret urn va lue no n e e x a m p le /* l ev el tr i g g er * / dr v sp i _ sett r ig g er mo d e ( edrvsp i _ p or t 0 , edrvsp i _ l e ve l _ t r i gge r ); drvs p i_ s e tsl a v e s e l e c ta c tive le v e l p ro t o t y pe v o id dr v sp i _ setsl av e select activ e l e v el ( e _ dr vsp i _ p or t esp i p o r t , e _ dr vsp i _ ss _ ac t _ t yp e ess a ctt y p e ) ; descript io n set th e ac ti v e le v el o f s la v e s e lect . p a ra m et er s espipo rt [ in] sp ec if y th e sp i p o r t . edrvsp i _ p or t 0 : sp i 0 edrvsp i _ p or t 1 : sp i 1 edrvs p i _ p or t 2 : sp i 2 edrvsp i _ p or t 3 : sp i 3 essact t y pe [ in] select th e ac ti v e t y p e o f s la v e s elec t p in . edrvsp i _ ac t i ve _ l ow _ fall i ng: slav e s e lect p in is ac t iv e lo w i n lev el - tr i g g er m o d e; o r f allin g - ed g e tr ig g er in ed g e - tr i g g er m o d e. edrvsp i _ ac t i ve _ hi gh_ r i sin g: sla v e s e lect p in is ac t iv e h i g h in lev e l - tr ig g er m o d e; o r r is in g - ed g e tr ig g er in ed g e - tr i g g er m o d e. i nclu de dr iv er /dr v sp i . h pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 163 - ret urn va lue no n e e x a m p le /* c o n f i g u r e th e ac ti v e le v el o f sp i 0 s lav e s elec t p i n * / dr v sp i _ setsl av e select a cti v e l e v el( edrv sp i _ p or t 0 , edr vsp i _ ac t i ve _ l ow _ fall i ng) ; drvs p i _ ge tl e v e ltri g ger s tatus p ro t o t y pe u in t8 _t dr v sp i _ getl e v elt r ig g er stat u s ( e _ dr vsp i _ p or t esp i p o r t ) ; descript io n t h is f u n ctio n is u s ed to g et t h e lev el - tr ig g er tr an s m i s s io n s t atu s o f s la v e d ev ice. p a ra m et er s espipo rt [ in] sp ec if y th e sp i p o r t . edrvsp i _ p or t 0 : sp i 0 edrvsp i _ p or t 1 : sp i 1 edrvsp i _ p or t 2 : sp i 2 edrvsp i _ p or t 3 : sp i 3 i nclu de dr iv er /dr v sp i . h ret urn va lue t r ue : t h e tr a n s ac tio n n u m b er an d th e tr an s f er r ed b it len g t h m et t h e s p ec i f ied r eq u ir e m e n ts . f a l se: t h e tr an s ac tio n n u m b er o r th e tr an s f er r ed b it len g t h o f o n e tr an s ac tio n d o esn ' t m ee t th e s p ec i f ied r eq u ir e m e n t s . e x a m p le /* l ev el tr i g g er * / dr v sp i _ sett r ig g er mo d e ( edrvsp i _ p or t 0 , edrvsp i _ l e ve l _ t r i gge r ); / * c h ec k th e le v el - tr ig g er tr an s m i s s io n s tat u s */ i f ( dr v sp i _ getl e v elt r ig g er s tatu s ( ed r vsp i _ p or t 0 ) ) dr v sp i _ du m p r x r e g is ter ( ed r vsp i _ p or t 0 , & au 3 2 des tin a tio n data [ u 3 2 data c o u n t] , 1 ) ; / * r ea d r x b u f f e r * / pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 164 - drvs p i_ e nabl e aut o s s p ro t o t y pe v o id dr v sp i _ e n ab leau to s s ( e _ dr vsp i _ p or t esp i p o r t , e _ dr vsp i _ sla ve _ se l esl av esel ) ; descript io n t h is f u n ctio n is u s ed to en ab le th e au to m atic s lav e s e lect f u n ctio n an d s elec t t h e s la v e s elec t p in s . t h e au to m at ic s la v e s ele ct m ea n s t h e sp i w ill s et th e s l av e s elec t p i n to ac tiv e s ta te w h e n tr an s f er r in g d ata an d s et th e s la v e s elec t p i n to in ac ti v e s ta te w h e n o n e tr an s f er is f i n is h ed . fo r s o m e d ev ices, t h e s lav e s elec t p in m a y n ee d to b e k ep t a t a ctiv e s tate f o r m a n y tr an s f er s . user s h o u ld d is ab le th e au to m atic s lav e s elec t f u n c tio n an d co n tr o l th e s lav e s ele ct p in m a n u a ll y f o r th e s e d ev ices . i n s lav e m o d e, ex ec u ti n g th is f u n ctio n is f u n ctio n les s . p a ra m et er s espipo rt [ in] sp ec if y th e sp i p o r t . edrvsp i _ p or t 0 : sp i 0 edrvsp i _ p or t 1 : sp i 1 edrvsp i _ p or t 2 : sp i 2 edrvsp i _ p or t 3 : sp i 3 esla v esel [ in] select th e s lav e s elec t p in s w h ich w ill b e u s ed . edrvsp i _ none : n o s lav e w a s s elec ted . edrvsp i _ ss 0 : th e ss 0 w as s elec ted . edrvsp i _ ss 1 : th e ss 1 w as s elec ted . edrvsp i _ ss 0 _ ss 1 : b o th ss 0 an d ss 1 w er e s elec ted . i nclu de dr iv er /dr v sp i . h ret urn va lue no n e e x a m p le /* e n ab le t h e au to m atic s lav e s elec t f u n ctio n o f ss 0 . * / dr v sp i _ e n ab leau to s s(e d r v sp i _ p or t 0 , edrvsp i _ ss 0 ) ; pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 165 - drvs p i_ di s a bl e aut o s s p ro t o t y pe v o id dr v sp i _ dis ab leau to s s ( e _ dr vsp i _ p or t esp i p o r t ) ; descript io n t h is f u n ctio n is u s ed to d is ab le th e au to m at ic s la v e s e lectio n f u n ctio n . i f u s er w a n t s to k ee p th e s la v e s elec t s i g n al at ac ti v e s tate d u r in g m u l tip le w o r d s d ata tr an s f er , u s er ca n d is ab le th e au to m at ic s la v e s elec ti o n f u n c tio n an d co n tr o l t h e s la v e s ele ct s ig n al m a n u a ll y . i n s la v e m o d e , ex ec u t in g t h is f u n ctio n is f u n c tio n les s . p a ra m et er s espipo rt [ in] sp ec if y th e sp i p o r t . edrvsp i _ p or t 0 : sp i 0 edrvsp i _ p or t 1 : sp i 1 edrvsp i _ p or t 2 : sp i 2 edrvsp i _ p or t 3 : sp i 3 i nclu de dr iv er /dr v sp i . h ret urn va lue no n e e x a m p le /* dis ab le t h e au to m atic s lav e s elec t f u n c tio n o f sp i 0 * / dr v sp i _ dis ab leau to s s ( edr vsp i _ p or t 0 ); drvs p i_ s e t s s p ro t o t y pe v o id dr v sp i _ set s s( e _ dr vsp i _ p or t esp i p o r t , e _ dr vsp i _ sla ve _ se l esl av esel ); descript io n c o n f i g u r e t h e s la v e s elec t p i n s . i n s lav e m o d e, ex ec u ti n g th is f u n ctio n is f u n ctio n les s . p a ra m et er s pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 166 - espipo rt [ in] sp ec if y th e sp i p o r t . edrvsp i _ p or t 0 : s p i 0 edrv sp i _ p or t 1 : s p i 1 edrvsp i _ p or t 2 : s p i 2 edrvsp i _ p or t 3 : s p i 3 esla v esel [ in] i n au to m atic s la v e s elec t o p er atio n , u s e t h i s p ar a m eter to s el ec t th e s la v e s elec t p i n s w h ic h w ill b e u s ed . i n m a n u a l sla v e s elec t o p er atio n , th e s p ec i f ied s la v e s elec t p in s w i ll b e s et to ac tiv e s tate. i t c o u ld b e edrvsp i _ none , edrvsp i _ ss 0 , edrvsp i _ ss 1 o r edrvsp i _ ss 0 _ ss 1 . edrvsp i _ none : n o s la v e w a s s elec ted . edrvsp i _ ss 0 : th e s s0 w a s s elec ted . edrvsp i _ ss 1 : th e s s1 w a s s elec ted . edrvsp i _ ss 0 _ ss 1 : b o th ss 0 an d ss 1 w er e s elec ted . i ncl u de dr iv er /dr v sp i . h ret urn va lue no n e example /* dis ab le t h e au to m atic s lav e s elec t f u n c tio n o f sp i 0 * / dr v sp i _ dis ab leau to s s ( edr vsp i _ p or t 0 ); / * set t h e ss 0 p in to ac ti v e s ta te * / dr v sp i _ set s s ( edr vsp i _ p o r t 0 , edrvsp i _ ss 0 ); drvs p i_ clr s s p ro t o t y pe v o id dr v sp i _ c lr s s( e _ dr vsp i _ p or t esp i p o r t , e _ dr vsp i _ sla ve _ se l esl av esel ) ; descript io n set th e s p ec i f ied s la v e s elec t p in s to i n ac ti v e s tate. i n s lav e m o d e, ex ec u ti n g th is f u n ctio n is f u n ctio n les s . p a ra m et er s pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 167 - espipo rt [ in] sp ec if y th e sp i p o r t . edrvsp i _ p or t 0 : sp i 0 edrvsp i _ p or t 1 : sp i 1 edrvsp i _ p or t 2 : sp i 2 edrvsp i _ p or t 3 : sp i 3 esla v esel [ in] sp ec if y s la v e s elec t p i n s . edrvsp i _ none : n o s la v e w a s s elec ted . edrvsp i _ ss 0 : th e s s0 w a s s elec ted . edrvsp i _ ss 1 : th e s s1 w a s s elec ted . edrvspi_ss0_ss1 : both ss0 and ss1 were selected. i nclu de dr iv er /dr v sp i . h ret urn va lue no n e e x a m p le /* dis ab le t h e au to m atic s lav e s elec t f u n c tio n o f sp i 0 * / dr v sp i _ dis ab leau to s s ( edr vsp i _ p or t 0 ); / * set t h e ss 0 p in to i n ac ti v e s tate * / dr v sp i _ c lr s s ( edr vsp i _ p o r t 0 , edrvsp i _ ss 0 ); drvs p i_ is busy p ro t o t y pe u in t8 _ t d r v sp i _ is b u s y ( e _ dr vsp i _ p or t esp i p o r t ) ; descript io n c h ec k t h e b u s y s tat u s o f th e s p ec if ied sp i p o r t . p a ra m et er s espipo rt [ in] sp ec if y th e sp i p o r t . edrvsp i _ p or t 0 : sp i 0 edrvsp i _ p or t 1 : sp i 1 pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 168 - edrvsp i _ p or t 2 : sp i 2 edrvsp i _ p or t 3 : sp i 3 i nclu de d r iv er /dr v sp i . h ret urn va lue t ur e : t h e sp i p o r t is in b u s y . f a l se : t h e sp i p o r t is n o t in b u s y . e x a m p le / * s et t h e go_ b usy b it o f sp i 0 */ dr v sp i _ setgo ( edrvsp i _ p o r t 0 ); / * c h ec k th e b u s y s tat u s o f sp i 0 * / while( drvspi_ is busy ( edrvspi_port 0) ); drvs p i_ bur s tt ra nsfe r p ro t o t y pe in t3 2 _ t d r v sp i _ b u r s tt r an s f er ( e _ dr vsp i _ p or t esp i p o r t , in t3 2 _ t i3 2 b u r s tc n t, in t3 2 _ t i3 2 i n ter v al ) ; descript io n c o n f i g u r e t h e b u r s t tr an s f er s e ttin g s . i f i3 2 b u r s t c n t is s e t to 2 , it p er f o r m s b u r s t tr an s f er . s p i co n tr o ller w ill tr a n s f er t w o s u cc ess i v e tr an s ac tio n s . t h e s u s p en d in ter v al le n g t h b et w ee n t h e t w o tr an s ac tio n s is d eter m in ed b y t h e v al u e o f i3 2 i n ter v al . i n s lav e m o d e, t h e s etti n g o f i3 2 i n ter v al is f u n ctio n les s . p a ra m et er s espipo rt [ in] sp ec if y th e sp i p o r t . edrvsp i _ p or t 0 : sp i 0 edr vsp i _ p or t 1 : sp i 1 edrvsp i _ p or t 2 : sp i 2 edrvsp i _ p or t 3 : sp i 3 i3 2 b urs t cnt [ in] sp ec if y th e tr a n s ac tio n n u m b e r in o n e tr an s f er . i t c o u ld b e 1 o r 2 . i3 2 i nte rv a l [ in] pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 169 - su s p e n d in ter v al len g t h . sp ec i f y t h e n u m b er o f sp i clo ck c y cle b et w ee n s u cc ess iv e tr an s ac tio n s . t h e r an g e o f t h i s s ettin g v alu e i s 2 ~1 7 . i nclu de dr iv er /dr v sp i . h ret urn va lue e _ suc c e ss : s u cc es s . e _ dr vs pi _ e r r _ b ur st _ c nt : t h e b u r s t c o u n t is o u t o f r an g e. e _ dr vsp i _ e r r _ susp e nd _ i nt e r val : t h e in ter v al is o u t o f r an g e. e x a m p le /* c o n f i g u r e th e sp i 0 b u r s t tr an s f er m o d e; t w o tr an s ac tio n s in o n e tr an s f er ; 1 0 d elay clo ck s b et w ee n th e tr a n s ac tio n s . * / drvspi_bursttransfer ( edrvspi_port 0, 2, 10 ); drvs p i _ s e tc loc k fr e q p ro t o t y pe u in t3 2 _ t dr v sp i _ setc lo ck fre q ( e _ dr vsp i _ p or t esp i p o r t , u in t3 2 _ t u 3 2 c lo ck 1 , u in t3 2 _ t u 3 2 c lo ck 2 ) ; descript io n c o n f i g u r e t h e f r eq u e n c y o f sp i clo ck . i n m aster m o d e, t h e o u tp u t f r eq u e n c y o f s er ial clo ck is p r o g r am m ab le. i f t h e v ar iab le clo ck f u n c tio n is e n ab led , th e o u tp u t p atter n o f s er ial clo ck i s d ef in ed i n varc l k . i f th e b i t p atter n o f v arc l k is ? 0 ? , t h e o u tp u t f r eq u e n c y o f sp i c l k is eq u al to th e f r eq u e n c y o f v a r iab le clo ck 1 . oth er w i s e, th e o u tp u t f r eq u en c y is eq u al to th e f r eq u en c y o f v ar iab le clo ck 2 . i n s la v e m o d e, ex ec u tin g t h is f u n ct io n is f u n ct io n le s s . p a ra m et er s espipo rt [ in] sp ec if y th e sp i p o r t . edrvsp i _ p or t 0 : sp i 0 edrvsp i _ p or t 1 : sp i 1 edrvsp i _ p or t 2 : sp i 2 edrvsp i _ p or t 3 : sp i 3 u3 2 clo ck 1 [ in] pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 170 - sp ec if y th e sp i clo ck r ate in hz. i t' s t h e clo ck r ate o f sp i en g i n e clo ck a n d v ar iab le clo ck 1 . u3 2 clo ck 2 [ in] sp ec if y th e sp i clo ck r ate i n hz. i t' s t h e clo ck r ate o f v ar ia b le clo ck 2 . i nclu de dr iv er /dr v sp i . h dr iv er /dr v sys. h ret urn va lue t h e ac tu al clo ck r ate o f sp i en g i n e clo ck i s r etu r n ed . t h e a ctu al clo ck m a y d i f f er en t to t h e tar g et sp i clo ck d u e to h ar d w ar e li m itatio n . e x a m p le /* spi 0 cl ock rate of clock 1 is 2mhz ; the clock rate of clock 2 is 1mhz */ drvspi_setclock freq (edrvspi_port0, 2000000, 1000000 ); drvs p i _ ge tc loc k 1 fr e q p ro t o t y pe u in t3 2 _ t dr v sp i _ g etc lo ck 1 fre q ( e _ dr vsp i _ p or t esp i p o r t ) ; descript io n get th e sp i en g in e clo c k r ate in hz . i n s la v e m o d e, ex ec u ti n g th i s f u n ctio n i s f u n ctio n less . p a ra m et er s espipo rt [ in] sp ec if y th e sp i p o r t . edrvsp i _ p or t 0 : sp i 0 edrvsp i _ p or t 1 : sp i 1 edrvsp i _ p or t 2 : sp i 2 edrvsp i _ p or t 3 : sp i 3 i nclu de dr iv er /dr v sp i . h dr iv er /dr v sys. h ret urn va lue t h e f r eq u en c y o f sp i b u s en g i n e clo ck . t h e u n it is hz. pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 171 - e x a m p le / * get t h e en g i n e clo ck r ate o f sp i 0 * / p r in tf ( " sp i clo ck r ate: %d hz \ n " , dr v sp i _ getcl o ck 1 fre q ( edrvsp i _ p or t 0 ) ) ; drvs p i _ ge tc loc k 2 fr e q p ro t o t y pe u in t3 2 _ t dr v sp i _ g etc lo ck 2 fre q ( e _ dr vsp i _ p or t esp i p o r t ) ; descri ptio n get th e clo ck r ate o f v ar iab le clo ck 2 in hz. i n s la v e m o d e, ex ec u t in g t h is f u n ctio n is f u n ctio n les s . p a ra m et er s espipo rt [ in] sp ec if y th e sp i p o r t . edrvsp i _ p or t 0 : sp i 0 edrvsp i _ p or t 1 : sp i 1 edrvsp i _ p or t 2 : sp i 2 edrvsp i _ p or t 3 : sp i 3 i nclu de dr iv er /dr v sp i . h dr iv er /dr v sys. h ret urn va lue t h e f r eq u en c y o f v ar iab le clo c k 2 . t h e u n it is hz. e x a m p le / * get t h e clo ck r ate o f sp i 0 v ar iab le clo ck 2 * / p r in tf ( " sp i clo ck r ate o f v ar iab le clo ck 2 : %d hz \ n " , dr v sp i _ getcl o ck 2 fre q ( edr vsp i _ p or t 0 ) ) ; drvs p i_ s e tva ria bl e c loc k function p ro t o t y pe v o id dr v sp i _ setvar iab lec lo ck fu n ctio n ( e _ dr vsp i _ p or t esp i p o r t , pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 172 - u in t8 _ t b e n ab le , u in t3 2 _ t u 3 2 p atter n ) ; descript io n set th e v ar iab le clo ck f u n ctio n . t h e o u tp u t p atter n o f s er ial c lo ck is d ef i n ed in v arclk r eg is ter . a t w o - b it c o m b i n atio n in t h e var cl k d ef i n es t h e p atter n o f o n e s er ial clo ck c y c le. t h e b it f ield varc l k [ 3 1 :3 0 ] d ef in es t h e f ir s t c lo ck c y cle o f sp i c l k. t h e b it f ield varc l k [ 2 9 :2 8 ] d ef in es t h e s ec o n d clo ck c y cle o f sp i c l k an d s o o n . t h e f o llo w i n g f i g u r e is th e ti m i n g r elat io n s h ip a m o n g t h e s er ial clo c k ( sp i c l k) , th e varc l k r eg i s ter an d th e v ar iab le clo ck s o u r ce s . i f th e b it p atter n o f v arc l k is ? 0 ? , t h e o u tp u t f r eq u e n c y o f sp i c l k is eq u al to th e f r eq u en c y o f v ar iab le clo ck 1 . i f th e b it p atter n o f v arc l k is ? 1 ? , t h e o u tp u t f r eq u e n c y o f sp i c l k is eq u al to th e f r eq u en c y o f v ar iab le clo ck 2. no te th at w h e n e n ab le th e v ar i ab le clo ck f u n ctio n , th e s e tti n g o f tr an s f er b it len g th m u s t b e p r o g r am m ed as 0 x 1 0 ( 1 6 b its m o d e ) o n l y . i n s la v e m o d e, ex ec u tin g t h is f u n ct io n is f u n ct io n le s s . p a ra m et er s espipo rt [ in] sp ec if y th e sp i p o r t . edrvsp i _ p or t 0 : sp i 0 edrvsp i _ p or t 1 : sp i 1 edrvsp i _ p or t 2 : sp i 2 edrvsp i _ p or t 3 : sp i 3 be na ble [ i n] e n ab le ( t r ue ) / d is ab le ( fal se) u3 2 p a t t er n [ in] sp ec if y th e v ar iab le clo ck p att e rn . i f be na ble is s et to 0 , th is s ettin g is f u n c tio n le s s . i nclu de dr iv er /dr v sp i . h pdf create 8 trial www.nuance.com 0 0 0 0 0 0 0 0 0 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 0 0 0 0 1 1 1 s p i c l k v a r c l k v a r i a b l e c l o c k 1 v a r i a b l e c l o c k 2
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 173 - ret urn va lue no n e. e x a m p le / * e n ab le t h e sp i 0 v ar iab le clo ck f u n ct io n an d s et t h e v ar ia b le clo ck p atter n * / dr v sp i _ setvar iab lec lo ck fu n ctio n ( edrv sp i _ p or t 0 , t r ue , 0 x 0 0 7 ff f8 7 ); drvs p i_ e nabl e int p ro t o t y pe v o id dr v sp i _ e n ab lei n t( e _ dr vsp i _ p or t esp i p o r t , p fn_ dr vsp i _ c al l b ac k p f n c allb ac k , u in t3 2 _ t u 3 2 user data ) ; descript io n e n ab le th e sp i in ter r u p t o f t h e s p ec if ied sp i p o r t a n d in s tall th e ca llb ac k f u n ctio n . p a ra m et er s u1 6 p o rt [ in] sp ec if y th e sp i p o r t . edrvsp i _ p or t 0 : sp i 0 edrvsp i _ p or t 1 : sp i 1 edrvsp i _ p or t 2 : sp i 2 edrvsp i _ p or t 3 : sp i 3 pfnca llb a c k [ in] t h e ca llb ac k f u n ctio n o f th e c o r r esp o n d in g sp i in ter r u p t. u3 2 userda t a [ in] t h e p ar am eter w h ic h w il l b e p ass ed to th e ca llb ac k f u n ctio n. i nclu de dr iv er /dr v sp i . h ret urn va lue no n e e x a m p le / * e n ab le t h e sp i 0 in ter r u p t a n d in s tall t h e ca llb ac k f u n ctio n . t h e p ar am eter 0 w ill b e p ass ed to th e ca llb ac k f u n ctio n . */ dr v sp i _ e n ab lei n t( edrv sp i _ p or t 0 , sp i 0 _ c allb ac k , 0 ) ; pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 174 - drvs p i_ di s a bl e int p ro t o t y pe v o id dr v sp i _ dis ab lei n t( e _ dr vsp i _ p or t esp i p o r t ) ; descript io n dis ab le th e sp i in ter r u p t . p a ra m et er s espipo rt [ in] sp ec if y th e sp i p o r t . edrvsp i _ p or t 0 : sp i 0 edrvsp i _ p or t 1 : sp i 1 edrvsp i _ p or t 2 : sp i 2 edrvsp i _ p or t 3 : sp i 3 i nclu de dr iv er /dr v sp i . h ret urn va lu e no n e e x a m p le /* dis ab le t h e sp i 0 in ter r u p t * / dr v sp i _ dis ab lei n t ( edr vsp i _ p or t 0 ); drvs p i_ ge tint fla g p ro t o t y pe u in t3 2 _ t dr v sp i _ geti n tfl ag ( e _ dr vsp i _ p or t esp i p o r t ) ; descript io n get th e sp i in ter r u p t f lag . p a ra m et er s espipo rt [ in] sp ec if y th e sp i p o r t . edr vsp i _ p or t 0 : sp i 0 pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 175 - edrvsp i _ p or t 1 : sp i 1 edrvsp i _ p or t 2 : sp i 2 edrvsp i _ p or t 3 : sp i 3 i nclu de dr iv er /dr v sp i . h ret urn va lue 0 : th e sp i in ter r u p t d o es n o t o cc u r . 1 : th e sp i in ter r u p t o cc u r s . e x a m p le /* get the spi0 interrupt flag */ drvspi_getintflag ( edrvspi_port 0 ); drvs p i_ clr intfla g p ro t o t y pe v o id dr v sp i _ c lr i n tfl a g ( e _ dr vsp i _ p or t esp i p o r t ) ; descript io n c lear th e sp i in ter r u p t f la g . p a ra m et er s espipo rt [ in] sp ec if y th e sp i p o r t . edrvsp i _ p or t 0 : sp i 0 edrvsp i _ p or t 1 : sp i 1 edrvsp i _ p or t 2 : sp i 2 edrvsp i _ p or t 3 : sp i 3 i nclu de dr iv er /dr v sp i . h ret urn va lue no n e. e x a m p le /* c lear t h e sp i 0 in ter r u p t f la g * / dr v sp i _ c lr i n tfl a g ( edr vsp i _ p or t 0 ); pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 176 - drvs p i_ s ingle r e a d p ro t o t y pe u in t8 _ t d r v sp i _ sin g ler ea d ( e _ dr vsp i _ p or t esp i p o r t, u in t3 2 _ t * p u 3 2 data ) ; descript io n r ea d d ata f r o m sp i r x r eg is t er s an d tr ig g er sp i f o r n ex t tr a n s f er . p a ra m et er s espipo rt [ in] sp ec if y th e sp i p o r t . edrvsp i _ p or t 0 : sp i 0 edrvsp i _ p or t 1 : sp i 1 edrvsp i _ p or t 2 : sp i 2 edrvsp i _ p or t 3 : sp i 3 pu 3 2 da t a [ o ut ] a b u f f er p o in ter . t h is b u f f er i s u s ed f o r s to r in g t h e d ata g o t f r o m t h e sp i b u s . i nclu de dr iv er /dr v sp i . h ret urn va lue t r ue : t h e d ata s to r ed in p u 3 2 data is v alid . f a l se: t h e d ata s to r ed in p u 3 2 data is in v a lid . e x a m p le /* r ea d t h e p r ev io u s r etr i e v ed d ata an d tr ig g er n e x t tr a n s f er . */ u in t3 2 _ t u 3 2 destin at io n data ; dr v sp i _ sin g ler ea d ( edr vsp i _ p or t 0 , & u 3 2 destin at io n d ata) ; drvs p i_ s ingle w rite p ro t o t y pe u in t8 _ t d r v sp i _ sin g lew r ite ( e _ dr vsp i _ p or t esp i p o r t, u in t3 2 _ t * p u 3 2 data ) ; descript io n w r ite d ata to sp i t x0 r eg is ter an d tr ig g er sp i to s tar t tr an s f e r . pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 177 - p a ra m et er s espipo rt [ in ] sp ec if y th e sp i p o r t . edrvsp i _ p or t 0 : sp i 0 edrvsp i _ p or t 1 : sp i 1 edrvsp i _ p or t 2 : sp i 2 edrvsp i _ p or t 3 : sp i 3 p u3 2 d a t a [ in] a b u f f er p o in ter . t h e d ata s to r ed in th i s b u f f er w ill b e tr an s m itted t h r o u g h t h e sp i b u s . i nclu de d r iv er /dr v sp i .h ret urn va lue t r ue : t h e d ata s to r ed in p u 3 2 data h as b ee n tr an s f er r ed . f a l se: t h e sp i is in b u s y . t h e d ata s to r ed in p u 3 2 data h a s n o t b ee n tr an s f er r ed . e x a m p le /* w r ite th e d ata s to r ed in u 3 2 so u r ce data to t x b u f f er o f s p i 0 an d tr ig g er sp i to s tar t tr an s f er . * / uint32_t u32sourc edata ; drvs pi_singlewrite(edrvspi_port0, &u32sourcedata ); drvs p i _ bur s tr e a d p ro t o t y pe u in t8 _ t d r v sp i _ b u r s tr ea d ( e _ dr vsp i _ p or t esp i p o r t, u in t3 2 _ t * p u 3 2 b u f ) ; descript io n re ad t w o w o r d s o f d ata f r o m sp i r x r eg is ter s a n d th e n tr ig g er sp i f o r n ex t tr an s f er . p a ra m et er s espipo rt [ in] sp ec if y th e sp i p o r t . edrvsp i _ p or t 0 : sp i 0 edrvsp i _ p or t 1 : sp i 1 edrvsp i _ p or t 2 : sp i 2 edrvsp i _ p or t 3 : sp i 3 pu 3 2 b uf [ o ut] pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 178 - a b u f f er p o in ter . t h is b u f f er i s u s ed f o r s to r in g t h e d ata g o t f r o m t h e sp i b u s . i nclu de d r iv er /dr v sp i .h ret urn va lue t r ue : t h e d ata s to r ed in p u 3 2 b u f is v alid . f a l se: t h e d ata s to r ed in p u 3 2 b u f is in v alid . e x a m p le /* read two words of data from spi0 rx registers to au32destinationdata[u32datacount] and au32destinationdata[u32datacount +1 ] . and then trigger spi for next transfer. */ drvspi_burstread ( edrvspi_port0 , &au32destinationdata[u32datacount] ); drvs p i_ bur s tw rite p ro t o t y pe u in t8 _ t d r v sp i _ b u r s tw r ite ( e _ dr vsp i _ p or t esp i p o r t, u in t3 2 _ t * p u 3 2 b u f ) ; descript io n wr ite t w o w o r d s o f d ata to sp i t x r eg is ter s an d t h en t r i g g er sp i to s tar t a tr an s f er . p a ra m et er s espipo rt [ in] sp ec if y th e sp i p o r t . edrvsp i _ p or t 0 : sp i 0 edrvsp i _ p or t 1 : sp i 1 edrvsp i _ p or t 2 : sp i 2 edrvsp i _ p or t 3 : sp i 3 pu 3 2 b uf [ in] a b u f f er p o in ter . t h e d ata s to r ed in th i s b u f f er w ill b e tr an s m itted t h r o u g h t h e sp i b u s . i nclu de d r iv er /dr v sp i .h ret urn va lue t r ue : t h e d ata s to r ed in p u 3 2 b u f h a s b ee n tr an s f er r ed . f a l se: t h e sp i is in b u s y . t h e d ata s to r ed in p u 3 2 b u f h a s n o t b ee n tr an s f er r ed . e x a m p le pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 179 - /* w r ite t w o w o r d s o f d ata s to r ed in au 3 2 so u r ce data [ u 3 2 da tac o u n t] an d au 3 2 so u r ce data [ u 3 2 data c o u n t +1 ] to sp i 0 t x r eg is ter s . an d th e n tr ig g er sp i f o r n ex t tr an s f er . */ dr v sp i _ b u r s tw r ite ( edrvsp i _ p or t 0 , & au 3 2 so u r ce data [ u 3 2 data c o u n t] ); drvs p i_ dump rxre g i s ter p ro t o t y pe u in t3 2 _ t dr v sp i _ du m p r x r e g is ter ( e _ dr vsp i _ p or t esp i p o r t, u in t3 2 _ t * p u 3 2 b u f , u in t3 2 _ t u 3 2 data c o u n t ) ; descript io n r ea d d ata f r o m r x r e g is ter s . t h is f u n ctio n w ill n o t tr ig g er a sp i d ata tr an s f er . p a ra m et er s espipo rt [ in] sp ec if y th e sp i p o r t . edrvsp i _ p or t 0 : sp i 0 edrvsp i _ p or t 1 : sp i 1 edrvsp i _ p or t 2 : sp i 2 edrvsp i _ p or t 3 : sp i 3 pu 3 2 b uf [ o ut] a b u f f er p o in ter . t h is b u f f er i s u s ed f o r s to r in g t h e d ata g o t f r o m t h e sp i r x r eg is ter s . u3 2 da t a co un t [ in] t h e co u n t o f d ata r ea d f r o m r x r eg is ter s . t h e m a x i m u m n u m b er i s 2 . i nclu de d r iv er /dr v sp i .h ret urn va lue t h e co u n t o f d ata ac tu all y r ea d f r o m r x r eg is ter s . e x a m p le /* r ea d o n e w o r d o f d ata f r o m sp i 0 r x b u f f er an d s to r e to au 3 2 desti n atio n da ta[ u 3 2 data c o u n t] */ dr v sp i _ du m p r x r e g is ter ( ed r vsp i _ p or t 0 , & au 3 2 desti n atio n data [ u 3 2 data c o u n t] , 1 ) ; drvs p i_ s e tt x regi s te r p ro t o t y pe pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 180 - u in t3 2 _ t dr v sp i _ sett x r eg i s ter ( e _ dr vsp i _ p or t esp i p o r t, u in t3 2 _ t * p u 3 2 b u f , u in t3 2 _ t u 3 2 data c o u n t ) ; descript io n w r ite d ata to t x r eg is ter s . t h is f u n ctio n w il l n o t tr i g g er a spi d ata t r an s f er . p a ra m et er s espipo rt [ in] sp ec if y th e sp i p o r t . edrvsp i _ p or t 0 : sp i 0 edrv sp i _ p or t 1 : sp i 1 edrvsp i _ p or t 2 : sp i 2 edrvsp i _ p or t 3 : sp i 3 pu 3 2 b uf [ in] a b u f f er s to r e s t h e d ata w h ic h w ill b e w r itte n to t x r eg is ter s . u3 2 da t a co un t [ in] t h e co u n t o f d ata w r i t t e n to t x r eg is ter s . i nclu de d r iv er /dr v sp i .h ret urn va lue t h e co u n t o f d ata ac tuall y w r i tten to sp i t x r eg is ter s . e x a m p le /* w r ite o n e w o r d o f d ata s to r ed in u 3 2 b u f f er to sp i 0 t x r e g is ter . * / dr v sp i _ sett x r eg i s ter ( edrv sp i _ p or t 0 , & u 3 2 b u f f er , 1 ) ; drvs p i _ s e tgo p ro t o t y pe v o id dr v sp i _ setgo ( e _ dr vsp i _ p or t esp i p o r t ) ; descript io n i n m a s ter m o d e, ca ll th i s f u n ct io n ca n s tar t a sp i d ata tr a n s f e r . i n s lav e m o d e, ex ec u ti n g th i s f u n ctio n m ea n s t h at t h e s la v e i s r ea d y to co m m u n icate w it h a m aster . p a ra m et er s pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 181 - espipo rt [ in] sp ec if y th e sp i p o r t . edrvsp i _ p or t 0 : sp i 0 edrvsp i _ p or t 1 : sp i 1 edrvsp i _ p or t 2 : sp i 2 edrvsp i _ p or t 3 : sp i 3 i nclu de d r iv er /dr v sp i .h ret urn va lue no n e e x a m p le /* trigger a spi data transfer */ drvspi_setgo ( edrvspi_port0 ); drvs p i_ clr go p ro t o t y pe v o id dr v sp i _ c lr go ( e _ dr vsp i _ p or t esp i p o r t ); descript io n sto p a sp i d ata tr asf er . p a ra m e t er s espipo rt [ in] sp ec if y th e sp i p o r t . edrvsp i _ p or t 0 : sp i 0 edrvsp i _ p or t 1 : sp i 1 edrvsp i _ p or t 2 : sp i 2 edrvsp i _ p or t 3 : sp i 3 i nclu de d r iv er /dr v sp i .h ret urn va lue no n e e x a m p le /* sto p a sp i d ata tr an s f er */ pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 182 - dr v sp i _ c lr go ( edrvsp i _ p o r t 0 ); drvs p i _ s e tpdm a p ro t o t y pe v o id dr v sp i _ setp dm a ( e _ dr vsp i _ p or t esp i p o r t, e _ dr vsp i _ dm a _ mo de e d m am o d e, u in t8 _ t b e n ab le ) ; descript io n c o n f i g u r e t h e dm a s ett in g s . p a ra m et er s espipo rt [ in] sp ec if y th e sp i p o r t . edrvsp i _ p or t 0 : sp i 0 edrvsp i _ p or t 1 : sp i 1 edrvsp i _ p or t 2 : sp i 2 edrvsp i _ p or t 3 : sp i 3 ed m a m o de [ in] sp ec if y th e dm a m o d e. edrvsp i _ t x_ dm a : dm a - t r an s m itti n g edrvsp i _ r x_ dm a : dm a - r ec eiv in g een a ble [ in] t r u e: e n ab le dm a . fals e: di s ab le dm a . i nclu de dr iv er /dr v sp i . h ret urn va lue no n e e x a m p le /* e n ab le t h e sp i 0 dm a - r ec eiv i n g f u n ct io n */ dr v sp i _ s e tp dm a ( ed r vsp i _ p or t 0 , edrvsp i _ r x_ dm a , t r ue ) ; pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 183 - drvs p i_ s e t fifomod e p ro t o t y pe v o id dr v sp i _ set fifom o d e ( e _ dr vsp i _ p or t esp i p o r t , u in t8 _ t b e n ab le , in t3 2 _ t i3 2 i n ter v al ) ; descript io n e n ab le/d is ab le fifo m o d e. i f th e ca ller en ab les fifo m o d e, ch ec k t h e s ett in g o f s u s p e n d in ter v a l . on l y t h e ch ip s w i th t h e p ar t n u m b er nuc1 x 0 x x x c x , ex : n u c 1 4 0 ve 3 c n, ca n s u p p o r t th is f u n ctio n . p a ra m et er s espipo rt [ in] sp ec if y th e sp i p o r t . edrvsp i _ p or t 0 : sp i 0 edrvsp i _ p or t 1 : sp i 1 edrvsp i _ p or t 2 : sp i 2 edrvsp i _ p or t 3 : sp i 3 be na ble [ i n] e n ab le ( t r ue ) / d is ab le ( fal se) i3 2 i nte rv a l [ in] i n fifo m o d e, it c o u ld b e 2 ~1 5 an d 0 . 0 in d icate s th e m a x i m u m s u s p en d i n ter v al; 2 in d icate s t h e m in i m u m s u s p e n d in ter v al. p lease r ef er to nu c 1 x x t r m f o r th e ac tu al s u s p en d in ter v al. i nclu de dr i v er /dr v sp i . h ret urn va lue no n e. e x a m p le / * e n ab le t h e sp i 0 fifo m o d e * / dr v sp i _ set fifom o d e( edrv sp i _ p or t 0 , t r ue , 0 ); drvs p i_ is rxe mpty p ro t o t y pe pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 184 - u in t8 _ t d r v sp i _ is r x e m p t y ( e _ dr vsp i _ p or t esp i p o r t ) ; descript io n c h ec k t h e s tat u s o f t h e r x b u f f er o f th e s p ec if i ed sp i p o r t. on l y th e c h ip s w it h t h e p ar t n u m b er nuc1 x 0 x x x c x , ex : n uc 1 4 0 ve 3 c n, ca n s u p p o r t th is f u n ctio n . p a ra m et er s espipo rt [ in] sp ec if y th e sp i p o r t . edrvsp i _ p or t 0 : sp i 0 edrvsp i _ p or t 1 : sp i 1 edrvsp i _ p or t 2 : sp i 2 edrvsp i _ p or t 3 : sp i 3 i nclu de dr iv er /dr v s p i . h ret urn va lue t ur e : r x b u f f er is e m p t y . f a l se : r x b u f f er is n o t e m p t y . e x a m p le / * e n ab le t h e sp i 0 fifo m o d e * / dr v sp i _ set fifom o d e( edrv sp i _ p or t 0 , t r ue , 0 ); / * c h ec k th e s tatu s o f sp i 0 r x b u f f er * / w h ile( dr v sp i _ i s r x e m p t y ( e dr vsp i _ p or t 0 ) ) { } drvs p i_ is rxfull p ro t o t y pe u in t8 _ t d r v sp i _ is r x fu ll ( e _ dr vsp i _ p or t esp i p o r t ) ; descript io n pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 185 - c h ec k t h e s tat u s o f t h e r x b u f f er o f th e s p ec if ied sp i p o r t. on l y th e c h ip s w it h t h e p ar t n u m b er nuc1 x 0 x x x c x , ex : n uc 1 4 0 ve 3 c n, ca n s u p p o r t th is f u n ctio n . p a ra m et er s espipo rt [ in] sp ec if y th e sp i p o r t . edrvsp i _ p or t 0 : sp i 0 edrvsp i _ p or t 1 : sp i 1 edrvsp i _ p or t 2 : sp i 2 edrvsp i _ p or t 3 : sp i 3 i nclu de dr iv er /dr v sp i . h ret urn va lue t ur e : r x b u f f er is f u ll . f a l se : r x b u f f er is n o t f u ll . e x a m p le / * e n ab le t h e sp i 0 fifo m o d e * / dr v sp i _ set fifo mo d e( edrv sp i _ p or t 0 , t r ue , 0 ); / * c h ec k th e s tatu s o f sp i 0 r x b u f f er * / while( drvspi_ isrxfull ( edrvspi_port 0) ) { } drvs p i_ is t x e mpty p ro t o t y pe u in t8 _ t d r v sp i _ is t x e m p t y ( e _ dr vsp i _ p or t esp i p o r t ) ; descript io n c h ec k t h e s tat u s o f t h e t x b u f f er o f th e s p ec if ied sp i p o r t. on l y th e c h ip s w it h t h e p ar t n u m b er nuc1 x 0 x x x c x , ex : n uc 1 4 0 ve 3 c n, ca n s u p p o r t th is f u n ctio n . p a ra m et er s espipo rt [ in] sp ec if y th e sp i p o r t . pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 186 - edrvsp i _ p or t 0 : sp i 0 edrvsp i _ p or t 1 : sp i 1 edrvsp i _ p or t 2 : sp i 2 edrvsp i _ p or t 3 : sp i 3 i nclu de dr iv er /dr v sp i . h ret urn va lue t ur e : t x b u f f er is e m p t y . f a l se : t x b u f f er is n o t e m p t y . e x a m p le / * e n ab le t h e sp i 0 fifo m o d e * / dr v sp i _ set fifom o d e( edrv sp i _ p or t 0 , t r ue , 0 ); / * c h ec k th e s tatu s o f sp i 0 t x b u f f er * / w h ile( dr v sp i _ i s t x e m p t y ( e dr vsp i _ p or t 0 ) ) { } drvs p i_ i s txful l p ro t o t y pe u in t8 _ t d r v sp i _ is t x fu ll ( e _ dr vsp i _ p or t esp i p o r t ) ; descript io n c h ec k t h e s tat u s o f t h e t x b u f f er o f th e s p ec if ied sp i p o r t. on l y th e c h ip s w it h t h e p ar t n u m b er nuc1 x 0 x x x c x , ex : n uc 1 4 0 ve 3 c n, ca n s u p p o r t th is f u n ctio n . p a ra m et er s espipo rt [ in] sp ec if y th e sp i p o r t . edrvsp i _ p or t 0 : sp i 0 edrvsp i _ p or t 1 : sp i 1 edrvsp i _ p or t 2 : sp i 2 edrvsp i _ p or t 3 : sp i 3 i nclu de pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 187 - dr iv er /dr v sp i . h ret urn va lue t ur e : t x b u f f er is f u l l . f a l se : t x b u f f er is n o t f u ll . e x a m p le / * e n ab le t h e sp i 0 fifo m o d e * / dr v sp i _ set fif om o d e( edrv sp i _ p or t 0 , t r ue , 0 ); / * c h ec k th e s tatu s o f sp i 0 t x b u f f er * / w h ile( dr v sp i _ i s t x fu ll ( edr vsp i _ p or t 0 ) ) { } drvs p i_ clrr x fifo p ro t o t y pe v o id dr v sp i _ c lr r x fifo ( e _ dr vsp i _ p or t esp i p o r t ) ; descript io n c lear th e r x fi fo. on l y th e c h ip s w it h t h e p ar t n u m b er nu c 1 x 0 x x x c x , ex : n uc 1 4 0 ve 3 c n, ca n s u p p o r t th is f u n ctio n . p a ra m et er s espipo rt [ in] sp ec if y th e sp i p o r t . edrvsp i _ p or t 0 : sp i 0 edrvsp i _ p or t 1 : sp i 1 edrvsp i _ p or t 2 : sp i 2 edrvsp i _ p or t 3 : sp i 3 i nclu de d r iv er /dr v sp i .h ret urn va lue no n e e x a m p le /* c lear t h e r x fifo. o f sp i 0 * / pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 188 - dr v sp i _ c lr r x fifo ( edr vs p i _ p or t 0 ); drvs p i_ clrt x fifo p ro t o t y pe v o id dr v sp i _ c lr t x fifo ( e _ dr vsp i _ p or t esp i p o r t ) ; descript io n c lear th e t x fifo. on l y th e c h ip s w it h t h e p ar t n u m b er nu c 1 x 0 x x x c x , ex : n uc 1 4 0 ve 3 c n, ca n s u p p o r t th is f u n ctio n . p a ra m et er s espipo rt [ in] sp ec if y th e sp i p o r t . edrvsp i _ p or t 0 : sp i 0 edrvsp i _ p or t 1 : sp i 1 edrvsp i _ p or t 2 : sp i 2 edrvsp i _ p or t 3 : sp i 3 i nclu de d r iv er /dr v sp i .h ret urn va lue no n e e x a m p le /* c lear t h e t x fifo. o f sp i 0 * / dr v sp i _ c lr t x fifo ( edrvs p i _ p or t 0 ); drvs p i_ e nabl e div on e p ro t o t y pe v o id dr v sp i _ e n ab lediv o n e ( e _ dr vsp i _ p or t esp i p o r t ) ; descript io n e n ab le th e di v_ one f ea tu r e. t h e sp i cl o ck r ate w ill b e eq u al to s y s te m clo ck r ate. on l y th e ch ip s w it h t h e p ar t n u m b er nuc1 x 0 x x x c x , ex : n uc 1 4 0 v e 3 c n, ca n s u p p o r t th is f u n cti o n . p a ra m et er s espipo rt [ in] pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 189 - sp ec if y th e sp i p o r t . edrvsp i _ p or t 0 : sp i 0 edrvsp i _ p or t 1 : sp i 1 edrvsp i _ p or t 2 : sp i 2 edrvsp i _ p or t 3 : sp i 3 i nclu de d r iv er /dr v sp i .h ret urn va lue no n e e x a m p le /* enable the div_one feature . of spi0 */ drvspi_ enabledivone ( edrvs pi_port0 ); drvs p i_ di s a bl e div o ne p ro t o t y pe v o id dr v sp i _ dis ab lediv on e ( e _ dr vsp i _ p or t esp i p o r t ) ; descript io n dis ab le th e di v_ one f ea t u r e. on l y t h e ch ip s w it h th e p ar t n u m b er nuc1 x 0 x x x c x , ex : nuc1 4 0 ve 3 c n, ca n s u p p o r t th is f u n ct io n . p a ra m et er s espipo rt [ in] sp ec if y th e sp i p o r t . edrvsp i _ p or t 0 : sp i 0 edrvsp i _ p or t 1 : sp i 1 edrvsp i _ p or t 2 : sp i 2 edrvsp i _ p or t 3 : sp i 3 i nclu de d r iv er /dr v sp i .h ret urn va lue no n e e x a m p le /* dis ab le t h e di v_ one f ea t u r e . o f sp i 0 * / pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 190 - dr v sp i _ dis ab lediv on e ( ed r vsp i _ p or t 0 ); drvs p i_ e nabl e 3 w ire p ro t o t y pe v o id dr v sp i _ e n ab le 3 w ir e ( e _ dr vsp i _ p or t esp i p o r t ) ; descript io n e n ab le th e sp i 3 - w ir e f u n ctio n . i n m a s ter m o d e, ex ec u ti n g t h is f u n ctio n is u n m ea n i n g f u l. on l y th e c h ip s w it h t h e p ar t n u m b er nu c 1 x 0 x x x c x , ex : n uc 1 4 0 ve 3 c n, ca n s u p p o r t th is f u n ctio n . p a ra m et er s espipo rt [ in] sp ec if y th e sp i p o r t . edrvsp i _ p or t 0 : sp i 0 edrvsp i _ p or t 1 : sp i 1 edrvsp i _ p or t 2 : sp i 2 edrvsp i _ p or t 3 : sp i 3 i nclu de d r iv er /dr v sp i .h ret urn va lue no n e e x a m p le /* e n ab le t h e 3 - w ir e sp i f u n ct io n . o f sp i 0 * / dr v sp i _ e n ab le3 w ir e ( edrvsp i _ p o r t 0 ); drvs p i_ di s a bl e 3 w ire p ro t o t y pe v o id dr v sp i _ dis ab le 3 w ir e ( e _ dr vsp i _ p or t esp i p o r t ); descript io n dis ab le th e sp i 3 - w ir e f u n ctio n . on l y t h e ch ip s w i th t h e p ar t n u m b er nuc1 x 0 x x x c x , e x : nuc1 4 0 ve 3 c n, ca n s u p p o r t th is f u n ct io n . p a ra m et er s espipo rt [ in] pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 191 - sp e cif y th e sp i p o r t . edrvsp i _ p or t 0 : sp i 0 edrvsp i _ p or t 1 : sp i 1 edrvsp i _ p or t 2 : sp i 2 edrvsp i _ p or t 3 : sp i 3 i nclu de d r iv er /dr v sp i .h ret urn va lue no n e e x a m p le /* dis able the 3 - wire spi function . of spi0 */ drvspi_disable 3wire ( edrvspi_port0 ); drvs p i_ 3 w ire abo rt pr o t o t y pe v o id dr v sp i _ 3 w ir ea b o r t ( e _ dr vsp i _ p or t esp i p o r t ); descript io n a b o r t tr an s f er w h e n u s i n g 3 - wir e sp i . i f u s in g 3 - w ir e sp i as s lav e, w h en s la v e s tar t in ter r u p t s tatu s is s et b u t tr an s f er d o n e f lag d o esn ' t b e s et o v er a r ea s o n ab le ti m e, u s e t h is f u n c tio n t o ab o r t th is tr an s f er . on l y t h e ch ip s w i th t h e p ar t n u m b er nu c 1 x 0 x x x c x , e x : n u c 1 4 0 ve 3 c n, ca n s u p p o r t th is f u n ctio n . p a ra m et er s espipo rt [ in] sp ec if y th e sp i p o r t . edrvsp i _ p or t 0 : sp i 0 edrvsp i _ p or t 1 : sp i 1 edrvsp i _ p or t 2 : sp i 2 edrvsp i _ p or t 3 : sp i 3 i nc lu de d r iv er /dr v sp i .h ret urn va lue no n e e x a m p le pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 192 - /* a b o r t cu r r en t tr an s f er . o f sp i 0 * / dr v sp i _ 3 w ir ea b o r t ( edrvsp i _ p or t 0 ); drvs p i_ e nabl e 3 w ire s tartint p ro t o t y pe v o id dr v sp i _ e n ab le3 w ir estar ti n t ( e _ dr vsp i _ p or t esp i p o r t , p fn_ dr vsp i _ c al l b ac k p f n c allb ac k , u in t3 2 _ t u 3 2 user data ) ; descript io n e n ab le th e 3 - w ir e sp i s tar t in t er r u p t o f th e s p ec if ied sp i p o r t an d in s tal l th e ca llb ac k f u n ct io n . on l y th e c h ip s w it h t h e p ar t n u m b er nu c 1 x 0 x x x c x , ex : n uc 1 4 0 ve 3 c n, ca n s u p p o r t th is f u n ctio n . p a ra m et er s u1 6 p o rt [ in] sp ec if y t h e sp i p o r t . edrvsp i _ p or t 0 : sp i 0 edrvsp i _ p or t 1 : sp i 1 edrvsp i _ p or t 2 : sp i 2 edrvsp i _ p or t 3 : sp i 3 pfnca llb a c k [ in] t h e ca llb ac k f u n ctio n o f th e c o r r esp o n d in g sp i in ter r u p t. u3 2 userda t a [ in] t h e p ar am eter w h ic h w il l b e p ass ed to th e ca llb ac k f u n ctio n . i nclu d e dr iv er /dr v sp i . h ret urn va lue no n e e x a m p le / * e n ab le t h e 3 - w ir e sp i 0 s tar t in ter r u p t a n d i n s ta ll th e ca llb ac k f u n ctio n . t h e p ar a m eter 0 w il l b e p ass ed to th e ca llb ac k f u n ctio n . */ dr v sp i _ e n ab le3 w ir estar ti n t ( edrvsp i _ p or t 0 , sp i 0 _ c allb ac k , 0 ) ; pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 193 - drvs p i_ di s a bl e 3 w ire s tartint p ro t o t y pe v o id dr v sp i _ dis ab le3 w ir estar ti n t ( e _ dr vsp i _ p or t esp i p o r t ) ; descript io n dis ab le th e 3 - w ir e sp i s tar t in ter r u p t. on l y t h e c h ip s w it h t h e p ar t n u m b er nu c 1 x 0 x x x c x , ex : n u c 1 4 0 ve 3 c n, ca n s u p p o r t th is f u n c tio n . p a ra m et er s espipo rt [ in] sp ec if y th e sp i p o r t . edrvsp i _ p or t 0 : sp i 0 edrvsp i _ p or t 1 : sp i 1 edrvsp i _ p or t 2 : sp i 2 edrvsp i _ p or t 3 : sp i 3 i nclu de dr iv er /dr v sp i . h ret urn va lue no n e e x a m p le /* dis ab le t h e 3 - w ir e sp i 0 s ta r t in ter r u p t * / dr v sp i _ dis ab le3 w ir estar ti n t ( edrvsp i _ p or t 0 ); drvs p i_ g e t3w ire s tar tint fla g p ro t o t y pe u in t3 2 _ t dr v sp i _ get3 w ir est ar ti n tfl a g ( e _ dr vsp i _ p or t esp i p o r t ) ; descript io n get th e 3 - w ir e sp i s tar t in ter r u p t stat u s . o n l y th e c h ip s w it h th e p ar t n u m b er nuc1 x 0 x x x c x , ex : n u c 1 4 0 ve 3 c n, ca n s u p p o r t th is f u n c tio n . p a ra m et er s e sp ipo rt [ in] sp ec if y th e sp i p o r t . pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 194 - edrvsp i _ p or t 0 : sp i 0 edrvsp i _ p or t 1 : sp i 1 edrvsp i _ p or t 2 : sp i 2 edrvsp i _ p or t 3 : sp i 3 i nclu de dr iv er /dr v sp i . h ret urn va lue 0 : th e sp i s tar t in ter r u p t d o esn ' t o cc u r . 1 : th e sp i s tar t in ter r u p t o cc u r s . e x a m p le /* get the 3 - wi re spi0 start interrupt flag */ drvspi_ get3wirestartintflag ( edrvspi_port0 ); drvs p i_ clr 3 w ire s t a rtint fla g p ro t o t y pe v o id dr v sp i _ c lr 3 w ir estar ti n tfl ag ( e _ dr vsp i _ p or t esp i p o r t ) ; descript io n c lear th e 3 - w ir e sp i s tar t in ter r u p t statu s . on l y t h e ch ip s w it h th e p ar t n u m b er nuc1 x 0 x x x c x , e x : n u c 1 4 0 ve 3 c n, ca n s u p p o r t th is f u n c tio n . p a ra m et er s espipo rt [ in] sp ec if y th e sp i p o r t . edrvsp i _ p or t 0 : sp i 0 edrvsp i _ p or t 1 : sp i 1 edrvsp i _ p or t 2 : sp i 2 edrvsp i _ p or t 3 : sp i 3 i nclu de dr iv er /dr v sp i . h ret urn va lue no n e. e x a m p le pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 195 - /* c lear t h e 3 - w ir e sp i 0 s tar t in ter r u p t f lag * / dr v sp i _ c lr 3 w ir estar ti n tfl a g ( edrvsp i _ p or t 0 ); drv spi _ ge tve r s ion p ro t o t y pe u in t3 2 _ t dr v sp i _ getve r s io n ( v o id ); descript io n get th e v er s io n n u m b er o f sp i d r iv er . i nclu de dr iv er /dr v sp i . h return value version number : 31:24 23:16 15:8 7:0 00000000 major_num minor_num build_num e x a m p le p r in tf ( " dr iv er v er s io n : % x \ n " , dr v sp i _ getve r s io n ( ) ) ; pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 196 - 8. i2 c driver 8.1. i2c introduction i 2 c is b i - d ir ec tio n al s er ia l b u s w it h t w o w ir es t h at p r o v id es a s i m p le a n d ef f icie n t m et h o d o f d ata ex c h a n g e b et w ee n d ev ices. t h e i 2 c s ta n d ar d is a tr u e m u lt i - m a s ter b u s in clu d i n g co llis io n d etec tio n an d ar b itra tio n th at p r ev e n ts d ata co r r u p tio n i f t w o o r m o r e m aster s atte m p t to co n tr o l th e b u s s i m u lta n eo u s l y . ser ial, 8 - b it o r ien ted b i - d ir ec tio n al d ata tr an s f er s ca n b e m ad e u p 1 . 0 mb p s . fo r nu mic r o ? nuc1 0 0 ser ies, i 2 c d ev i ce co u ld ac t a s m a s ter o r s lav e an d i 2 c d r iv er ca n h elp u s er to u s e i 2 c f u n ctio n s ea s i l y . 8.2. i2c fea tu re t h e i 2 c in clu d es f o llo w in g f e atu r es: ? su p p o r t m aster an d s lav e m o d e u p to 1 mb p s . ? b u ilt - in a 1 4 - b it ti m e - o u t c o u n ter w ill r eq u e s t t h e i 2 c in ter r u p t if th e i 2 c b u s h a n g s u p a n d ti m e - o u t c o u n ter o v er f lo w s . ? su p p o r t 7 - b it a d d r ess in g m o d e. ? support multiple address recognition. (four slave address with mask option) 8.3. t y pe defi nit i on e_i2c_port enumeration identifier value description i2c_po rt0 0 i2c port 0 i2c_port 1 1 i2c port 1 e_i2c_callback_type enumeration identifier value description i2cfunc 0 for i2c normal cond i tion arbitloss 1 for arbitration loss condition when i2c operates as master mode. buserror 2 for i2c bus error cond i tion timeout 3 for i2c 14 - bit time - out counter time out pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 197 - 8.4. fu n ctio ns drvi 2 c _ ope n p ro t o t y pe in t3 2 _ t dr v i 2 c _ op en (e _ i 2 c _ p or t p o r t, u in t3 2 _ t u 3 2 b u s c lo ck ); descript io n t o o p en th e i 2 c h ar d w ar e an d co n f i g u r e t h e i 2 c b u s clo c k . t h e m a x i m u m o f i 2 c b u s clo c k is 1 mh z . p a ra m et er po rt [ in] sp ec if y i 2 c i n ter f ac e. ( i 2 c _ por t 0 / i 2 c _ p or t 1) u3 2 b us clo ck [ i n] to co n f ig u r e i 2 c b u s clo ck . t h e u n it i s hz. i nclu de dr iv er /dr v i 2 c . h ret urn va lue 0 su cc ee d e x a m p le / * e n ab le i 2 c 0 an d s et i 2 c 0 b u s clo ck 1 0 0 khz */ dr v i 2 c _ op en ( i 2 c _ p or t 0 , 1 0 0 0 0 0 ) ; drvi 2 c_ clos e p ro t o t y pe in t3 2 _ t dr v i 2 c _ c lo s e ( e _ i 2 c _ p or t p o r t) ; descript io n t o clo s e th e i 2 c h ar d w ar e. p a ra m et er po rt [ in] sp ec if y i 2 c i n ter f ac e. ( i 2 c _ por t 0 / i 2 c _ p or t 1) i nclu de pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 198 - dr iv er /dr v i 2 c . h ret urn va lue 0 su cc ee d e x a m p le dr v i 2 c _ c lo s e (i 2 c _ p or t 0 ) ; / * dis ab le i 2 c 0 * / drvi 2 c _ s e tc loc k fre q p ro t o t y pe in t3 2 _ t dr v i 2 c _ setc lo ck fre q ( e _ i 2 c _ p or t p o r t, u in t3 2 _ t u 3 2 b u s c lo ck ) ; descript io n t o co n f ig u r e th e i 2 c b u s clo ck . i 2 c b u s clo ck = i 2 c s o u r ce clo ck / ( 4 x ( i 2 c c l k _ di v +1 )) . t h e m a x i m u m o f i 2 c b u s cl o c k is 1 mh z . p a ra m et er po rt [ in] sp ec if y i 2 c i n ter f ac e. ( i 2 c _ por t 0 / i 2 c _ p or t 1) u3 2 b us clo ck [ i n] to co n f ig u r e i 2 c b u s clo ck . t h e u n it i s hz. i nclu de dr iv er /dr v i 2 c . h ret urn va lue 0 su cc ee d e x a m p le / * set i 2 c 0 b u s clo c k 2 0 0 khz */ dr v i 2 c _ setc lo ck fre q ( i 2 c _ por t 0 , 2 0 0 0 0 0 ); drvi 2 c _ g e tc loc k fre q p ro t o t y pe u in t3 2 _ t dr v i 2 c _ getcl o ck fre q ( e _ i 2 c _ p or t p o r t ) ; descript io n t o g et th e i 2 c b u s clo c k . i 2 c b u s clo ck = i 2 c s o u r ce clo ck / ( 4 x ( i 2 c c lk _ di v +1 )) p a ra m et er po rt [ in] pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 199 - sp ec if y i 2 c i n ter f ac e. ( i 2 c _ por t 0 / i 2 c _ p or t 1 ) i nclu de dr iv er /dr v i 2 c . h ret urn va lue i 2 c b u s clo ck e x a m p le u in t3 2 _ t u 3 2 clo ck ; u 3 2 clo ck = dr v i 2 c _ getc lo ck fre q ( i 2 c _ p or t 0 ) ; /* get i 2 c 0 b u s clo ck * / drvi 2 c _ s e ta ddre s s p ro t o t y pe in t3 2 _ t dr v i 2 c _ seta d d r es s ( e _ i 2 c _ p or t p o r t, u in t8 _ t slav eno , u in t8 _ t sla v e _ ad d r , u in t8 _ t g c _ fla g ) ; descript io n t o s et 7 - b it p h y s ical s la v e ad d r ess to th e s p ec i f ied i 2 c s lav e ad d r ess . fo u r s lav e ad d r ess es s u p p o r ted . t h e s ettin g ta k es e f f ec t w h en i 2 c o p er ates a s s la v e m o d e . p a ra m et er po rt [ in] sp ec if y i 2 c i n ter f ac e. ( i 2 c _ por t 0 / i 2 c _ p or t 1) s la v eno [ in] to s elec t slav e ad d r ess . t h e s l av eno is 0 ~ 3 . s la v e_ a dd r [ in] to s et 7 - b it p h y s ical s la v e ad d r ess f o r s elec ted s la v e ad d r ess . g c_ f la g [ in] to en ab le o r d is ab le g en er al ca ll f u n ct io n . (1 : e n ab le , 0 : d is ab le ) i nclu de dr iv er /dr v i 2 c . h ret urn va lue 0 : su cc ee d <0 : failed e x a m p le dr v i 2 c _ set a d d r ess ( i 2 c _ p or t 0 , 0 , 0 x 1 5 , 0 ) ; /* se t i 2 c 0 1 s t slav e ad d r ess 0 x 1 5 * / dr v i 2 c _ set a d d r ess ( i 2 c _ p or t 0 , 1 , 0 x 3 5 , 0 ); /* se t i 2 c 0 2 n d s lav e ad d r ess 0 x 3 5 * / dr v i 2 c _ set a d d r ess ( i 2 c _ p or t 0 , 2 , 0 x 5 5 , 0 ); /* se t i 2 c 0 3 r d s lav e ad d r ess 0 x 5 5 * / dr v i 2 c _ set a d d r ess ( i 2 c _ p or t 0 , 3 , 0 x 7 5 , 0 ); /* se t i 2 c 0 4 th s lav e ad d r ess 0 x 7 5 * / pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 200 - drvi 2 c _ s e ta ddre s s m a s k p ro t o t y pe in t3 2 _ t dr v i 2 c _ seta d d r es s ma s k ( e _ i 2 c _ p or t p o r t, u in t8 _ t slav e no , u in t8 _ t s lav e a d d r ma s k ) ; descript io n t o s et 7 - b it p h y s ical s la v e ad d r ess m a s k to t h e s p ec if ied i 2 c s alv e ad d r ess m as k. fo u r s la v e ad d r ess m as k s s u p p o r ted . t h e s etti n g ta k es e f f ec t w h e n i 2 c o p er ates a s s lav e m o d e . p a ra m et er po rt [ in] sp ec if y i 2 c i n ter f ac e. ( i 2 c _ por t 0 / i 2 c _ p or t 1) s la v eno [ in] to s elec t s lav e ad d r ess m as k . t h e v alu e is 0 ~ 3 . s la v eaddrm a s k [ in] to s et 7 - b it p h y s ical s la v e ad d r ess m a s k f o r s elec ted s la v e ad d r ess m as k . t h e co r r esp o n d in g ad d r ess b it is do n ? t c ar e . i nclu de dr iv er /dr v i 2 c . h ret urn va lue 0 : su cc ee d <0 : failed e x a m p le dr v i 2 c _ s et a d d r ess ( i 2 c _ p or t 0 , 0 , 0 x 1 5 , 0 ) ; /* set i 2 c 0 1 s t slav e ad d r ess 0 x 1 5 * / dr v i 2 c _ set a d d r ess ( i 2 c _ p or t 0 , 1 , 0 x 3 5 , 0 ); /* set i 2 c 0 2 n d s lav e ad d r ess 0 x 3 5 * / / * set i 2 c 0 1 s t s la v e ad d r ess m as k 0 x 0 1 , s lav e ad d r ess 0 x 1 5 an d 0 x 1 4 w o u ld b e ad d r ess ed * / dr v i 2 c _ set a d d r ess ma s k ( i 2 c _ p or t 0 , 0 , 0 x 01 ); / * set i 2 c 0 2 n d s la v e ad d r ess m as k 0 x 0 4 , s lav e ad d r ess 0 x 3 5 an d 0 x 3 1 w o u ld b e ad d r ess ed * / dr v i 2 c _ set a d d r ess ma s k ( i 2 c _ p or t 0 , 1 , 0 x 04 ); drvi 2 c_g e tstatu s p ro t o t y pe u in t3 2 _ t d r v i 2 c _ getstat u s ( e _ i 2 c _ p or t p o r t) ; descript io n t o g et th e i 2 c s tat u s co d e . t h er e ar e 2 6 s tatu s co d es . p lease r ef er to data t r an s f er flo w i n i 2 c sectio n o f t r m in d etail s . pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 201 - p a ra m et er po rt [ in] sp ec if y i 2 c i n ter f ac e. ( i 2 c _ por t 0 / i 2 c _ p or t 1) i nclu de dr iv er /dr v i 2 c . h ret urn va lue i 2 c s tatu s co d e e x a m p le ui n t3 2 _ t u 3 2 s tatu s ; u 3 2 s tatu s = dr v i 2 c _ gets tatu s ( i 2 c _ p or t 0 ); /* get i 2 c 0 cu r r en t sta tu s co d e * / drvi 2 c_writeda ta p ro t o t y pe v o id dr v i 2 c _ w r itedata ( e _ i 2 c _ p or t p o r t, u in t8 _ t u 8 d ata) ; descript io n t o s et a b y te o f d ata to b e s en t . p a ra m et er po rt [ in] sp ec i f y i 2 c i n ter f ac e. ( i 2 c _ por t 0 / i 2 c _ p or t 1) u8 da t a [ in] b y te d ata. i nclu de dr iv er /dr v i 2 c . h ret urn va lue no n e e x a m p le dr v i 2 c _ w r itedata ( i 2 c _ p or t 0 , 0 x 55 ); /* set b y te d ata 0 x 5 5 in to i 2 c 0 d ata r eg is ter * / drvi 2 c_re a ddata p ro t o t y pe u in t8 _ t dr v i 2 c _ r ea d data ( e _ i 2 c _ p or t p o r t) ; descript io n pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 202 - t o r ea d th e last d ata f r o m i 2 c b u s . p a ra m et er po rt [ in] sp ec if y i 2 c i n ter f ac e. ( i 2 c _ por t 0 / i 2 c _ p or t 1) i nclu de dr iv er /dr v i 2 c . h ret urn va lue l ast b y te d ata e x a m p le u in t 8 _ t u 8 d ata; u 8 d ata = dr v i 2 c _ r ea d data ( i 2 c _ p or t 0 ); /* r ea d o u t b y te d ata f r o m i 2 c 0 d ata r eg is ter * / drvi 2 c_ct rl p ro t o t y pe v o id dr v i 2 c _ c tr l( e _ i 2 c _ p o r t p o r t, u in t8 _ t star t, u i n t8 _ t sto p , u in t8 _ t in tfl a g , u i n t8 _ t a ck ) ; descript io n t o s et i 2 c co n tr o l b it in clu d e st a , st o, aa , si in co n tr o l r eg is ter . p a ra m et er po rt [ in] sp ec if y i 2 c i n ter f ac e. ( i 2 c _ por t 0 / i 2 c _ p or t 1) s t a rt [ in] t o s et st a b it o r n o t. ( 1 : set , 0 : d o n ? t set) . i f t h e st a b it is s et, a st a r t o r r ep e at st a r t s ig n al w ill b e g e n er at ed w h e n i 2 c b u s i s f r ee . s t o p [ in] t o s et st o b it o r n o t. ( 1 : set, 0 : d o n ? t set) . i f t h e st o b it is s et, a st op s ig n al w ill b e g en er ated . w h e n a st op c o n d itio n is d etec ted , th is b it w i ll b e clea r ed b y h ar d w ar d au to m at icall y . intf la g [ in] t o clea r si f lag ( i 2 c in ter r u p t f la g ) . ( 1 : c lear , 0 : d o n ? t w o r k ) a ck [ in] t o en ab le aa b it ( a s s er t a c k n o w led g e co n tr o l b it) o r n o t. ( 1 : e n ab le , 0 : d is ab le ) i nclu de dr iv er /dr v i 2 c . h ret urn va lue pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 203 - no n e e x a m p le dr v i 2 c _ c tr l ( i 2 c _ p or t 0 , 0 , 0 , 1 , 0 ) ; /* set i 2 c 0 si b it to clea r si f lag * / dr v i 2 c _ c tr l ( i 2 c _ p or t 0 , 1 , 0 , 0 , 0 ) ; /* set i 2 c 0 st a b it t o s en d st a r t s i g n al * / drvi 2 c_g e tint fla g p ro t o t y pe u in t8 _ t dr v i 2 c _ geti n tfl a g ( e _ i 2 c _ p or t p o r t) ; descript io n t o g et i 2 c in ter r u p t f lag s tat u s . p a ra m et er po rt [ in] sp ec if y i 2 c i n ter f ac e. ( i 2 c _ por t 0 / i 2 c _ p or t 1) i nclu de dr iv er /dr v i 2 c . h ret urn va lue i n ter r u p t stat u s ( 1 o r 0) e x a m p le u in t 8 _ t u 8 f lag stat u s ; u 8 f la g sta tu s = dr v i 2 c _ geti n t flag ( i 2 c _ p or t 0 ); /* get t h e s tatu s o f i 2 c 0 in ter r u p t f la g * / drvi 2 c_ cle a r intfla g p ro t o t y pe v o id dr v i 2 c _ c lear i n tfl a g ( e _ i 2 c _ p or t p o r t) ; descript io n t o clea r i 2 c in ter r u p t f lag i f t h e f la g is s et 1 . p a ra m et er po rt [ in] sp ec if y i 2 c i n ter f ac e. ( i 2 c _ por t 0 / i 2 c _ p or t 1) i nclu de dr iv er /dr v i 2 c . h ret urn va lue pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 204 - no n e e x a m p le dr v i 2 c _ c lear i n t fla g ( i 2 c _ por t 0 ); /* c lear i 2 c 0 in ter r u p t f la g ( si) * / drvi 2 c_e n a ble int p ro t o t y pe in t3 2 _ t dr v i 2 c _ e n ab lei n t ( e _ i 2 c _ p or t p o r t) ; descript io n t o en ab le i 2 c in ter r u p t f u n c ti o n . p a ra m et er po rt [ in] sp ec if y i 2 c i n ter f ac e. ( i 2 c _ por t 0 / i 2 c _ p or t 1) i nclu de dr iv er /dr v i 2 c . h ret urn va lue 0 su cc ee d e x a m p le dr v i 2 c _ e n ab lei n t ( i 2 c _ p or t 0 ); /* e n ab le i 2 c 0 in ter r u p t */ drvi 2 c_dis a ble int p ro t o t y pe in t3 2 _ t dr v i 2 c _ dis ab lei n t ( e _ i 2 c _ p or t p o r t) ; descript io n t o d is ab le i 2 c in ter r u p t f u n cti o n . p a ra m et er po rt [ in] sp ec if y i 2 c i n ter f ac e. ( i 2 c _ por t 0 / i 2 c _ p or t 1) i nclu de dr iv er /dr v i 2 c . h ret urn va lue 0 su cc ee d e x a m p le pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 205 - dr v i 2 c _ dis ab lei n t ( i 2 c _ p or t 0 ); /* di s ab le i 2 c 0 in ter r u p t * / drvi 2 c_ ins t a ll cal lba c k p ro t o t y pe in t3 2 _ t dr v i 2 c _ i n s tallc al l b ac k ( e _ i 2 c _ p or t p o r t, e _ i 2 c _ c al l b ac k_ t yp e t y p e, i 2 c _ c al l b ac k ca llb ac k f n ) ; descript io n t o in s tall i 2 c ca ll b ac k f u n cti o n in i 2 c i n ter r u p t h a n d ler . p a ra m et er po rt [ in] sp ec if y i 2 c i n ter f ac e. ( i 2 c _ por t 0 / i 2 c _ p or t 1) t y pe [ in] t h er e ar e f o u r ty p e s f o r ca ll b ac k f u n ctio n . ( i 2 c fun c / ar b i t l oss / b user r o r / t i me ou t ) i 2 c func : fo r n o r m al i 2 c co n d itio n ar b i t l oss: fo r m a s ter m o d e w h e n ar b itra tio n lo s s o cc u r s . t h e s tatu s co d e is 0 x 3 8 . b userr o r : fo r b u s er r o r co n d itio n . t h e s tat u s co d e is 0 x 0 0 . t i me ou t : fo r 1 4 - b it ti m e - o u t c o u n ter o v er f lo w . ca llb a ck f n [ i n] c all b ac k f u n ctio n n a m e f o r s p ec if ied in ter r u p t e v en t. i nclu de dr iv er /dr v i 2 c . h ret urn va lue 0 : su cc ee d <0 : fai led e x a m p le / * i n s tall i 2 c 0 ca ll b ac k f u n cti o n ? i 2 c 0 _ c allb ac k _ no r m al ? f o r i 2 c n o r m al co n d itio n */ dr v i 2 c _ i n s tal lc allb ac k ( i 2 c _ p or t 0 , i 2 c func , i 2 c 0 _ c allb ac k _ no r m al ); / * i n s tall i 2 c 0 ca ll b ac k f u n cti o n ? i 2 c 0 _ c allb ac k _ b u s e r r ? f o r b u s e r r o r co n d itio n */ dr v i 2 c _ i n s tal lc allb ac k ( i 2 c _ p or t 0 , b userr or , i 2 c 0 _ c allb ac k _ b u s e r r ); drvi 2 c_ uninsta l lca ll bac k p ro t o t y pe in t3 2 _ t dr v i 2 c _ un in s tall c a llb ac k ( e _ i 2 c _ p or t p o r t, e _ i 2 c _ c al l b a c k_ t yp e t y p e) ; pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 206 - descript io n t o u n i n s tall i 2 c ca ll b ac k f u n ctio n in i 2 c i n ter r u p t h a n d ler . p a ra m e t er po rt [ in] sp ec if y i 2 c i n ter f ac e. ( i 2 c _ por t 0 / i 2 c _ p or t 1) t y pe [ in] t h er e ar e f o u r ty p e s f o r ca ll b ac k f u n ctio n . ( i 2 c fun c / ar b i t l oss / b user r o r / t i me ou t ) i 2 c func : fo r n o r m al i 2 c co n d itio n ar b i t l oss: fo r m a s ter m o d e w h e n ar b itra tio n lo s s o cc u r s . t h e s tatu s co d e is 0 x 3 8 . b userr o r : fo r b u s er r o r co n d itio n . t h e s tat u s co d e is 0 x 0 0 . t i me ou t : fo r 1 4 - b it ti m e - o u t c o u n ter o v er f lo w . i nclu de dr iv er /dr v i 2 c . h ret urn va lue 0 : su cc ee d <0 : failed e x a m p le / * u n in s tall i 2 c 0 ca ll b ac k f u n ctio n f o r i 2 c n o r m al co n d itio n */ dr v i 2 c _ un i n s tallc a llb ac k ( i 2 c _ p or t 0 , i 2 c func ) ; / * u n in s tall i 2 c 0 ca ll b ac k f u n ctio n f o r b u s e r r o r co n d itio n */ dr v i 2 c _ un i n s tallc a llb ac k ( i 2 c _ p or t 0 , b userr or ) ; drvi 2 c_ s e t time out cou nt er p ro t o t y pe in t3 2 _ t dr v i 2 c _ set t im eo u tc o u n t er ( e _ i 2 c _ p or t p o r t, in t3 2 _ t i3 2 en ab le, u in t8 _ t u 8 d iv 4 ) ; descript io n t o co n f ig u r e 1 4 - b it ti m e - o u t c o u n ter . p a ra m et er po rt [ in] sp ec if y i 2 c i n ter f ac e. ( i 2 c _ por t 0 / i 2 c _ p or t 1) i3 2 ena ble [ in] t o en ab le o r d is ab le 14 - b it tim e - o u t c o u n ter . ( 1 : e n ab le , 0 : d is ab le ) pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 207 - u8 div 4 [ in] 1 : e n ab le di v4 f u n ctio n . t h e s o u r ce clo ck o f t h e ti m e - o u t c o u n ter is eq u a l to hc l k / 4 w h e n th e ti m e - o u t c o u n ter i s en ab led . 0 : dis ab le di v4 f u n ctio n . t h e s o u r ce clo ck o f t h e ti m e - o u t c o u n ter is f r o m h c l k w h en th e ti m e - o u t c o u n ter is e n ab led . i nclu de dr iv er /dr v i 2 c . h ret urn va lue 0 su cc ee d e x a m p le / * e n ab le i 2 c 0 14 - b it ti m eo u t co u n ter an d d is ab le it s di v4 f u n ct io n */ dr v i 2 c _ e n ab let i m eo u t c o u n t ( i 2 c _ p or t 0 , 1 , 0 ); drvi 2 c_ cle a rtim e out fla g p ro t o t y pe v o id dr v i 2 c _ c lear t im eo u t flag ( e _ i 2 c _ p or t p o r t) ; descript io n t o clea r i 2 c t i f f lag if t h e f la g is s e t 1 . p a ra m et er po rt [ in] sp ec if y i 2 c i n ter f ac e. ( i 2 c _ por t 0 / i 2 c _ p or t 1) i nclu de dr iv er /dr v i 2 c . h ret urn va lue no n e e x a m p le dr v i 2 c _ c lear t i m eo u tf lag ( i 2 c _ p or t 0 ); /* c lear i 2 c 0 t i f f la g * / drvi 2 c_g e tve rs ion p ro t o t y pe u in t3 2 _ t dr v i 2 c _ getve r s io n ( v o id ); descript io n get th i s m o d u le ? s v er s io n . pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 208 - p a ra m et er no n e i nclu de dr iv er /dr v i 2 c .h return value version number : 31:24 23:16 15:8 7:0 00000000 major_num minor_num build_num pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 209 - 9. rtc driv e r 9.1. rtc introduction r ea l t im e c lo ck ( r t c ) u n it p r o v i d es u s er t h e r ea l ti m e a n d ca len d ar m es s ag e . t h e r t c u s es a 3 2 . 7 6 8 khz ex ter n al cr y s ta l. a b u ilt in r t c is d esi g n ed to g en er ate t h e p er io d ic in ter r u p t s ig n al. t h e p er io d ca n b e 1 /1 2 8 , 1 /6 4 , 1 /3 2 , 1 /1 6 , 1 /8 , 1 /4 , 1 /2 an d 1 s ec o n d . an d t h e r t c co n tr o ller s u p p o r ts p er io d ic t im e t ick an d a lar m ma tch in ter r u p ts t . 9.2. rtc feat ures ? ? there is a time counter (second, minute, hour) and calendar counter (day, month, year) for user to check the time . ? ? 12 - hour or 24 - hour mode is selectable . ? ? leap year compensation automatical ly . ? ? day of week counter . ? ? frequency compensate register . ? ? all time and calendar message is expressed in bcd code . ? ? su p p o r t p er io d ic tim e tic k in te r r u p t w it h 8 p er io d o p tio n s 1 / 1 2 8 , 1 /6 4 , 1 / 3 2 , 1 /1 6 , 1 / 8 , 1 /4 , 1 /2 an d 1 s ec o n d . ? ? support rtc time tick and alarm match interrupt ? ? su p p o r t w a k e - u p ch ip f r o m p o w er d o w n m o d e b y r t c t im e t ick or a lar m ma tch i n ter r u p t . pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 210 - constant definition constant name value description drvrtc_init_key 0xa5eb1357 a key number to make rtc leaving reset state drvrtc_write_key 0xa965 a k ey number to unlock rtc protected regiser drvrtc_clock_12 0 12 - hour mode drvrtc_clock_24 1 24 - hour mode drvrtc_am 1 a.m. drvrtc_pm 2 p.m. drvrtc_year2000 2000 set the year is 2000. drvrtc_fcr_reference 32761 a reference value to compensate 32 k hz 9.3. t ype definition e_drvrtc_ int_source enumeration identifier value description drvrtc_alarm_int 1 set alarm interrupt drvrtc_tick_int 2 set tick interrupt drvrtc_all_int 3 set alarm and tick interrupt e_drvrtc_ti ck enumeration identifier value description drvrtc_tick_1_sec 0 set tick period 1 tick per second drvrtc_tick_1_2_sec 1 set tick period 2 tick per second drvrtc_tick_1_4_sec 2 set tick period 4 tick per second drvrtc_tick_1_8_sec 3 set tick period 8 tick per second drvrtc_tick_1_16_sec 4 set t ick period 16 tick per second drvrtc_tick_1_32_sec 5 set tick period 32 tick per second drvrtc_tick_1_64_sec 6 set tick period 64 tick per second drvrtc_tick_1_128_sec 7 set tick period 128 tick per second e _ dr v rtc _ time_ s e lect enumeration identifier v alue description drvrtc_current_time 0 select current time option pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 211 - drvrtc_alarm_time 1 select alarm time option e _ dr v rtc _ dw r _ p ar am e ter enumeration identifier value description drvrtc_sunday 0 day of week: sunday drvrtc_monday 1 day of week: monday dr vrtc_tuesday 2 day of week: tuesday drvrtc_wednesday 3 day of week: wednesday drvrtc_thursday 4 day of week: thursday drvrtc_friday 5 day of week: friday drvrtc_saturday 6 day of week: saturday 9.4. functions drv rtc _ s e tf re que n c y comp e n s a tion p ro t o t y pe in t3 2 _t dr v r t c _ setfre q u e n c y c o m p en s atio n ( in t3 2 _ t i3 2 fre q u en c y x1 0 0 ); descript io n set fr eq u e n c y c o m p en s atio n data p a ra m et er i3 2 f re qu ency x1 0 0 [ in] sp ec if y th e r t c clo ck x1 0 0 , ex : 3 2 7 7 3 6 5 m ea n s 3 2 7 7 3 . 6 5 . i nclu de dr iv er /dr v r t c . h ret urn va lue e _ suc c e ss : s u cc es s e _ dr vr t c _ e r r _ f c r _ v al ue : w r o n g c o m p e n s atio n v alu e e x a m p le / * i f t h e m ea s u r ed r t c cr y s ta l f r eq u en c y i s 3 2 7 7 3 . 6 5 hz. * / pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 212 - dr v r t c _ setfre q u e n c y c o m p en s atio n ( 3 2 7 7 3 6 5 ) ; drvrtc_ is lea p y e a r p ro t o t y pe in t3 2 _ t dr v r t c _ i s l ea p yea r ( v o id ); descript io n a cc o r d in g to cu r r en t ti m e , r et u r n t h is y ea r is leap y ea r o r n o t. p a ra m et er no n e. i nclu de dr iv er /dr v r t c . h ret urn va lue 1 : t h is y ea r is a leap y ea r . 0 : t h is y ea r is n o t a leap y ea r . e x a m p le i f ( dr v r t c _ i s l ea p yea r ( ) ) p r in tf ( t h is is l ea p y ea r ! ); else p r in tf ( t h is is n o t l ea p y ea r ! ); drvrtc_ ge tint tic k p ro t o t y pe in t3 2 _ t dr v r t c _ get i n t t ick ( v o id ); descript io n t h e f u n c tio n i s u s ed to g et c u r r en t so f t w ar e tick co u n t a f ter en ab le tick i n ter r u p t . p a ra m et er no n e. i nclu de dr iv er /dr v r t c . h ret urn va lue so f t w ar e t ick c o u n t i n tick i n ter r u p t pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 213 - e x a m p le / * p o llin g t h e tic k co u n t to w a it 3 s ec . * / dr v r t c _ sett ick mo d e ( dr v r t c _ t i c k_ 1 _ 2 _ sec ) ; /* 1 tick is 0 . 5 s ec . * / dr v r t c _ e n ab lei n t( d r v r t c _ t i c k_ i nt , nul l ); w h ile ( dr v r t c _ gett ick ( ) < 6 ) ; p r in tf ( p ass t h o u g h 3 s ec \ n ) drvrtc_ res e ti nt tic k p ro t o t y pe v o id dr v r t c _ r ese tt ick ( v o id ); descript io n t h e f u n c tio n i s u s ed to r eset t h e tick co u n t c o u n t in g i n in ter r u p t. p a ra m et er no n e. i nclu de dr iv er /dr v r t c . h ret urn va lue no n e e x a m p le dr v r t c _ r ese tt ick ( ); drvrtc_writee nabl e p ro t o t y pe in t3 2 _ t dr v r t c _ w r itee n ab le ( v o id ); des cr iptio n a cc e s s p ass w o r d to a e r to m ak e ac ce s s o t h er r eg is ter e n ab le p a ra m et er no n e. i nclu de dr iv er /dr v r t c . h ret urn va lue pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 214 - e _ suc c e ss : s u cc es s e _ dr vr t c _ e r r _ f a i l e d : failed . no t e af ter w r ite a p ass w o r d to a e r r eg is ter , fc r / ta r / ca r / t t r r eg is ter ca n b e w r itte n o r r ea d . a n d a f ter 5 1 2 r t c clo c k s ( ab o u t 1 5 m s ) , a cc es s en ab le w iil a u to - clea r . e x a m p le / * b ef o r e y o u w a n t to s et t h e v alu e i n f c r / t ar / c ar / t t r r eg is ter , u s i n g t h e f u n cti o n to o p en ac ce s s ac co u n t. */ dr v r t c _ w r itee n ab le ( ); drvrtc_i nit p ro t o t y pe in t3 2 _ t dr v r t c _ i n it ( v o id ); descript io n i n itial r t c . i t c o n s i s ts o f clea r ca llb ac k f u n ctio n p o in ter , en ab le 3 2 k clo ck an d r t c clo c k an d w r ite i n it ial k e y to let r t c s tar t c o u n t. p a ra m et er no n e. i nclu de dr iv er /dr v r t c . h ret urn va lue e _ suc c e ss : s u cc es s e _ dr vr t c _ e r r _ e i o : i n it i al r t c failed . e x a m p le / * i n t h e b eg i n n in g , ca ll t h e f u n ctio n to i n itial r t c * / dr v r t c _ i n it ( ) ; drvrtc_s e tt ic k m od e p ro t o t y pe in t3 2 _ t d r v r t c _ sett ick mo d e( u in t8 _ t u cm o d e) ; descript io n t h e f u n c tio n i s u s ed to s et ti m e tick p er io d f o r p er io d ic t im e t ick i n ter r u p t . pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 215 - p a ra m et er ucm o de [ in ] th e s tr u ctu r e o f d r v r t c _ t i c k . i t is u ed to s et t h e r t c ti m e tic k p er io d f o r p er io d ic t im e t ick i n ter r u p t r eq u est. i t c o n s i s ts o f drvrtc_tick_1_sec : time tick is 1 second drvrtc_tick_1_2_sec : time tick is 1/2 s econd drvrtc_tick_1_ 4 _sec : time tick is 1/4 second drvrtc_tick_1_ 8 _sec : time tick is 1/8 second drvrtc_tick_1_ 16 _sec : time tick is 1/16 second drvrtc_tick_1_ 32 _sec : time tick is 1/32 second drvrtc_tick_1_ 64 _sec : time tick is 1/64 second drvrtc_t ick_1_ 128 _sec : time tick is 1/128 second i nclu de dr iv er /dr v r t c . h ret urn va lue e _ suc c e ss : s u cc es s e _ dr vr t c _ e r r _ e i o : a cc ess e n ab le f ailed e _ dr vr t c _ e r r _ e not t y : p ar am eter is w r o n g e x a m p le / * set t ick in ter r u p t is 1 2 8 tick /s ec * / dr v r t c _ sett ick mo d e ( dr v r t c _ t i c k_ 1 _ 1 2 8 _ sec ) ; drvrtc_ e nabl e int p ro t o t y pe in t3 2 _ t d r v r t c _ e n ab lei n t ( dr v r t c _ i nt _ sour c e s tr _ i n tsrc , p fn_ dr vr t c _ c al l b a c k p f n ca llb ac k ) ; descript io n t h e f u n c tio n i s u s ed to en ab le s p ec if ied in ter r u p t a n d in s tall ca llb ac k f u n ctio n . . p a ra m et er s t r_ i ntsrc [ in] th e s tr u ctu r e o f i n ter r u p t s o u r c e. i t c o n s is ts o f drvrtc_alarm_int : alarm interrupt drvrtc_tick_int : tick interrupt drvrtc_all_int : alarm and tick interrupt p f nca llb a c k [ in] c allb ac k f u n ctio n p o in ter pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 216 - i nclu de dr iv er /dr v r t c . h ret urn va lue e _ suc c e ss : s u cc es s e _ dr vr t c _ e r r _ e not t y : p ar am eter is w r o n g e x a m p le / * e n ab le tic k i n ter r u p t a n d in s tall c allb ac k f u n ct io n r t c _ t ick c allb ac k f n . * / dr v r t c _ e n ab lei n t( d r v r t c _ t i c k_ i nt , r t c _ t ick c allb ac k f n ) ; drvrtc_ dis a ble int p ro t o t y pe in t3 2 _ t dr v r t c _ dis ab lei n t ( dr v r t c _ i nt _ sour c e s tr _ i n tsrc ) ; descript io n t h e f u n c tio n i s u s ed to d is ab le s p ec if ied in ter r u p t a n d r e m o v e ca llb ac k f u n c tio n . p a ra m et er s t r_ i ntsrc [ in] th e s tr u ctu r e o f i n ter r u p t s o u r c e. i t c o n s is ts o f drvr t c_ al arm _ i nt : alarm interrupt drvr t c_ t i ck _ i nt : tick int errupt drvrtc_all_int : a lar m an d tic k interrupt i nclu de dr iv er /dr v r t c . h ret urn va lue e _ suc c e ss : s u cc es s e _ dr vr t c _ e r r _ e not t y : p ar am eter is w r o n g e x a m p le / * dis ab le tic k a n d alar m in ter r u p t * / dr v r t c _ dis ab le i n t( dr v r t c _ al l _ i nt ) ; pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 217 - drv rtc _ ope n p ro t o t y pe in t3 2 _ t dr v r t c _ op en ( s_ dr v r t c _ t i me _ da t a _ t * s p t ); descript io n set c u r r en t ti me ( yea r /mo n t h /da y , ho u r /mi n u te/sec a n d d ay o f w ee k ) p a ra m et er * s p t [ in] sp ec if y th e ti m e p r o p er ty a n d cu r r en t ti m e. i t in cl u d es u8cclockdisplay : drvrtc_clock_12 / drvrtc_clock_24 u8campm : drvrtc_am / drvrtc_pm u32csecond : second value u32cminute : minute value u32chour : hour value u32cdayofweek : day of week u32cday : day value u32cmonth : month value u32year : year value u8isenablewakeup : enable or not wakeup function when time alarm happen i nclu de dr iv er/drvrtc.h ret urn va lue e _ suc c e ss : s u cc es s e _ dr vr t c _ e r r _ e i o : i n i ti al r t c failed . e x a m p le / * star t rt c co u n t f r o m 2 0 0 9 . j an . 1 9 , 1 3 :2 0 :0 0 . * / s_ dr v r t c _ t i me _ da t a _ t s i n itt im e; s i n itt i m e. u 3 2 yea r = 2 0 0 9 ; s i n itt i m e. u 3 2 cm o n th = 1 ; s i n itt i m e. u 3 2 cda y = 1 9 ; s i n itt i m e. u 3 2 cho u r = 1 3 ; s i n itt i m e. u 3 2 cm in u te = 2 0 ; s i n itt i m e. u 3 2 csec o n d = 0 ; s i n itt i m e. u 3 2 cda y o f w ee k = dr v r t c _ mo nd a y; s i n itt i m e. u 8 ccl o ck d is p la y = dr v r t c _ c l o c k_ 2 4 ; if ( dr v r t c _ op en ( & s i n itt i m e) ! =e _ suc c e ss ) { p r in tf ( " r t c op en fail ! ! \ n " ) ; } pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 218 - drv rtc _ rea d p ro t o t y pe in t3 2 _ t dr v r t c _ r ea d ( e _ dr vr t c _ t i me _ sel e c t et im e , s_ dr v r t c _ t i me _ da t a _ t * s p t ); descript io n r ea d cu r r en t d ate/ti m e o r alar m d ate/ti m e f r o m r t c s etti n g p a ra m et er eti m e [ in] sp ec if y th e c u r r en t/alar m ti m e to b e r ea d. drvrtc_current_time : current time drvrtc_alarm_time : alarm time * s p t [ in] sp ec if y th e b u f f er to s to r e th e d ata r ea d f r o m r t c . i t in cl u d es : u8cclockdisplay : drvrtc_clock_12 / drvrtc_clock_24 u8campm : drvrtc_am / drvrtc_pm u32csecond : second val ue u32cminute : minute value u32chour : hour value u32cdayofweek : day of week u32cday : day value u32cmonth : month value u32year : year value i nclu de dr iv er /dr v r t c . h ret urn va lue e _ suc c e ss : s u cc es s e _ dr vr t c _ e r r _ e i o : i n i ti al r t c failed . e x a m p le / * c o n d itio n : y o u w an t to g et cu r r en t rt c ca le n d ar an d ti m e */ s_ dr v r t c _ t i me _ da t a _ t s c u r t im e; dr v r t c _ r ea d ( dr v r t c _ c ur r e nt _ t i me , & s c u r t i m e ) ; pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 219 - p r in tf ( " c u r r en t t im e: %d /%0 2 d /%0 2 d %0 2 d :%0 2 d :%0 2 d \ n" , s c u r t im e. u 3 2 yea r , s c u r t im e. u 3 2 cm o n th , s c u r t im e. u 3 2 cda y , s c u r t i m e. u 3 2 c ho u r , s c u r t i m e. u 3 2 cm i n u te, s c u r t i m e. u 3 2 csec o n d ) ; drv rtc _ w rite p ro t o t y pe in t3 2 _ t dr v r t c _ w r ite ( e _ dr vr t c _ t i me _ sel e c t et im e , s_ dr v r t c _ t i me _ da t a _ t * s p t ); descript io n set cu r r en t d ate/ti m e o r alar m d ate/ti m e to r t c p a ra m et er eti m e [ in] sp ec if y th e c u r r en t/al ar m ti m e to b e w r itte n . drvrtc_current_time : current time drvrtc_alarm_time : alarm time * s p t [ in] sp ec if y th e d ata to w r i te to r t c . i t in clu d es : u8cclockdisplay drvrtc_clock_12 / drvrtc_clock_24 u8campm drvrtc_am / drvrtc_pm u32csecond second value u32cminute minute value u32chour hour value u32cdayofweek day of week u32cday day value u32cmonth month value u32year year value i nclu de dr iv er /dr v r t c . h ret urn va lue e _ suc c e ss : s u cc es s e _ dr vr t c _ e r r _ e i o : i n i ti al r t c failed . e x a m p le pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 220 - / * c o n d itio n : u p d a te cu r r en t t h e s ec o n d o f ti m e to ze r o */ s_ dr v r t c _ t i me _ da t a _ t s c u r t im e; dr v r t c _ r ea d ( dr v r t c _ al ar m_ t i me , & s c u r t i m e) ; s c u r t im e. u 3 2 csec o n d = 0; dr v r t c _ w r ite( dr vr t c _ al ar m_ t i me , & s c u r t i m e) ; drv rtc _ clos e p ro t o t y pe in t3 2 _ t dr v r t c _ c lo s e ( v o id ); descript io n di s able nvic channel of rtc and both tick and alarm interrupt.. i nclu de dr iv er /dr v r t c . h ret urn va lue e _ suc c e ss : s u cc es s e x a m p le dr v r t c _ c lo s e( ) ; drvr tc _ ge tve r s ion p ro t o t y pe in t3 2 _ t dr v r tc _ getve r s io n ( v o id ); descript io n r etu r n th e c u r r en t v er s io n n u m b er o f d r i v er . i nclu de dr iv er /dr v r t c . h ret urn va lue ver s io n n u m b er : 31:24 23:16 15:8 7:0 00000000 major_num minor_num build_num pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 221 - 10. can dri ver 10.1. can introduction t h e c a n c o r e p er f o r m s co m m u n icat io n ac co r d in g to t h e c a n p r o to co l v er s io n 2 . 0 p ar t a a n d b . t h e b it r ate ca n b e p r o g r am m ed to v al u es u p to 1 mb it/s . fo r th e co n n ec tio n to t h e p h y s ical la y er , ad d itio n al tr an s ce i v er h ar d w ar e is r eq u ir ed . fo r co m m u n ica tio n o n a c an n et w o r k , in d i v id u a l m ess a g e ob j ec ts ar e co n f ig u r ed . t h e me s s a g e ob j ec ts an d i d en tif ier ma s k s f o r ac ce p ta n ce f ilter in g o f r ec ei v ed m es s ag e s ar e s to r ed in th e me s s ag e r a m. on l y nu mic r o tm 1 3 0 /1 4 0 s u p p o r t th e c a n ap p licatio n . 10.2. c a n f eat ure its main features are listed as following: ? ? suppor ts c a n p r o to co l v er s io n 2 . 0 p ar t a an d b . ? ? b it r ates up to 1 mbit/s. ? ? 3 2 me s s a ge objects. ? ? e ac h me s s a g e ob j ect has its own identifier mask. ? ? p r o g r am m ab le fifo m o d e ( c o n ca ten atio n o f me ssage objects). ? ? ma s k ab le interrupt. ? ? dis ab led a u to m atic r e - tr an s m is s io n m o d e f o r t i m e t r ig g e r ed c a n ap p lications. ? ? p r o g r ammable loop - back mode for self - te st operation. ? ? 16 - bit m o d u le i n ter f ac e s to th e am b a a p b b u s . ? ? suppor t w a k eu p f u n ctio n . 10.3. con s tan t de fin i tio n table 10 - 1 : callback function name value description callback_rxok 0 rx ok callback function pointer callback_txok 1 tx ok callback function pointer callback_ewarn 2 warning callback function pointer pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 222 - name value description callback_boff 3 bus off callback function pointer callback_msg 4 message callback function pointer callback_wakeup 5 wakeup callback function pointer t a b le 10 - 2 : i d t yp e name value description can_ std_id 0 standard id (11 - bits) can_ext_id 1 extended id (29 - bits) t a b le 10 - 3 : f r a m e t y p e name value description remote_frame 0 remote frame data_frame 1 data frame 10.4. fu n ctio ns d rv can_i nit p ro t o t y pe v o id dr v c an_ i n it ( v o id ) ; descript io n t h e f u n c tio n i s u s ed to r eset a n d i n itialize s c an i p p a ra m et er no n e i nclu de dr iv er /dr v c a n .h ret urn va lue no n e e x a m p le / * e n ab le c an i p clo ck * / dr v c an_ i n it() ; pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 223 - d rv ca n_clos e p ro t o t y pe v o id dr v c an _ c lo s e ( v o id ); descript io n r eset a n d clea r all c a n co n tr o l a n d d is ab le c an i p pa ra m et er no n e i nclu de dr iv er /dr v c a n .h ret urn va lue no n e e x a m p le /* disable can ip clock , clear callback function pointer and reset can ip*/ drvcan_close(); d rv can _ ope n p ro t o t y pe in t3 2 _ t d r v c an_ op en ( u i n t3 2 _ t u 3 2 k bp s ) ; descript io n t h e f u n c tio n i s u s ed to s et b u s ti m i n g p ar a m eter ac co r d in g c u r r en t c lo ck a n d tar g et b it r ate . p a ra m et er u3 2 k b p s [ in] t h e tar g et c a n k ilo b it r ate p er s ec o n d . t h e r an g e o f u 3 2 k b p s is 1 ~1 0 0 0 k bps . i nclu de dr iv er /dr v c a n .h ret urn va lue e _ dr vc a n_ e r r _ b i t r a t e set ta r g et b it - r ate f ail e _ s uc c e ss set b itra te s u cc ess f u l. e x a m p le / * set c a n b itra te is 5 0 0 k b p s * / dr v c an_ op en ( 5 0 0 ) ; pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 224 - d rv can _ s e tt im ing p ro t o t y pe v o id dr v c an_ sett i m in g ( u in t8 _ t u 8 t s eg 2 , u in t8 _ t u 8 t s eg 1 , u in t8 _ t u 8 sj w , u i n t3 2 _ t u 3 2 b r p ) ; descript io n setu p s t h e c an ti m i n g w i th s p ec if ic p ar a m eter s . p a ra m et er u8 t s eg 1 [ in] s p ec if ie s t im e se g m e n t b ef o r e th e s a m p le p o in t. t h is p ar am eter m u s t b e a n u m b er b et w ee n 1 an d 1 6 . u 8 t s eg 2 [ in] t im e se g m en t a f ter th e s a m p l e p o in t. t h is p ar am eter m u s t b e a n u m b er b et w ee n 1 an d 8. u8 s jw [ in] s y n ch r o n is atio n j u m p w id th . t h is p ar am eter m u s t b e a n u m b er b etw ee n 1 an d 4 . u3 2 b rp [ in] b au d r ate p r escaler . t h is p ar a m eter m u s t b e a n u m b er b etw ee n 1 an d 1 0 2 4 sh o w n c a n b it - r ate ca lcu lati o n eq u atio n as b elo w : c a n s p ee d ( b p s ) = = w h r er f a pb_c l k : s y s te m clo ck f r eq . u 8 t s eg 1 : t h e ti m e s e g m en t 1 u 8 t s eg 2 : t h e ti m e s eg m e n t 2 u 3 2 b p r : th e b au d - r ate p r escale i nclu de dr iv er /dr v c a n .h ret urn va lue no n e e x a m p le / * set c a n b u s t i m in g ac co r d in g y o u r d esire d . t 2 = 2 , t 1 = 3 , sj w =1 , b r p = 1 */ dr v c an _ e n ter i n it mo d e (); dr v c an_ sett i m in g ( 2 , 3 , 1 , 1 ); pdf create 8 trial www.nuance.com ) 1 bpr 32 u ( ) 3 u 8 t s e g 2 + ( u 8 t s e g 1 f a p b _ c l k ? ? ?
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 225 - dr v c an_ l ea v e i n i tmo d e (); i f th e s y s te m clo c k f r eq = 1 6 mh z, s o c a n b it - r ate = = 1 0 0 0 k b p s drvcan _ res e t m s go bj p ro t o t y pe v o id dr v c a n_ r ese t ms g o b j ( u in t8 _ t u 8 m sg o b j ) ; descript io n c o n f i g u r es t h e m es s ag e o b j ec t a s d ef au lt . p a ra m et er u8 m sg o bj [ in] s p ec if ie s th e me s s a g e o b j ec t n u m b er , f r o m 0 to 3 1 . i nclu de dr iv er /dr v c a n .h ret urn va lue e _ suc c e ss : su c c e ss e _ dr vc a n_ n o_ usefu l _ i nt e r fa c e : n o u s e f u l in ter f ac e e x a m p le / * r e s et c an me s s a g e ob j ec t n o . 5 in f o r m atio n */ dr v c an_ r eset m s g ob j ( 5 ) ; drvcan _ res e t allms gobj p ro t o t y pe v o id dr v c a n_ r e s et a llm s g ob j ( v o id ); descript io n c o n f i g u r es a ll t h e m es s ag e o b j ec ts as d ef au lt . p a ra m et er no ne i nclu de dr iv er /dr v c a n .h ret urn va lue pdf create 8 trial www.nuance.com ) 1 1 ( ) 3 3 + (2 16000000 u
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 226 - no n e. e x a m p le / * r e s et all c an me s s ag e ob j ec t */ dr v c an_ r eset allms g ob j () ; drvcan _ s e tt x m s go bj p ro t o t y pe in t3 2 _ t d r v c an_ sett x msg o b j ( u in t8 _ t u 8 msg ob j , st r _ c a nm sg_ t * p c a n m s g ) ; descript io n t h e f u n c tio n i s u s ed to co n f i g u r e a tr an s m it o b j ec t . p a ra m et er u8 m sg o bj [ in] s p ec if ie s th e me s s a g e o b j ec t n u m b e r , f r o m 0 to 3 1 pca nm s g [ in] a s tr u ct u r e ab o u t c a n m es s a g e o b j ec t idt y pe : s p ec if ie s th e id e n ti f ier t y p e o f th e f r a m es t h at w i ll b e tr an s m i tted . u s i n g t h is m e s s a g e o b j ec t. t h is p ar a m eter ca n b e o n e o f th e f o llo w in g v alu e s : ? c a n_ st d_ i d ( s tan d ar d i d, 1 1 - b it) ? c an_ext_id (extended id, 29 - bit) frame type : data_frame or remote_frame id : s p ec if ies t h e id en ti f ier u s e d f o r ac ce p tan ce f ilter i n g dlc: desird d ata b y tes y o u w a n t to s en d . ma x i m u n is 8 . da t a [ 0 ] ~ da t a [ 7 ]: data v alu e ? i nclu de dr iv er /dr v c a n .h ret urn va lue e _ suc c e ss : su c c e ss e _ dr vc a n_ n o_ usefu l _ i nt e r fa c e : n o u s e f u l in ter f ac e e x a m p le / * c o n f i g u r e tms g s tr u ctu r e c o n ten t i n to me s s ag e ob j ec t 0 */ st r _ c a n msg_ t tmsg ; / * se n d a 1 1 - b its m e s s a g e * / pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 227 - tmsg . fra m et y p e= d a t a _ fr a me ; tmsg . i d t y p e = c an_ st d_ i d; tmsg . i d = 0 x 7 ff; tmsg . d lc = 0 ; if ( dr v c a n_ sett x m s g ob j ( msg( 0 ) , & tms g ) < 0 ) p r in tf ( " set t x msg ob j ec t f ail ed \ n " ) ; drvcan _ s e tm s gobj m a s k p ro t o t y pe in t3 2 _ t d r v c an_ setms g ob j ma s k ( u in t8 _ t u 8 msg ob j , st r _ c anm a sk_ t * ma s k ms g ) ; descript io n c o n f i g u r es m a s k a s th e m es s a g e o b j ec t . p a ra m et er u8 m sg o bj [ in] s p ec if ie s th e me s s a g e o b j ec t n u m b er , f r o m 0 to 3 1 . m a s k m s g [ in] s p ec if ie s th e m as k s tr u ct u r e as m es s ag e o b j ec t. t h e s tr u ctu r e is i n cl u d in g o f ? u 8 xtd ( ma s k i de b it) ? u 8 dir ( ma s k dir ec tio n ) ? u 3 2 i d ( ma s k i d b it) ? u 8 i d t y p e ( ma s k i d t y p e) i nclu de dr iv er /dr v c a n .h ret urn va lue e _ suc c e ss : su c c e ss e _ dr vc a n_ n o_ usefu l _ i nt e r fa c e : n o u s e f u l in ter f ac e e x a m p le / * set c a n me s s ag e ob j ec t n o . 0 ma s k i d is 0 x 7 ff */ st r _ c a n m a sk_ t tmsg ; tmsg . u 3 2 i d = 0 x 7 ff ; if ( dr v c a n_ setm s g ob j ma s k ( 0 , & tms g ) ; < 0 ) p r in tf ( " set m s g ob j ec t f ailed \ n " ) ; pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 228 - drvcan _ s e tr x m s go bj p ro t o t y pe in t3 2 _ t d r v c an_ setr x m s g o b j ( u in t8 _ t u 8 m s g o b j , u in t8 _ t u 8 id t y p e, u i n t3 2 _ t u 3 2 id , u in t8 _ t u 8 s i n g le or fi f o l a s t) ; descript io n t h e f u n c tio n i s u s ed to co n f i g u r e a r ec eiv e m e s s a g e o b j ec t. . p a ra m et er u8 m sg o bj [ in] s p ec if ie s th e me s s a g e o b j ec t n u m b er , f r o m 0 to 3 1 . idt y pe [ in] s p ec if ie s th e id e n ti f ier t y p e o f th e f r a m es t h at w i ll b e tr an s m i tted u s i n g th i s m e s s a g e o b j ec t. t h is p ar am e ter ca n b e o n e o f th e f o llo w in g v alu e s : - c an_ st d_ i d ( s ta n d ar d i d, 1 1 - b it) - c an_ e xt _ i d ( ex ten d ed i d, 2 9 - b it) u3 2 id [ in] s p ec if ie s th e id e n ti f ier u s ed f o r ac ce p tan ce f ilter i n g u8 s ing leo rf if o l a s t [ in] s p ec if ie s th e e n d - of - b u f f er i n d icato r . t h is p ar am eter ca n b e o n e o f t h e f o llo w i n g v al u es: - t r ue : f o r a s in g le r ec eiv e o b j ec t o r a fifo r ec eiv e o b j ec t th at is t h e las t o n e o f t h e fifo. - f al se: f o r a fifo r ec eiv e o b j ec t th at is n o t t h e last o n e i nclu de dr iv er /dr v c a n .h ret urn va lue e _ suc c e ss : su c c e ss e _ dr vc a n_ n o_ usefu l _ i nt e r fa c e : n o u s e f u l in ter f ac e e x a m p le / * c o n f i g u r e c a n me s s a g e o b j ec t n o . 0 o n ly r ec ei v e i d 0 x 1 2 3 */ st r _ c a n msg_ t r msg ; if ( dr v c a n_ set r x ms g ob j ( msg( 0 ) , c an_ st d_ i d, 0 x 1 2 3 , t r ue ) < 0 ) p r in tf ( " set r x ms g ob j ec t f ailed \ n " ) ; pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 229 - drvcan _ clri nt p nd p ro t o t y pe in t3 2 _ t dr v c an_ c lr i n tp n d ( u in t8 _ t u 8 m s g o b j ) ; descript io n t h e f u n c tio n i s u s ed t o r eset i n tp n d an d t xr qst ne w dat b it in a me s s a g e ob j ec t. p a ra m et er u8 m sg o bj [ in] s p ec if ie s th e me s s a g e o b j ec t n u m b er , f r o m 0 to 3 1 . i nclu de dr iv er /dr v c a n .h ret urn va lue e _ suc c e ss : su c c e ss e _ dr vc a n_ n o_ usefu l _ i nt e r fa c e : n o u s e f u l in ter f ac e e x a m p le / * c le ar c a n me s s ag e ob j ec t 0 in ter r u p t p en d in g */ dr v c an_ c lr i n tp n d ( 0 ) ; drvcan _ s e tt x rqst p ro t o t y pe u in t3 2 _ t dr v c a n_ sett x r q s t ( u in t8 _ t u 8 m sg o b j ) ; descript io n t h e f u n c tio n i s u s ed to s et tr a n s m it r eq u e s t b it in t h e tar g et m es s ag e o b j ec t. p a ra m et er s u8 m sg o bj [ in] s p ec if ie s th e me s s a g e o b j ec t n u m b er , f r o m 0 to 3 1 . i nclu de dr iv er /dr v c a n .h ret urn va lue e _ suc c e ss : su c c e ss e x a m p le / * af ter ca ll dr v c a n_ sett x msg ( ) to s et u p y o u r m es s a g e co n ten t i n to tar g et m es s ag e o b j ec t , y o u ca n ca ll th is a p i an d let me s s a g e h a n d ler to s en d th is m ess a g e */ pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 230 - / * set t h e t x r q s t b it o f me s s a g e o b j ec t n o . 0 * / dr v c an_ sett x r q s t ( 0 ); drvcan _ rea dm s gob j p ro t o t y pe in t3 2 _ t d r v c an_ r ea d ms g o b j ( u in t8 _ t u 8 msg ob j , u in t8 _ t r elea s e, st r _ c a n msg_ t * p c an ms g ) ; descript io n gets th e m es s a g e, if r ec ei v ed . p a ra m et er s u8 m sg o bj [ in] s p ec if ie s th e me s s a g e o b j ec t n u m b er , f r o m 0 to 3 1 . u8 rele a s e [ in] s p ec if ie s th e m es s ag e r elea s e i n d icato r . t h is p ar am eter ca n b e o n e o f t h e f o llo w i n g v al u es: - t r ue : th e m ess a g e o b j ec t is r elea s ed w h e n g etti n g t h e d at a. - f al se : t h e m es s ag e o b j ec t is n o t r elea s ed . pca nm s g [ in] p o in ter to th e m es s a g e s tr u c tu r e w h er e r ec eiv ed d ata is co p ied . i nclu de dr iv er /dr v c a n ret urn va lue - e _ suc c e ss : su cc e s s - e _ dr v c a n_ no_ p e ndi ng_ msg: no an y m e s s a g e r ec eiv ed e x a m p le / * p o llin g i i d r f la g t o w ait s p ec if ied m e s s a g e o b j ec t statu s c h an g ed an d r ec eiv e i n f o r m atio n is s to r ed as r msg s tr u ct u r e. */ w h ile( c an - > u 3 2 i i dr == 0 ) ; /* w ait i i dr i s ch an g ed * / dr v c an_ r ea d ms g ob j ( c an - > u 3 2 i i dr - 1 , t r ue , & r ms g ) ; drvcan _ w a itendoftx p ro t o t y pe in t3 2 _ t d r v c a n_ w aite n d of t x ( v o id ) ; descript io n w ait in g u n til c u r r en t tr an s m is s io n is f i n is h ed pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 231 - p a ra m et er s no n e i nclu de dr iv er /dr v c a n .h ret urn va lue - e _ suc c e ss : t r an s m i s s io n en d ed e x a m p le / * w ait. t r an s m it o k */ dr v c an_ w aite n d of t x () ; p r in tf ( t r an s m it s u cc es s f u ll y ); drvc an _ bas ic s e nd m s g p ro t o t y pe in t3 2 _ t d r v c an_ b asicsen d msg ( st r _ c a n msg_ t * p c a n ms g ) ; descript io n t h e f u n ctio n i s u s ed to s en d c a n m e s s a g e in b asi c m o d e o f test m o d e. b ef o r e ca ll th e a p i , th e u s er s h o u ld b e ca ll dr v c an_ e n ter t estmo d e( c a n_ t e st r _ b a sic) an d let c a n co n tr o ller en ter b asic m o d e o f test m o d e. p lease n o tice i f1 r eg is ter s u s ed as t x b u f f er i n b asic m o d e p a ra m et er pca nm s g [ in] p o in ter to th e m es s ag e s tr u ct u r e co n tain i n g d ata to tr an s m i t. . i nclu de dr iv er /dr v c a n. h ret urn va lue e _ suc c e ss : t r an s m is s io n ok e _ d r vc a n_ e r r _ t i me out : ch ec k b u s y f lag o f in ter f ac e 0 is ti m eo u t e x a m p le / * use b asic m o d e to s en d m e s s a g e w it h o u t u s i n g m e s s a g e r a m */ st r _ c a n msg_ t m s g 1 ; m s g 1 . fra m et y p e= d a t a _ f r a me ; m s g 1 . i d t y p e = c a n_ st d_ i d; m s g 1 . i d = 0 x 5 5 5 ; m s g 1 . dlc = 0 ; pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 232 - dr v c an_ b asicsen d m s g ( & m s g 1 ) ; drvcan _ bas ic re c e i v e m s g p ro t o t y pe in t3 2 _ t d r v c an_ b asicr ec ei v em s g ( st r _ c a n msg_ t * p c an ms g ) ; descript io n get a m es s ag e i n f o r m atio n in b a sic m o d e. t h is m o d e d o es n o t u s e t h e m ess a g e r am usi n g i f2 to g et r ec eiv e m es s ag e in f o r m at io n p a ra m et er pca nm s g [ in] pointer to the message structure where message is copied. i nclu de dr iv er /dr v c a n .h ret urn va lue e _ suc c e ss : rece p tio n ok e _ dr vc a n_ n o_ p e ndi ng_ msg: no an y m es s ag e r ec ei v ed e x a m p le / * w ait d ata in an d s to r ed in r m s g s tr u ct u r e */ st r _ c a n msg_ t r msg ; dr v c an_ w aitmsg (); dr v c an_ b asicr ec ei v em s g ( & r ms g ) ; drvcan _ e nt e rini tm ode p ro t o t y pe v o id dr v c an_ e n ter i n it mo d e( v o id ) ; descript io n t h is f u n ctio n is u s ed to s et c a n to e n ter in it ializatio n m o d e an d en ab le ac ce s s b it ti m i n g r eg is ter . af ter b it ti m i n g co n f i g u r atio n r ea d y , u s er m u s t c all dr v c an_ l ea v ei n i tmo d e( ) to leav e in itializat io n m o d e an d l o ck b it ti m i n g r eg is ter to let n e w co n f i g u r atio n ta k e ef f ec t. p a ra m et er no ne i nclu de dr iv er /dr v c a n .h ret urn va lue pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 233 - no n e e x a m p le / * e n ter i n it m o d e a n d u s er ca n ch a n g ed b u s ti m i n g s e tti n g s . */ dr v c an_ e n ter i n it mo d e () ; drvcan _ lea v e initm ode p ro t o t y pe v o id dr v c an_ l ea v e i n i tmo d e( v o id ) ; descript io n this function is used to set can to leave initialization mode to let bit timing configuration take effect after configuration ready. p a ra m et er no ne i nclu de dr iv er /dr v c a n .h ret urn va lue no n e e x a m p le / * leav e i n it m o d e an d to let th e b it - ti m i n g co n f i g u r atio n ta k e ef f ec t. */ dr v c an_ l ea v e i n i tmo d e () ; drvcan _ e nt e rte s tm ode p ro t o t y pe v o id dr v c an_ e n ter t estmo d e( u in t 8 _t u 8 t estmas k ) ; descript io n s w itc h s t h e c a n i n to test m o d e. t h er e ar e f o u r test m o d e ( b a sic /si l e nt /l oop b ac k/ l oop b ac k co m b i n ed sil e nt /c ont r ol _ t x_ pin ) co u ld b e s elec ted . a f ter s et tin g te s t m o d e, u s er m u s t c all dr v c a n _ l ea v ei n itmo d e( ) to let th e s e ttin g tak e e f f ec t. p a ra m et er u8 t estm a s k [ in] s p ec if ie s th e co n f i g u r atio n i n t est m o d es i t c o u ld b e c a n_ t e st r _ b a sic : e n ab le b asic m o d e o f test m o d e pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 234 - c a n_ t e st r _ sil e nt : e n ab le s ilen t m o d e o f test m o d e c a n_ t e st r _ l b a c k : e n ab le l o o p b ac k mo d e o f test m o d e c a n_ t e st r _ t x0 : se t lo w b it o f co n tr o l c an_ t x p in b it f ield c a n_ t e st r _ t x1 : se t h ig h b it o f co n tr o l c a n_ t x p in b it f eild i nclu de dr iv er /dr v c a n .h ret urn va lue no n e e x a m p le / * e n ter b asic m o d e o f test m o d e */ dr v c an_ e n ter t estmo d e ( c a n_ t e st _ b a sic ) ; drvcan _ lea v e t e s tm ode p ro t o t y pe v o id dr v c an_ l ea v et e s tmo d e( v o id ) ; descript io n t h is f u n ctio n is u s ed to l ea v e s th e c u r r en t te s t m o d e ( s w itc h in to n o r m al m o d e) . . p a ra m et er no n e i nclu de dr iv er /dr v c a n .h ret urn va lue no n e e x a m p le / * l ea v e te s t m o d e an d t h en e n ter n o r m al m o d e */ dr v c an_ l ea v et estmo d e () ; drvcan _ is new data r e c e i v e d p ro t o t y pe u in t3 2 _ t dr v c a n_ i s ne w d ata r ec eiv ed ( u i n t8 _ t u 8 m sg o b j ) ; descript io n t h is f u n ctio n is u s ed to g et t h e w aiti n g s tat u s o f a r ec eiv ed m es s ag e. pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 235 - p a ra m et er u8 m sg o bj [ in] s p ec if ie s th e me s s a g e o b j ec t n u m b er , f r o m 0 to 3 1 . i nclu de dr iv er / dr v c a n .h ret urn va lue a n o n - ze r o v al u e if t h e co r r esp o n d in g m es s ag e o b j ec t h as a n e w d ata b it is s et, else 0 . e x a m p le / * c h ec k m e s s a g e o b j ec t 0 is n o r ec eiv ed n e w m es s ag e */ if ( ! dr v c a n_ i s ne w da tar ec ei v ed ( 0 ) ; r etu r n f alse ; drvcan _ is txrqs tpe nding p ro t o t y pe u in t3 2 _ t dr v c a n_ i s t x r q s tp en d in g ( u i n t8 _ t u 8 m sg o b j ) ; descript io n t h is f u n ctio n is u s ed to g et t h e r eq u est p en d in g s tat u s o f a tr an s m itted m es s ag e. . p a ra m et er u8 m sg o bj [ in] s p ec if ie s th e me s s a g e o b j ec t n u m b er , f r o m 0 to 3 1 . i nclu de dr iv er /dr v c a n .h ret urn va lue a n o n - ze r o v al u e if t h e co r r esp o n d in g m es s ag e h as a n tx r eq u est p en d i n g , else 0 . e x a m p le / * c h ec k m e s s a g e o b j ec t 0 t r a n s m it r eq u e s t is se n t o r n o t */ if ( ! dr v c a n_ i s t x r q s tp en d i n g ( 0 ) ; r etu r n f alse ; drvcan _ is intpe ndin g p ro t o t y pe u in t3 2 _ t d r v c a n_ i s i n tp en d in g ( u i n t8 _ t u 8 m s g o o b j ) ; pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 236 - descript io n t h is f u n ctio n is u s ed to g et t h e in ter r u p t stat u s o f a m e s s a g e o b j ec t . p a ra m et er u8 m sg o bj [ in] s p ec if ie s th e me s s a g e o b j ec t n u m b er , f r o m 0 to 3 1 . i nclu de dr iv er /dr v c a n .h ret urn va lue a n o n - ze r o v al u e if t h e co r r esp o n d in g m es s ag e h as a n in ter r u p t p en d in g , else 0 . e x a m p le / * c h ec k m e s s a g e o b j ec t 0 in ter r u p t is p en d in g o r n o t */ if ( ! dr v c a n_ i s i n tp en d i n g ( 0 ) ; r etu r n f alse ; drvcan _ is obj e c tva li d p ro t o t y pe u in t3 2 _ t d r v c a n_ i s ob j ec tvalid ( u in t8 _ t u 8 m sg o b j ) ; descript io n t h is f u n ct io n is u s ed to test t h e v alid it y o f a m e s s a g e o b j ec t ( r ea d y to u s e) . . p a ra m et er u8 m sg o bj [ in] s p ec if ie s th e me s s a g e o b j ec t n u m b er , f r o m 0 to 3 1 . i nclu de dr iv er /dr v c a n .h ret urn va lue a n o n - ze r o v al u e if t h e co r r esp o n d in g m es s ag e o b j ec t is v alid , else 0 . ex a m p le / * c h ec k m e s s a g e o b j ec t 0 is v alied o r n o t */ if ( ! dr v c a n_ i s ob j ec tvalid ( 0 ) ; r etu r n f alse ; pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 237 - drvcan _ res e t if p ro t o t y pe v o id dr v c an_ r eset i f( u i n t8 _ t u 8 i f_ nu m ) ; descript io n t h is f u n ctio n is u s ed to r eset m es s ag e i n ter f ac e p ar a m eter s . . p a ra m et er u8 i f _ nu m [i n] s p ec if ie s th e me s s a g e c o n tr o l i n ter f ac e, 0 o r 1 i nclu de dr iv er /dr v c a n .h ret urn va lue no n e e x a m p le / * r e s et in ter f ac e 0 all s etti n g r eg is ter v a lu e */ dr v c an_ r eset i f( 0 ) ; drvcan _ w a itm s g p ro t o t y pe v o id dr v c an_ w aitmsg ( v o id ) ; descript io n t h is f u n ctio n is u s e d to w a it m es s ag e i n to m e s s a g e b u f f er in b asic m o d e. p lease n o tice th e f u n ctio n is p o llin g ne w d a t b it o f mcon r eg is ter b y w h il e lo o p an d it is u s ed in b asic m o d e . p a ra m et er no n e i nclu de dr iv er /dr v c a n .h ret urn va lue no n e e x a m p le / * w ait n e w m es s ag e i n to m e s s ag e r a m */ dr v c an_ w aitmsg ( ) ; p r in tf ( ne w data i n \ n ); pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 238 - drvcan _ e nabl e int p ro t o t y pe in t3 2 _ t d r v c an_ e n ab lei n t( u i n t1 6 _ t u 1 6 i n ten ab le) ; descript io n e n ab le c a n i n ter r u p t a n d nv i c co r r esp o n d in g to c a n . p a ra m et er u1 6 i nten a ble [ in] i n ter r u p t e n ab le ( c a n_ c on _ i e o r c a n_ c on _ sie o r c an_ c on _ e i e ) . i t c o u ld b e c a n_ c o n_ i e : m o d u le i n ter r u p t e n ab le c a n_ c o n_ sie : statu s c h a n g e i n ter r u p t e n ab le c a n_ c o n_ e i e : e r r o r i n ter r u p t e n ab le i nclu de dr iv er /dr v c a n .h ret urn va lue e _ suc c e ss : s u cc es s e x a m p le / * i n ter r u p t e n ab le */ dr v c an_ e n ab lei n t( c a n_ c on _ i e ) ; drvcan _ dis a ble int p ro t o t y pe in t3 2 _ t d r v c an_ dis ab lei n t( u in t1 6 _ t u 1 6 i n ten ab le) ; descript io n dis ab le c a n i n ter r u p t a n d nvi c co r r esp o n d in g to c an . p a ra m et er u1 6 i nten a ble [ in] i n ter r u p t e n ab le ( c a n_ c on _ i e o r c a n_ c on _ sie o r c an_ c on _ e i e ) . c a n_ c on _ i e : m o d u le in ter r u p t e n ab le c a n_ c on _ sie : statu s ch a n g e in ter r u p t e n ab le c a n_ c on _ e ie : e r r o r in ter r u p t e n ab le i nclu de dr iv er /dr v c a n .h pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 239 - ret urn va lue no n e. e x a m p le / * i n ter r u p t d i s ab le */ dr v c an_ dis ab lei n t( c a n_ c on _ i e ) ; drvcan _ ins tall cal lba c k p ro t o t y pe in t3 2 _ t d r v c an_ i n s tal lc allb ac k ( e _ c a n_ c al l b ac k_ t yp e t y p e, c a n_ c al l b ac k ca llb ac k f n ) ; descript io n i n s tall c a n ca ll b ac k f u n ct io n f o r c a n n o r m al f u n ctio n m sg,rxo k, t xok, e w a r n , b off,w a ke up . p a ra m et er t y pe [ in] e _ c an_ c al l b a c k_ t yp e ( c al l b ac k_ r xo k o r c al l b a c k_ t x ok o r c al l b ac k_ e w a r n o r c al l b a c k_ b of f o r c al l b ac k_ msg o r c al l b ac k_ w a ke up ) . mo r e d etail p lease r ef t ab le 1 0 . 1 ca llb a ck [ in] ca llb ac k f u n ctio n p o in ter i nclu de dr iv er /dr v c a n .h ret urn va lue e _ suc c e ss : s u cc es s e _ e _ dr vc a n_ e r r _ a r g um e nt : failed e x a m p le / * i n s ta ll m es s ag e c al lb ac k f u n ctio n t estf n ms g */ dr v c an_ i n s tal lc allb ac k ( c al l b a c k_ ms g, ( c a n_ c al l b a c k) t estf n ms g ); drvcan _ uninsta ll cal lba c k p ro t o t y pe in t3 2 _ t d r v c an_ un i n s ta llc a llb ac k ( e _ c a n_ c al l b ac k _ t y p e t y p e) ; descript io n t h e f u n c tio n i s u s ed to u n i n s t all ex is t c a llb ac k f u n ctio n p o in ter . p a ra m et er pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 240 - t y pe [ in] e _ c an_ c al l b a c k_ t yp e ( c al l b ac k_ r xo k o r c al l b a c k_ t xok o r c al l b ac k_ e w a r n o r c al l b a c k_ b of f o r c al l b ac k_ msg o r c al l b ac k_ w a ke up ) . mo r e d etail p lease r ef t ab le 1 0 . 1 i nclu de dr iv er /dr v c a n .h ret urn va lue e _ suc c e ss : s u cc es s e _ e _ dr vc a n_ e r r _ a r g um e nt : failed e x a m p le /* remove all message object callback function pointer */ drvcan_uninstallcallback( callback_msg ); drvcan _ e nabl e w a k e up p ro t o t y pe v o id dr v c an_ e n ab le w ak eu p ( v o id ) ; descript io n t h e f u n c tio n i s u s ed to en ab le w a k e u p f u n ctio n . p a ra m et er no ne i nclu de dr iv er /dr v c a n .h ret urn va lue no n e e x a m p le / * e n ab le w a k e - u p f u n ctio n */ dr v c an_ e n ab le w ak eup () ; drvcan _ dis a ble w a k e up p ro t o t y pe v o id dr v c an_ dis ab le w ak e up ( v o id ) ; descript io n t h e f u n c tio n i s u s ed to d is ab le w a k eu p f u n ctio n . pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 241 - p a r a m et er no ne i nclu de dr iv er /dr v c a n .h ret urn va lue no n e e x a m p le / * dis ab le w a k e - u p f u n ctio n */ dr v c an_ dis ab le w ak eup () drvcan _ ge tc an bit rate p ro t o t y pe in t3 2 _ t dr v c an_ getc anb itr ate ( v o id ) ; descript io n r etu r n cu r r en t c a n b itra te ac co r d in g to u s er b it - ti m in g p ar am eter s etti n g s . p a ra m et er no ne i nclu de dr iv er /dr v c a n .h ret urn va lue c u r r en t b it - r ate ( k ilo b it p er s ec o n d ) e x a m p le / * g e t c u r r e n t c an b it r ate */ in t3 2 i3 2 b itra te; i3 2 b itra te = d r v c a n_ get c a nb it r ate () ; drvcan _ ge tt x e rrco unt p ro t o t y pe u in t3 2 _ t d r v c a n_ get t x e r r c o u n t( v o id ) ; descript io n pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 242 - t h e f u n c tio n i s u s ed to g et c u r r en t tr an s m i t e r r o r co u n ter ( t e c ) p a ra m et er no ne i nclu de dr iv er /dr v c a n .h ret urn va lue c u r r en t t r an s m it e r r o r c o u n t er ( t e c ) e x a m p le / * g e t c u r r e n t t r an s m it e r r o r c o u n ter ( t e c ) */ in t3 2 i3 2 t x e r r c n t i3 2 t x e r r c n t = dr v c an_ gett x e r r c o u n t (); drvcan _ ge tr x e rrco unt p ro t o t y pe u in t3 2 _ t d r v c a n_ get r x e r r c o u n t( v o id ) ; descript io n t h e f u n c tio n i s u s ed to g et c u r r en t r ec eiv e er r o r co u n ter ( r e c ) p a ra m et er no ne i nclu de dr iv er /dr v c a n .h ret urn va lue c u r r en t r ec ei v e er r o r c o u n te r ( r e c ) e x a m p le / * g e t c u r r e n t r ec eiv e e r r o r c o u n ter ( r e c ) */ in t3 2 i3 2 r x e r r c n t i3 2 r x e r r c n t = dr v c a n_ g et r x e r r c o u n t (); drvcan _ ge tve rs ion p ro t o t y pe u in t3 2 _ t dr v c a n _ getve r s io n ( v o id ); pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 243 - descript io n get th i s m o d u le ? s v er s io n . p a ra m et er no n e i nclu de dr iv er /dr v c a n .h ret urn va lue can driver current version number : 31:24 23:16 15:8 7:0 00000000 major_num minor_num build_num e x a m p le / * get c an d r iv er cu r r en t v er s io n n u m b er * / in t3 2 _ t i3 2 c a n ver s io n n u m ; i3 2 c a n ver s io n n u m = dr v c a n _ get ver s io n (); pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 244 - 11. pwm dri ver 11.1. pwm introduction t h e b asic co m p o n e n ts i n a p w m s et is p r e - s ca ler , clo ck d iv id er , 1 6 - b it co u n ter , 1 6 - b it co m p ar ato r , in v er ter , d ea d - zo n e g e n er ato r . t h e y ar e all d r iv en b y en g i n e clo ck s o u r ce . t h er e ar e f o u r en g i n e clo ck s o u r ce s , i n clu d ed 1 2 mh z cr y s tal clo c k , 3 2 khz cr y s tal c lo ck , hc l k, a n d in ter n al 2 2 mh z clo c k . c lo ck d i v id er p r o v id es t h e c h an n el w it h 5 clo ck s o u r ce s ( 1 , 1 /2 , 1 /4 , 1 / 8 , 1 /1 6 ) . e ac h p w m - ti m er r ec eiv es i ts o w n clo ck s i g n al f r o m c lo ck d i v id er w h ich r ec ei v es c lo c k f r o m 8 - b it p r e - s ca le r . t h e 16 - b it co u n ter i n ea ch ch a n n el r ec ei v e clo ck s i g n al f r o m c lo ck s el ec to r an d ca n b e u s ed to h an d le o n e p w m p er io d . t h e 1 6 - b it co m p ar ato r co m p ar es n u m b er i n co u n ter w it h t h r esh o ld n u m b er i n r eg i s ter lo ad e d p r ev io u s l y to g e n er ate p w m d u t y c y cle . t o p r ev en t p w m d r iv in g o u t p u t p in w it h u n s tead y w av e f o r m , 1 6 - b it co u n ter an d 1 6 - b it co m p ar ato r ar e im p le m en ted w it h d o u b le b u f f er i n g f ea t u r e. user ca n f ee l f r ee to w r ite d ata to c o u n ter b u f f er r eg is ter an d co m p ar ato r b u f f er r eg is ter w it h o u t g en er ati n g g l itch . w h en 1 6 - b it d o w n co u n ter r e ac h es ze r o , t h e i n ter r u p t r eq u e s t is g e n er ated to i n f o r m c p u th at ti m e is u p . w h en co u n ter r ea ch e s ze r o , if co u n ter is s et as au to - r el o ad m o d e, it is r elo ad e d au to m atica ll y an d s tar t to g en er ate n ex t c y cle. user ca n s et co u n ter as o n e - s h o t m o d e in s tead o f au to - r elo ad m o d e. i f co u n ter i s s e t as o n e - s h o t m o d e, co u n ter w il l s to p a n d g e n er ate o n e i n ter r u p t r eq u e s t w h en it r ea ch es ze r o . 11.2. pw m feat ures the pwm controller includes following features : ? ? up to tw o p w m g r o u p ( pw ma /p w mb ) . please refer to numicro tm nuc100 series products selection guide of appendix to know the number of pwm group. ? ? each pwm group has two pwm generators. each pwm generator s upports one 8 - bit prescaler, one clock divider, two pwm - timer s ( down counter), one dead - zone generator and two pwm outputs . ? ? one - shot or auto - reload pwm mode. ? ? up to eight capture input channels. ? ? e ac h ca p tu r e in p u t c h a n n el s u p p o r ts r is in g / f alli n g latc h r eg i s ter an d ca p tu r e in ter r u p t f la g . pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 245 - 11.3. con s tan t de fin i ti on constant name value description drvpwm_timer0 0x 0 0 p wm timer 0 drvpwm_timer1 0x 01 p wm timer 1 drvpwm_timer 2 0x 02 p wm timer 2 drvpwm_timer 3 0x 03 p wm timer 3 drvpwm_timer 4 0x 04 p wm timer 4 drvpwm_timer 5 0x 05 p wm timer 5 drvpwm_timer 6 0x 06 p wm time r 6 drvpwm_timer 7 0x 07 p wm timer 7 drvpwm_cap0 0x 1 0 p wm capture 0 drvpwm_cap 1 0x 11 p wm capture 1 drvpwm_cap 2 0x 12 p wm capture 2 drvpwm_cap 3 0x 13 p wm capture 3 drvpwm_cap 4 0x 14 p wm capture 4 drvpwm_cap 5 0x 15 p wm capture 5 drvpwm_cap 6 0x 16 p wm captur e 6 drvpwm_cap 7 0x 17 p wm capture 7 drvpwm_cap_ all _int 3 pwm capture rising and falling interrupt drvpwm_cap_rising_int 1 pwm capture rising interrupt drvpwm_cap_falling_int 2 pwm capture falling interrupt drvpwm_cap_rising_flag 6 capture rising interr upt flag drvpwm_cap_falling_flag 7 capture falling interrupt flag drvpwm_clock_div_1 4 input clock divided by 1 drvpwm_clock_div_2 0 input clock divided by 2 drvpwm_clock_div_ 4 1 input clock divided by 4 drvpwm_clock_div_ 8 2 input clock divided by 8 drvpwm_clock_div_ 16 3 input clock divided by 16 drvpwm_ext_12m 0 pwm clock source from external 12m crystal drvpwm_ext_32k 1 pwm clock source from external 32k crystal drvpwm_hclk 2 pwm clock source from hclk drvpwm_internal_22m 3 pwm clock source from internal 22mhz oscillator drvpwm_ auto_reload _mode 1 pwm timer auto - reload mode drvpwm_one_shot_mode 0 pwm timer one - shot mode ` pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 246 - 11.4. functions drvp w m _ is time r e na ble d p ro t o t y pe in t3 2 _ t dr v p w m_ i s t im er e n ab led ( u in t8 _ t u 8 t i m er ) ; descript io n t h is f u n ctio n is u s e d to g et p w m s p ec if ied ti m er e n ab le/d is ab le s tate p a ra m et er u8 t i m er [ in] sp ec if y th e ti m er . dr v p w m_ t i me r 0 : p w m t i m er 0 . dr v p w m_ t i me r 1 : p w m t i m er 1 . dr v p w m_ t i me r 2 : p w m t i m er 2 . dr v p w m_ t i me r 3 : p w m t i m er 3 . dr v p w m_ t i me r 4 : p w m t i m er 4 . dr v p w m_ t i me r 5 : p w m t i m er 5 . dr v p w m_ t i me r 6 : p w m t i m er 6 . dr v p w m_ t i me r 7 : p w m t i m er 7 . i nclu de dr iv er / dr v p w m .h ret urn va lue 1 : t h e s p ec if ied ti m er is en ab l ed . 0 : t h e s p ec if ied ti m er is d is ab led . e x a m p le in t3 2 _ t i3 2 s tate ; / * c h ec k if p w m ti m er 3 is e n ab led o r n o t * / if ( dr v p w m_ i s t im er e n ab led ( dr v p w m_ t i me r 3 ) == 1 ) p r in tf ( p w m ti m er 3 is en ab le d ! \ n ); else if ( dr v p w m_ i s t im er e n a b led ( dr v p w m_ t i me r 3 ) = =0 ) p r in tf ( p w m ti m er 3 is d is ab led ! \ n ); drvp w m _ s e tt im e rc ount e r p ro t o t y pe v o id dr v p w m_ set t im er c o u n ter ( u i n t8 _ t u 8 t i m er , u i n t1 6 _ t u 1 6 c o u n ter ) ; pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 247 - descript io n t h is f u n ctio n is u s ed to s et th e p w m s p ec if ied ti m er co u n ter . p a ra m et er u8 t i m er [ in] sp ec if y th e ti m er . dr v p w m_ t i me r 0 : p w m t i m er 0 . dr v p w m_ t i me r 1 : p w m t i m er 1 . dr v p w m_ t i me r 2 : p w m t i m er 2 . dr v p w m_ t i me r 3 : p w m t i m er 3 . dr v p w m_ t i me r 4 : p w m t i m er 4 . dr v p w m_ t i me r 5 : p w m t i m er 5 . dr v p w m_ t i me r 6 : p w m t i m er 6 . dr v p w m_ t i me r 7 : p w m t i m er 7 . u1 6 co un t er [ in] sp ec if y th e ti m er v a lu e. ( 0 ~6 5 5 3 5 ) . i f th e co u n ter is s et to 0 , th e ti m er w ill s to p . i nclu de dr iv er /dr v p w m. h ret urn va lue no n e e x a m p le / * set 1 0 0 0 0 to p w m tim er 3 co u n ter r eg i s ter . w h en t h e p w m ti m er 3 s tar t to co u n t d o w n , p w m tim er 3 w ill co u n t d o w n f r o m 1 0 0 0 0 to 0 . i f pw m tim er 3 is s et to au to - r elo ad m o d e, th e p w m ti m er 3 w ill r elo ad 1 0 0 0 0 t o pw m tim er 3 co u n ter r eg is ter af ter p w m tim er 3 co u n t d o w n to 0 an d p w m tim er 3 w il l co n ti n u e to co u n t d o w n f r o m 1 0 0 0 0 to 0 ag ain . */ dr v p w m_ sett im er c o u n ter ( dr v p w m_ t i me r 3 , 1 0 0 0 0 ); drvp w m _ ge tt im e rc ount e r p ro t o t y pe u in t3 2 _ t dr v pw m_ get t im er c o u n ter ( u in t8 _ t u 8 t i m er ) ; descript io n t h is f u n ctio n is u s ed to g et t h e p w m s p ec if ied ti m er co u n te r v alu e p a ra m et er u8 t i m er [ in] sp ec if y th e ti m er . dr v p w m_ t i me r 0 : p w m t i m er 0 . dr v p w m_ t i me r 1 : p w m t i m er 1 . dr v p w m_ t i me r 2 : p w m t i m er 2 . dr v p w m_ t i me r 3 : p w m t i m er 3 . dr v p w m_ t i me r 4 : p w m t i m er 4 . pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 248 - dr v p w m_ t i me r 5 : p w m t i m er 5 . dr v p w m_ t i me r 6 : p w m t i m er 6 . dr v p w m_ t i me r 7 : p w m t i m er 7 . i nclu de dr iv er / dr v p w m .h ret urn va lue t h e s p ec if ied ti m er co u n ter v a lu e . e x a m p le / * get p w m ti m er 5 co u n ter v alu e. */ u in t3 2 _ t u 3 2 r etva lt i m er 5 c o u n ter va lu e; u 3 2 r etva lt i m er 5 c o u n ter val u e = dr v p w m_ gett im er c o u n ter ( dr v p w m_ t i me r 5 ) ; drvp w m _ e nabl e int p ro t o t y pe v o id dr v p w m_ e n ab lei n t( u i n t8 _ t u 8 t im er , u in t8 _ t u 8 i n t, p fn_ dr vp w m_ c al l b ac k p f n ca llb ac k ) ; descript io n t h is f u n ctio n is u s ed to e n ab le th e p w m ti m er /cap tu r e in ter r u p t an d in s tall t h e ca ll b ac k f u n c tio n . p a ra m et er u8 t i m er [ in] sp ec if y th e ti m er dr v p w m_ t i me r 0 : p w m t i m er 0 . dr v p w m_ t i me r 1 : p w m t i m er 1 . dr v p w m_ t i me r 2 : p w m t i m er 2 . dr v p w m_ t i me r 3 : p w m t i m er 3 . dr v p w m_ t i me r 4 : p w m t i m er 4 . dr v p w m_ t i me r 5 : p w m t i m er 5 . dr v p w m_ t i me r 6 : p w m t i m er 6 . dr v p w m_ t i me r 7 : p w m t i m er 7 . o r th e ca p tu r e. dr vp w m_ c a p 0 : p w m ca p t u r e 0 . dr vp w m_ c a p 1 : p w m ca p t u r e 1 . dr vp w m_ c a p 2 : p w m ca p t u r e 2 . dr vp w m_ c a p 3 : p w m ca p t u r e 3 . dr vp w m_ c a p 4 : p w m ca p t u r e 4 . dr vp w m_ c a p 5 : p w m ca p t u r e 5 . dr vp w m_ c a p 6 : p w m ca p t u r e 6 . dr vp w m_ c a p 7: p w m ca p t u r e 7 . u8 i nt [ in] sp ec if y th e ca p t u r e in ter r u p t t y p e ( t h e p ar a m eter is v a lid o n l y w h en ca p tu r e f u n ctio n ) pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 249 - drvpwm_cap_rising_int : the capture rising interrupt. drvpwm_cap_falling_int : the capture falling interrupt. drvpwm_cap_all_int : all captu re interrupt. pfnca llb a c k [ in] t h e p o in ter o f th e ca llb ac k f u n ctio n f o r s p ec if ied ti m er / c ap tu r e . i nclu de dr iv er / dr v p w m .h ret urn va lue no n e e x a m p le / * e n ab le p w m ca p tu r e 5 f al lin g ed g e i n ter r u p t a n d i n s tal l dr vp w m_ c ap i r qha n d ler ( ) as it? s i n ter r u p t c allb a c k f u n ctio n . */ drvpwm_enableint( drvpwm_cap 5 , drvpwm_cap_falling_int , drvpwm_capirqhandler); drvp w m _ dis a ble int p ro t o t y pe v o id dr v p w m_ dis ab lei n t( u in t8 _ t u 8 t im er ) ; descript io n t h is f u n ctio n is u s ed to d is ab le th e p w m ti m er /cap tu r e in ter r u p t . p a ra m et er u8 t i m er [ in] sp ec if y th e ti m er dr v p w m_ t i me r 0 : p w m t i m er 0 . dr v p w m_ t i me r 1 : p w m t i m er 1 . dr v p w m_ t i me r 2 : p w m t i m er 2 . dr v p w m_ t i me r 3 : p w m t i m er 3 . dr v p w m_ t i me r 4 : p w m t i m er 4 . dr v p w m_ t i me r 5 : p w m t i m er 5 . dr v p w m_ t i me r 6 : p w m t i m er 6 . dr v p w m_ t i me r 7 : p w m t i m er 7. o r th e ca p tu r e. dr vp w m_ c a p 0 : p w m ca p t u r e 0 . dr vp w m_ c a p 1 : p w m ca p t u r e 1 . dr vp w m_ c a p 2 : p w m ca p t u r e 2 . dr vp w m_ c a p 3 : p w m ca p t u r e 3 . dr vp w m_ c a p 4 : p w m ca p t u r e 4 . dr vp w m_ c a p 5 : p w m ca p t u r e 5 . dr vp w m_ c a p 6 : p w m ca p t u r e 6 . dr vp w m_ c a p 7 : p w m ca p t u r e 7 . pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 250 - i ncl u de dr iv er / dr v p w m .h ret urn va lue no n e e x a m p le / * dis ab le p w m c ap tu r e 5 in t er r u p ts in cl u d in g r is i n g an d f a llin g in ter r u p t so u r ce an d al s o u n i n s tall p w m c ap tu r e 5 r is in g an d f a lli n g i n ter r u p t c allb ac k f u n ctio n s . */ dr v p w m_ dis ab lei n t ( dr vp w m_ c a p 5 ) ; / * dis ab le p w m ti m er 5 in ter r u p t a n d u n i n s tal l p w m tim er 5 ca llb ac k f u n ctio n . */ dr v p w m_ dis ab lei n t ( dr v p w m_ t i me r 5 ); drvp w m _ cle a r int p ro t o t y pe v o id dr v p w m_ c lear i n t( u in t8 _ t u 8 t im er ) ; descript io n t h is f u n ctio n is u s ed to clea r th e p w m ti m er /cap tu r e in ter r u p t f lag . p a ra m et er u8 t i m er [ in] sp ec if y th e ti m er dr v p w m_ t i me r 0 : p w m t i m er 0 . dr v p w m_ t i me r 1 : p w m t i m er 1 . dr v p w m_ t i me r 2 : p w m t i m er 2 . dr v p w m_ t i me r 3 : p w m t i m er 3 . dr v p w m_ t i me r 4 : p w m t i m er 4 . dr v p w m_ t i me r 5 : p w m t i m er 5 . dr v p w m_ t i me r 6 : p w m t i m er 6 . dr v p w m_ t i me r 7 : p w m t i m er 7 . o r th e ca p tu r e. dr vp w m_ c a p 0 : p w m ca p t u r e 0 . dr vp w m_ c a p 1 : p w m ca p t u r e 1 . dr vp w m_ c a p 2 : p w m ca p t u r e 2 . dr vp w m_ c a p 3 : p w m ca p t u r e 3 . dr vp w m_ c a p 4 : p w m ca p t u r e 4 . dr vp w m_ c a p 5 : p w m ca p t u r e 5 . dr vp w m_ c a p 6 : p w m ca p t u r e 6 . dr vp w m_ c a p 7 : p w m ca p t u r e 7 . i nclu de dr iv er / dr v p w m .h ret urn va lue pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 251 - no n e e x a m p le / * c lear p w m ti m er 1 in ter r u p t f lag . */ dr v p w m_ c lear i n t ( dr vp w m_ t i me r 1 ); / * c lear p w m c ap tu r e 0 in ter r u p t f la g . */ dr v p w m_ c lear i n t ( dr vp w m_ c a p 0 ); drvp w m _ ge tint fla g p ro t o t y pe in t3 2 _ t dr v p w m_ geti n tfl ag ( u in t8 _ t u 8 t im er ) ; descript io n t h is f u n ctio n is u s ed to g et t h e p w m tim er /cap tu r e i n ter r u p t f la g p a ra m et er u8 t i m er [ in] sp ec if y th e ti m er dr v p w m_ t i me r 0 : p w m t i m er 0 . dr v p w m_ t i me r 1 : p w m t i m er 1 . dr v p w m_ t i me r 2 : p w m t i m er 2 . dr v p w m_ t i me r 3 : p w m t i m er 3 . dr v p w m_ t i me r 4 : p w m t i m er 4 . dr v p w m_ t i me r 5 : p w m t i m er 5 . dr v p w m_ t i me r 6 : p w m t i m er 6 . dr v p w m_ t i me r 7 : p w m t i m er 7 . o r th e ca p tu r e. dr vp w m_ c a p 0 : p w m ca p t u r e 0 . dr vp w m_ c a p 1 : p w m ca p t u r e 1 . dr vp w m_ c a p 2 : p w m ca p t u r e 2 . dr vp w m_ c a p 3 : p w m ca p t u r e 3 . dr vp w m_ c a p 4 : p w m ca p t u r e 4 . dr vp w m_ c a p 5 : p w m ca p t u r e 5 . dr vp w m_ c a p 6 : p w m ca p t u r e 6 . dr vp w m_ c a p 7 : p w m ca p t u r e 7 . i nclu de dr iv er / dr v p w m .h ret urn va lue 1 : t h e s p ec if ied in ter r u p t o cc u r s . 0 : t h e s p ec if ied in ter r u p t d o esn ? t o cc u r . e x a m p le / * get p w m ti m er 6 in ter r u p t f la g . */ pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 252 - if ( dr v p w m_ geti n tfl a g ( d r v p w m_ t i me r 6 ) == 1 ) p r in tf ( p w m ti m er 6 in ter r u p t o cc u r s ! \ n ) ; e ls e if ( dr v p w m_ geti n tfl a g ( dr v p w m_ t i me r 6 ) == 0 ) p r in tf ( p w m ti m er 6 in ter r u p t d o s en ? t o cc u r ! \ n ) ; drvp w m _ ge tr is ingc ount e r p ro t o t y pe u in t1 6 _ t d r v p w m_ getri s in g c o u n ter ( u i n t 8 _ t u 8 c ap t u r e) ; descript io n t h is f u n ctio n is u s ed to g et v a lu e w h ich latc h e s th e co u n ter w h e n th er e ? s a r is i n g tr an s itio n . p a ra m et er u8 ca pture [ in] sp ec if y th e ca p t u r e. dr vp w m_ c a p 0 : p w m ca p t u r e 0 . dr vp w m_ c a p 1 : p w m ca p t u r e 1 . dr vp w m_ c a p 2 : p w m ca p t u r e 2 . dr vp w m_ c a p 3 : p w m ca p t u r e 3 . dr vp w m_ c a p 4 : p w m ca p t u r e 4 . dr vp w m_ c a p 5 : p w m ca p t u r e 5 . dr vp w m_ c a p 6 : p w m ca p t u r e 6 . dr vp w m_ c a p 7 : p w m ca p t u r e 7 . i nclu de dr iv er / dr v p w m .h ret urn va lue t h e v alu e w as latc h e d f r o m p w m ca p tu r e cu r r en t co u n ter w h e n th er e ? s a r is i n g tr an s itio n . e x a m p le / * get p w m ca p tu r e 7 r is in g l atch r eg i s ter v al u e . */ u in t1 6 _ t u 1 6 r etva l t i m er 7 r is in g l a tch va lu e; u 1 6 r etva l t i m er 7 r i s in g l atc h valu e = dr v p w m_ getri s in g c o u n ter ( dr vp w m_ c a p 7 ); drvp w m _ ge tf a ll ing cou nt e r p ro t o t y pe u in t1 6 _ t d r v p w m_ getfa llin g c o u n ter ( u in t8 _ t u 8 c ap tu r e) ; descript io n t h is f u n ctio n is u s ed to g et v a lu e w h ich latc h e s th e co u n ter w h e n th er e ? s a f all i n g tr a n s it io n . pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 253 - p a ra m et er u8 ca pture [ in] sp ec if y th e ca p t u r e. dr vp w m_ c a p 0 : p w m ca p t u r e 0 . dr vp w m_ c a p 1 : p w m ca p t u r e 1 . dr vp w m_ c a p 2 : p w m ca p t u r e 2 . dr vp w m_ c a p 3 : p w m ca p t u r e 3 . dr vp w m_ c a p 4 : p w m ca p t u r e 4 . dr vp w m_ c a p 5 : p w m ca p t u r e 5 . dr vp w m_ c a p 6 : p w m ca p t u r e 6 . dr vp w m_ c a p 7 : p w m ca p t u r e 7 . i nclu de dr iv er / dr v p w m .h ret urn va lue t h e v alu e w as latc h e d f r o m p w m ca p tu r e cu r r en t co u n ter w h e n th er e ? s a f all i n g tr a n s it io n . e x a m p le /* get p w m ca p tu r e 7 f allin g latch r eg i s ter v al u e . */ u in t1 6 _ t u 1 6 r etva lt i m er 7 fal l in g l atch valu e ; u 1 6 r etva lt i m er 7 fall i n g l a tc h val u e = dr v p w m_ get fall i n g c o u n ter ( d r vp w m_ c a p 7 ); drvp w m _ ge tc a pt ure intstatus p ro t o t y pe in t3 2 _ t d r v p w m_ getcap tu r ei n tst at u s ( u in t8 _ t u 8 c ap tu r e, u i n t8 _ t u 8 i n tt y p e) ; descript io n c h ec k i f th er e ? s a r is i n g / f al li n g tr a n s it io n p a ra m et er u8 ca pture [ in] sp ec if y th e ca p t u r e. dr vp w m_ c a p 0 : p w m ca p t u r e 0 . dr vp w m_ c a p 1 : p w m ca p t u r e 1 . dr vp w m_ c a p 2 : p w m ca p t u r e 2 . dr vp w m_ c a p 3 : p w m ca p t u r e 3 . dr vp w m_ c a p 4 : p w m ca p t u r e 4 . dr vp w m_ c a p 5 : p w m ca p t u r e 5 . dr vp w m_ c a p 6 : p w m ca p t u r e 6 . dr vp w m_ c a p 7 : p w m ca p t u r e 7 . u8 i ntty pe [ in] sp ec if y th e c ap tu r e l atch ed i n d icato r . pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 254 - drvpwm_cap_rising_flag : the capture rising indicator f lag. drvpwm_cap_falling_flag : the capture falling indicator flag. i nclu de dr iv er / dr v p w m . h ret urn va lue t r ue : t h e s p ec if ied tr an s itio n o cc u r s . f a l se: t h e s p ec if ied tr an s iti o n d o esn ? t o cc u r . e x a m p le / * get p w m ca p tu r e 5 r is in g t r an s itio n f la g . */ if ( dr v p w m _ getcap tu r ei n tst atu s ( d r vp w m_ c a p 5 , dr vp w m_ c a p _ r i s i ng_ flag ) == t r ue ) p r in tf ( p w m ca p tu r e 5 r is in g tr an s itio n o cc u r s ! \ n ) ; else if ( dr v p w m_ getcap tu r ei n tst at u s ( dr vp w m_ c a p 5 , dr vp w m_ c a p _ r i s i ng_ f l a g) == f al se) p r in tf ( p w m ca p tu r e 5 r is in g tr an s itio n d o esn ? t o cc u r ! \ n ) ; drvp w m _ cle a r captu re intstatus p ro t o t y pe v o id dr v p w m_ c lear c ap tu r ei n tst atu s ( u in t8 _ t u 8 c ap tu r e, u in t8 _ t u 8 i n tt y p e) ; descript io n c lear th e r is i n g / f a llin g tr a n s i tio n in d icato r f la g p a ra m et er u8 ca pture [ in] sp ec if y th e ca p t u r e. dr vp w m_ c a p 0 : p w m ca p t u r e 0 . dr vp w m_ c a p 1 : p w m ca p t u r e 1 . dr vp w m_ c a p 2 : p w m ca p t u r e 2 . dr vp w m_ c a p 3 : p w m ca p t u r e 3 . dr vp w m_ c a p 4 : p w m ca p t u r e 4 . dr vp w m_ c a p 5 : p w m ca p t u r e 5 . dr vp w m_ c a p 6 : p w m ca p t u r e 6 . dr vp w m_ c a p 7 : p w m ca p t u r e 7 . u8 i ntty pe [ in] sp ec if y th e c ap tu r e l atch ed i n d icato r . drvpwm_cap_rising_flag : the capture rising indicator flag. drvpwm_cap_falling_flag : the capture falling indicator flag. i nclu de dr iv er / dr v p w m . h pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 255 - ret urn va lue no n e e x a m p le / * c lear p w m ca p tu r e 5 f allin g tr an s itio n f la g . */ dr v p w m_ c lear c ap tu r ei n t sta tu s ( d r vp w m_ c a p 5 , dr vp w m_ c a p _ f al l i ng_ f l a g ) ; drvp w m _ ope n p ro t o t y pe v o id dr v p w m_ op en ( v o id ) ; descript io n e n ab le p w m en g in e clo c k an d r eset p w m . i nclu de dr iv er /dr v p w m. h ret urn va lue no n e e x a m p le / * e n ab le p w m en g i n e clo ck an d r eset p w m en g in e . * / dr v p w m_ op en ( ) ; dr v p w m _ clos e p ro t o t y pe v o id dr v p w m_ c lo s e( v o id ) ; descript io n dis ab le p w m en g i n e clo ck an d th e c ap tu r e i n p u t / p w m ou tp u t e n ab le f u n c tio n . i nclu de dr iv er /dr v p w m. h ret urn va lue no n e e x a m p le / * dis ab le p w m ti m er 0 ~7 o u tp u t, p w m c ap tu r e 0 ~7 o u tp u t an d d is ab le p w m en g in e clo c k . */ dr v p w m_ c lo s e ( ); pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 256 - drvp w m _ e nabl e de a dzon e p ro t o t y pe v o id dr v p w m_ e n ab lede ad z o n e( u in t8 _ t u 8 t i m er , u in t8 _ t u 8 l e n g th , i n t3 2 _ t i3 2 e n ab lede ad z o n e) ; descript io n t h is f u n ctio n is u s ed to s et th e d ea d zo n e len g th a n d en ab le/ d is ab le dea d z o n e f u n cti on. p a ra m et er u8 t i m er [ in] sp ec if y th e ti m er dr v p w m_ t i me r 0 o r dr v p w m_ t i me r 1 : p w m tim er 0 & p w m tim er 1 . dr v p w m_ t i me r 2 o r dr v p w m_ t i me r 3 : p w m tim er 2 & p w m tim er 3 . dr v p w m_ t i me r 4 o r dr v p w m_ t i me r 5 : p w m tim er 4 & p w m tim er 5 . dr v p w m_ t i me r 6 o r dr v p w m_ t i me r 7 : p w m tim er 6 & p w m tim er 7 . u8 l eng t h [ in] sp ec if y dea d z o n e l e n g th : 0 ~2 5 5 . t h e u n it is o n e p er io d o f p w m clo ck . i3 2 e na bledea d z o ne [ in] e n ab le dea d z o n e ( 1 ) / d iasb l e dea d z o n e ( 0 ) i nclu de dr iv er / dr v p w m .h ret urn va lue no n e e x a m p le / * e n ab le p w m t i m er 0 an d t i m e 1 dea d - z o n e f u n ctio n . p w m t i m er 0 an d p w m t im er 1 b ec am e a co m p le m e n tar y p air . set d ea d - z o n e ti m e le n g t h to 1 0 0 an d th e u n it ti m e o f dead - z o n e len g t h w h ich i s t h e s a m e as t h e u n it o f r ec eiv ed p w m tim er clo ck . */ u in t8 _ t u 8 dea d z o n e l e n g th = 1 0 0 ; dr v p w m_ e n ab lede ad z o n e ( dr v p w m_ t i me r 0 , u 8 dea d z o n e l e n g th , 1 ); sa m ple c o de / * e n ab le t i m er 0 an d t i m er 1 dea d - z o n e f u n ctio n an d s et d ea d - z o n e i n ter v al to 5 u s . dea d zo n e in ter v a l = [ 1 / ( p w m0 e n g i n e clo ck s o u r ce / s p t.u 8 p r esca le / s p t.u 8 c lo ck sel ec to r ) ] * u 8 dea d z o n e l e n g th = u n it ti m e * u 8 dea d z o n e l en g t h = [ 1 /( 1 2 0 0 0 0 0 0 / 6 / 1 ) ] * 1 0 = 5 u s */ u in t8 _ t u 8 dea d z o n e l e n g th = 1 0; // set d ea d zo n e len g th to 1 0 u n it ti m e / * p w m t im er p r o p er ty * / s p t.u 8 mo d e = dr vp w m_ a ut o_ r e l o a d_ mo de ; s p t.u 8 hig h p u ls e r atio = 3 0 ; / * hi g h p u l s e p er io d : t o tal pu ls e p er io d = 30 : 1 0 0 * / s p t.i3 2 i n v er ter = 0 ; pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 257 - s p t.u 3 2 du t y = 1 0 0 0 ; s p t.u 8 c lo ck selecto r = dr vp w m_ c l o c k_ di v_ 1 ; s p t.u 8 p r esca le = 6 ; u 8 t im er = dr vp w m_ t i me r 0 ; / * select p w m en g in e clo c k s o u r ce */ dr v p w m_ selectcl o ck so u r ce ( u 8 t im er , dr vp w m_ e xt _ 1 2 m) ; / * s et p w m t im er 0 c o n f i g u r atio n * / dr v p w m_ sett im er c l k ( u 8 t im er , & s p t) ; / * e n ab le o u tp u t f o r p w m t i m er 0 * / dr v p w m_ sett im er i o( u 8 t im er , 1 ) ; / * e n ab le o u tp u t f o r p w m t i m er 1 * / dr v p w m_ sett im er i o( dr vp w m_ t i me r 1 , 1 ) ; / * e n ab le t i m er 0 an d t im e1 d ea d zo n e f u n c tio n a n d se t d ea d zo n e len g t h t o 1 0 * / dr v p w m_ e n ab lede ad z o n e( u 8 t im er , u8dea d z o n e l e n g th , 1 ) ; / * e n ab le t h e p w m t im er 0 * / dr v p w m_ e n ab le( u 8 t im er , 1 ) ; drvp w m _ e nabl e p ro t o t y pe v o id dr v p w m_ e n ab le( u in t8 _ t u 8 t i m er , in t3 2 _ t i3 2 e n ab le) ; descript io n t h is f u n ctio n is u s ed to e n ab le p w m tim er / c ap tu r e f u n ctio n p a ra m et er u8 t i m er [ in] sp ec if y th e ti m er dr v p w m_ t i me r 0 : p w m t i m er 0 . dr v p w m_ t i me r 1 : p w m t i m er 1 . dr v p w m_ t i me r 2 : p w m t i m er 2 . dr v p w m_ t i me r 3 : p w m t i m er 3 . dr v p w m_ t i me r 4 : p w m t i m er 4 . dr v p w m_ t i me r 5 : p w m t i m er 5 . dr v p w m_ t i me r 6 : p w m t i m er 6 . dr v p w m_ t i me r 7 : p w m t i m er 7 . o r th e ca p tu r e. dr vp w m_ c a p 0 : p w m ca p t u r e 0 . dr vp w m_ c a p 1 : p w m ca p t u r e 1 . dr vp w m_ c a p 2 : p w m ca p t u r e 2 . dr vp w m_ c a p 3 : p w m ca p t u r e 3 . dr vp w m_ c a p 4 : p w m ca p t u r e 4 . dr vp w m_ c a p 5 : p w m ca p t u r e 5 . pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 258 - dr vp w m_ c a p 6: p w m ca p t u r e 6 . dr vp w m_ c a p 7 : p w m ca p t u r e 7 . i3 2 e na ble [ in] e n ab le ( 1 ) / d is ab le (0 ) i nclu de dr iv er / dr v p w m .h ret urn va lue no n e e x a m p le / * e n ab le p w m ti m er 0 f u n cti o n . * / dr v p w m_ e n ab le( dr vp w m_ t i me r 0 , 1 ) ; / * e n ab le p w m c ap tu r e 1 f u n ctio n . * / dr v p w m_ e n ab le( dr v p w m_ c a p 1 , 1 ) ; drvp w m _ s e tt im e rcl k p ro t o t y pe u in t3 2 _ t dr v p w m_ set t im e r c lk ( u in t8 _ t u 8 t im er , s_ dr vp w m_ t i me _ da t a _ t * s p t) ; descript io n t h is f u n ctio n is u s ed to co n f i g u r e th e f r eq u en c y /p u ls e/ m o d e/ in v er ter f u n ctio n . t h e f u n ctio n w il l set t h e f r eq u e n c y p r o p er ty au to m atica ll y w h e n u s er s et a n o n ze r o f r eq u e n c y v al u e b y u 3 2 f r eq u e n cy . w h en th e s etti n g o f f r eq u e n c y v al u e ( u 3 2 f r eq u en cy ) is n o t sp ec if ied , i.e s et to 0 , u s er n ee d s to p r o v id e th e s etti n g o f clo c k s elec to r , p r escale an d d u t y to g e n er ate d esire d f r eq u en c y . pa ra m et er u8 t i m er [ in] sp ec if y th e ti m er dr v p w m_ t i me r 0 : p w m t i m er 0 . dr v p w m_ t i me r 1 : p w m t i m er 1 . dr v p w m_ t i me r 2 : p w m t i m er 2 . dr v p w m_ t i me r 3 : p w m t i m er 3 . dr v p w m_ t i me r 4 : p w m t i m er 4 . dr v p w m_ t i me r 5 : p w m t i m er 5 . dr v p w m_ t i me r 6 : p w m t i m er 6 . dr v p w m_ t i me r 7 : p w m t i m er 7 . o r th e ca p tu r e. dr vp w m_ c a p 0 : p w m ca p t u r e 0 . dr vp w m_ c a p 1 : p w m ca p t u r e 1 . dr vp w m_ c a p 2 : p w m ca p t u r e 2 . dr vp w m_ c a p 3 : p w m ca p t u r e 3 . dr vp w m_ c a p 4 : p w m ca p t u r e 4 . dr vp w m_ c a p 5 : p w m ca p t u r e 5 . pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 259 - dr vp w m_ c a p 6 : p w m ca p t u r e 6 . dr vp w m_ c a p 7 : p w m ca p t u r e 7 . * s p t [ in] i t in clu d es t h e f o llo w in g p ar am eter parameters description u32 frequency the timer/capture fr equency (hz) u8highpulseratio high p ulse r atio (1~100) u8mode drvpwm_one_shot_mode / drvpwm_ auto_reload _mode binverter inverter enable ( 1 ) / i nverter di s able ( 0 ) u8clockselector clock selector drvpwm_clock_div_1 : pwm input clock is divided by 1 drvpwm_clock_div_ 2: pwm input clock is divided by 2 drvpwm_clock_div_ 4: pwm input clock is divided by 4 drvpwm_clock_div_ 8: pwm input clock is divided by 8 drvpwm_clock_div_ 16: pwm input clock is divided by 16 (the parameter takes effect when u 32 frequency = 0) u8prescale prescale ( 1 ~ 25 5 ) . if the u8prescale is se t to 0, the timer will stop t h e p w m in p u t c lo c k = p w m so u rc e c lo c k / ( u8prescale + 1) (the parameter takes effect when u 32 fre q uency = 0) u32duty p ulse duty ( 0x1 ~ 0x10000 ) (the parameter takes effect when u 32 freq u e n c y = 0 or u8timer = drv p w m _ ca p 0 /drvp w m _ c a p 1 /drvpwm_cap2/drvpw m_cap3 / drvpwm_cap 4/ dr vp w m _ ca p 5/ drvpwm_cap 6/ drvpwm_cap 7 ) i nclu de dr i v er / dr v p w m .h ret urn va lue the actual specified pwm frequency (hz) . e x a m p le / * p w m t i m er 0 o u tp u t 1 khz w a v e f o r m an d d u t y c y c le o f wav ef o r m is 2 0 % */ meth o d 1 : fil l sp t.u 3 2 fre q u e n c y = 1 0 0 0 to d eter m i n e t h e w av e f o r m f r e q u en c y a n d dr v p w m_ sett im er c l k ( ) w ill s e t th e f r eq u en c y p r o p er ty a u t o m a ticall y . / * p w m t im er p r o p er ty * / s p t.u 8 mo d e = dr vp w m_ a ut o_ r e l o a d _ mo de ; s p t.u 8 hig h p u ls e r atio = 20 ; / * hig h p u ls e p er o id : t o tal p u l s e p er o id = 20 : 1 0 0 * / s p t.i3 2 i n v er ter = 0 ; s p t . u3 2 f re qu ency = 1000 ; // set 1 k h z t o p w m ti m er o ut pu t f re qu ency u 8 t im er = dr vp w m_ t i me r 0 ; / * select p w m en g in e clo c k * / dr v p w m_ selectcl o ck so u r ce ( u 8 t im er , dr vp w m_ hc l k ) ; pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 260 - / * set p w m t im er 0 c o n f i g u r atio n * / drv p wm _ set t i m er cl k ( u8 t i m er , & s p t ) ; / * e n ab le o u tp u t f o r p w m t i m er 0 * / dr v p w m_ sett im er i o( u 8 t im er , 1 ) ; / * e n ab le i n ter r u p t so u r ce s o f p w m t im er 0 an d in s tal l c all b ac k f u n ctio n * / dr v p w m_ e n ab lei n t( u 8 t im er , 0 , dr vp w m_ p w m i r qha n d ler ) ; / * e n ab le t h e p w m t im er 0 * / dr v p w m_ e n ab le( u 8 t im er , 1 ) ; meth o d 2 : fil l sp t.u 8 c lo ck selecto r , s p t.u 8 p r esca le an d s p t.u 3 2 du t y to d eter m in e t h e o u tp u t w av e f o r m f r eq u en c y . ass u m e hc l k f r eq u e n c y i s 2 2 mh z. ou tp u t f r eq u e n c y = h c l k f r eq / s p t . u 8 c lo ck selecto r / s p t. u 8 p r esca le / s p t . u 3 2 du t y = 2 2 mh z / 1 / 2 2 / 1 0 0 0 = 1 kh z / * p w m t im er p r o p er ty * / s p t.u 8 mo d e = dr vp w m_ a ut o_ r e l o a d _ mo de ; s p t.u 8 hig h p u ls e r atio = 20 ; / * hig h p u ls e p er o id : t o tal p u l s e p er o id = 20 : 1 0 0 * / s p t.i3 2 i n v er ter = 0 ; s p t . u8 clo ckselect o r = drv p wm _ cl o ck _ div_ 1 ; s p t . u8 p re sca le = 22; s p t . u3 2 dut y = 1 0 0 0 ; u 8 t im er = dr vp w m_ t i me r 0 ; / * select p w m en g in e clo c k an d u s er m u s t k n o w t h e hc l k f r eq u en c y */ dr v p w m_ selectcl o ck so u r ce ( u 8 t im er , dr vp w m_ hc l k ) ; / * set p w m t im er 0 c o n f i g u r atio n * / dr v p w m_ sett im er c l k ( u 8 t im er , & s p t) ; / * e n ab le o u tp u t f o r p w m t i m er 0 * / dr v p w m_ sett im er i o( u 8 t im er , 1 ) ; / * e n ab le i n ter r u p t so u r ce s o f p w m t im er 0 an d in s ta ll c all b ac k f u n ct io n * / dr v p w m_ e n ab lei n t( u 8 t im er , 0 , dr vp w m_ p w m i r qha n d ler ) ; / * e n ab le t h e p w m t im er 0 * / dr v p w m_ e n ab le( u 8 t im er , 1 ) ; pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 261 - drvp w m _ s e tt im e ri o p ro t o t y pe v o id dr v p w m_ sett im er i o( u i n t8 _ t u 8 t im er , in t3 2 _ t i3 2 e n ab le) ; descript io n t h is f u n ctio n is u s ed to en ab le /d is ab le p w m tim er /cap t u r e i /o f u n ctio n p a ra m et er u8 t i m er [ in] sp ec if y th e ti m er dr v p w m_ t i me r 0 : p w m t i m er 0 . dr v p w m_ t i me r 1 : p w m t i m er 1 . dr v p w m_ t i me r 2 : p w m t i m er 2 . dr v p w m_ t i me r 3 : p w m t i m er 3 . dr v p w m_ t i me r 4 : p w m t i m er 4 . dr v p w m_ t i me r 5 : p w m t i m er 5 . dr v p w m_ t i me r 6 : p w m t i m er 6 . dr v p w m_ t i me r 7 : p w m t i m er 7 . o r th e ca p tu r e. dr vp w m_ c a p 0 : p w m ca p t u r e 0 . dr vp w m_ c a p 1 : p w m ca p t u r e 1 . dr vp w m_ c a p 2 : p w m ca p t u r e 2 . dr vp w m_ c a p 3 : p w m ca p t u r e 3 . dr vp w m_ c a p 4 : p w m ca p t u r e 4 . dr vp w m_ c a p 5 : p w m ca p t u r e 5 . dr vp w m_ c a p 6 : p w m ca p t u r e 6 . dr vp w m_ c a p 7 : p w m ca p t u r e 7 . i3 2 e na ble [ in] e n ab le ( 1 ) / d is ab le (0 ) i nclu de dr iv er /dr v p w m. h ret urn va lue no n e e x a m p le / * e n ab le p w m t i m er 0 o u tp u t. */ dr v p w m_ sett im er i o( dr vp w m_ t i me r 0 , 1 ) ; / * dis ab le p w m t i m er 0 o u tp u t. */ dr v p w m_ sett im er i o( dr vp w m_ t i me r 0 , 0 ) ; / * e n ab le p w m c ap tu r e 3 in p u t . * / dr v p w m_ sett im er i o( dr vp w m_ c a p 3 , 1 ) ; / * dis ab le p w m c ap tu r e ti m er 3 in p u t pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 262 - dr v p w m_ sett im er i o( dr vp w m_ c a p 3 , 0 ) ; drvp w m _ s e le c tc loc k s ourc e p ro t o t y pe v o id dr v p w m_ selectcl o ck s o u r ce ( u in t8 _ t u 8 t i m er , u i n t8 _ t u 8 c lo ck so u r ce selecto r ) ; descript io n t h is f u n ctio n is u s ed to se lect p w m0 & p w m 1 , p w m2 & p w m3 , pw m4 & p w m5 an d p w m6 & p w m 7 en g in e clo c k s o u r ce . i t m ea n s p w m0 /1 u s e o n e clo ck s o u r ce . p w m2 /3 ca n u s e a n o th er clo ck s o u r ce an d s o o n . i n o th er w o r d s , i f u s e r c h an g e p w m ti m er 0 clo ck s o u r ce f r o m ex ter n al 1 2 mh z to in ter n al 2 2 mh z, th e clo ck s o u r ce o f p w m ti m er 1 w ill al s o b e ch an g ed f r o m e x ter n al 1 2 mh z to in ter n al 2 2 mh z. fu r t h er m o r e, it i s p o s s ib le to s et th e c lo ck s o u r ce o f p w m1 to b e ex ter n a l 1 2 mh z an d s et th e clo ck s o u r ce o f p w m2 to b e ex ter n al 3 2 . 7 6 8 hz. p a ra m et er u8 t i m er [ in] sp ec if y th e ti m er dr v p w m_ t i me r 0 o r dr v p w m_ t i me r 1 : p w m tim er 0 & p w m tim er 1 . dr v p w m_ t i me r 2 o r dr v p w m_ t i me r 3 : p w m tim er 2 & p w m tim er 3 . dr v p w m_ t i me r 4 o r dr v p w m_ t i me r 5 : p w m tim er 4 & p w m tim er 5 . dr v p w m_ t i me r 6 o r dr v p w m_ t i me r 7 : p w m tim er 6 & p w m tim er 7 . u8 clo ckso urce select o r [ in] t o s et th e clo ck s o u r ce o f s p ec if ied p w m ti m er . it c o u ld b e dr vp w m_ e xt _ 1 2 m / dr vp w m_ e xt _ 3 2 k / dr vp w m_ hc l k / dr vp w m_ i nt e r nal _ 2 2 m . w h er e dr vp w m_ e xt _ 1 2 m is ex ter n al cr y s ta l c lo ck . dr vp w m _ e xt _ 3 2 k is ex ter n al 32 . 7 6 8 hz cr y s tal clo ck . d r v p w m_ hc l k is h c l k . dr v p w m_ i n t e r na l _ 2 2 m is in ter n a l 2 2 . 1 1 8 4 mh z cr y s tal clo ck i nclu de dr iv er /dr v p w m. h ret urn va lue no n e e x a m p le select p w m ti m er 0 an d p w m ti m er 1 en g in e clo c k s o u r c e f r o m hc l k. dr v p w m_ selectcl o ck so u r ce ( dr vp w m_ t i me r 0 , dr vpw m_ hc l k) ; s elec t p w m ti m er 6 an d p w m ti m er 7 en g in e clo c k s o u r ce f r o m ex ter n al 1 2 mh z . dr v p w m_ selectcl o ck so u r ce ( dr vp w m_ t i me r 7 , dr vpw m_ e x t _ 1 2 m ); pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 263 - drvp w m _ s e le c tc le a r latc hfla gopt ion p ro t o t y pe in t3 2 _ t dr v p w m_ selectcl ea r l atc h fla g op tio n ( i n t3 2 _ t i3 2 o p tio n ) ; descript io n t h is f u n ctio n is u s ed to s elec t h o w to clea r c ap tu r e r is i n g & f alli n g l atc h i n d icato r . p a ra m et er i3 2 o ptio n [ in] 0 : select o p tio n to c lear th e c ap tu r e l atc h i n d icato r s b y w r i tin g a ' 0 ' . 1 : sel ec t o p tio n to c lear th e c ap tu r e l atc h i n d icato r s b y w r i tin g a ' 1 ' . i nclu de dr iv er /dr v p w m. h ret urn va lue 0 su cc ee d <0 do es no t s u p p o r t th is o p tio n no t e on l y nuc1 x 0 x x x b x (ex : nu c 1 4 0 r d2 b n ) , nuc1 x 0 x x x c x ( e x : nu c 1 4 0 ve 3 c n ) an d nuc1 0 1 o f nu mic r o tm nu c 1 0 0 s er ies s u p p o r t th is f u n ctio n . p lease r ef er to nu mic r o tm nuc1 0 0 ser ies p r o d u cts selec tio n gu id e o f a p p en d i x i n d etails. drvp w m _ ge tve r s ion p ro t o t y pe u in t3 2 _ t dr v p w m _ getve r s io n ( v o id ); descript io n get th i s m o d u le ? s v er s io n . p a ra m et er no n e i nclu de dr iv er /dr v p w m .h ret urn va lue p w m d r iv er cu r r en t v er s io n n u m b er : 31:24 23:16 15:8 7:0 00000000 major_num minor_num build_num e x a m p le pdf create 8 trial www.nuance.com

nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 265 - 12. ps2 dri ver 12.1. p s 2 introduction p s/2 d ev ice co n tr o ller p r o v id e s b asic ti m in g co n tr o l f o r p s/2 co m m u n icatio n . a ll c o m m u n i ca tio n b et w ee n th e d ev ice an d th e h o s t is m an a g ed th r o u g h th e c l k an d d a t a p in s . t h e d ev ice co n tr o ller g en er ate s th e c l k s i g n al af ter r ec eiv in g a r eq u est to s e n d , b u t h o s t h a s u lti m ate co n tr o l o v er co m m u n icatio n . d a t a s en t f r o m t h e h o s t to th e d ev ice is r e ad o n th e r is in g ed g e a n d d at a s en t f r o m d ev ice to t h e h o s t i s ch a n g e af ter r is i n g ed g e. on e 1 6 b y tes tx fifo i s u s ed to r ed u c e c p u in ter v e n tio n , b u t n o r x fifo . so f t w ar e ca n s e lect 1 to 1 6 b y tes t x fifo d ep th f o r a co n tin u o u s tr an s m is s io n . b ec au s e p s / 2 d ev ice co n tr o ller is v er y s i m p le, w e r ec o m m e n d u s i n g m ac r o as m u c h as p o s s ib le f o r s p ee d co n s id er atio n . b ec au s e n o r x fifo, s o dr v p s2 _ r ea d o n l y r ea d o n e b y te; b u t d r v p s2 _ w r ite ca n w r ite an y le n g t h b y te s to h o s t default ps / 2 interrupt handler has been implemented, it?s ps2_irqhandler . user can issue drvps2_enableint () function to install interrupt call back function an d issue drvps2_disableint () to uninstall interrupt call back function . 12.2. ps2 feat ure t h e ps / 2 d ev ice controller include s following features : ? ? a p b in terface compatible . ? ? ho s t co m m u n icatio n in h ibit and request to send detection . ? ? reception frame error detection ? ? p r o g r am m ab le 1 to 1 6 b y te s t x fifo to r ed u ce c p u in ter v en tio n . b u t n o r x fifo ? ? double buffer for r x. ? ? so f t w ar e o v er r id e b u s . 12.3. constant defination constant name value description drvps2_rxint 0x00000001 ps2 rx interrupt drvps2_txint 0x00000002 ps2 tx interru pt drvps2_txfifodepth 16 tx fifo depth pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 266 - 12.4. macro s _ dr v p s 2 _ ov e rr id e p ro t o t y pe v o id _ dr vp s2 _ ove r r i de ( b o o l s tate) ; descript io n t h is m ac r o is u s ed to en ab le/d is ab le s o f t w ar e to co n tr o l d at a /c l k li n e . p a ra m et er s tate [ in] sp ec if y s o f t w ar e o v er r id e o r n o t. 1 m ea n s to en ab le s o f t w ar e o v er r id e p s / 2 c l k/d a t a p in s tate, 0 m ea n s to d is ab le it . i nclu de dr iv er /dr v p s2 . h ret urn va lue no n e . e x a m p le / * e n ab le so f t w ar e to co n tr o l d a t a/c l k p i n */ _ dr vp s2 _ ove r r i de ( 1 ) / * dis ab le so f t w ar e to co n tr o l d a t a / c l k p in */ _ dr vp s2 _ ove r r i de ( 0 ) _ dr v p s 2 _ p s 2 clk p ro t o t y pe v o id _ dr vp s2 _ p s2 c l k( b o o l s tate) ; descript io n t h is m ac r o ca n f o r ce p s2 c l k h i g h o r lo w r e g ar d less o f t h e in ter n al s tate o f t h e d ev ice co n tr o ller if _ dr vp s2 _ ove r r i de ca lled . 1 m ea n s h ig h , 0 m ea n s lo w p a ra m et er s tate [ in] sp ec if y p s2 c l k l in e h i g h o r lo w i nclu de dr iv er /dr v p s2 . h pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 267 - ret urn va lue no n e . no t e t h e m ac r o is m ea n in g f u l o n l y w h en d r vp s2 _ ove r r i de h as b ee n ca lled . e x a m p le /* force ps2clk pin high. */ _ dr vp s2 _ p s2 c l k ( 1 ) ; / * fo r ce p s2 c l k p i n lo w . */ _ dr vp s2 _ p s2 c l k ( 0 ) ; _ dr v p s 2 _ p s 2 d ata p ro t o t y pe v o id _ dr vp s2 _ p s2 da t a ( b o o l s tate) ; descript io n t h is m ac r o ca n f o r ce p s2 dat a h ig h o r lo w r eg ar d les s o f t h e in ter n al s ta te o f t h e d ev ice co n tr o ller if _ dr vp s2 _ ove r r i de ca lled . 1 m ea n s h ig h , 0 m ea n s lo w . p a ra m et er s tate [ in] sp ec if y p s2 d a t a li n e h ig h o r lo w i nclu de dr iv er /dr v p s2 . h ret urn va lue no n e . no t e t h e m ac r o is m ea n in g f u l o n l y w h en _ d r vp s2 _ ove r r i d e h as b ee n ca lled . e x a m p le / * fo r ce p s2 da t a p i n h i g h . */ _ dr vp s2 _ p s2 da t a ( 1 ) ; / * fo r ce p s2 da t a p in lo w . */ _ dr vp s2 _ p s2 da t a ( 0 ) ; _ dr v p s 2 _ clr fifo p ro t o t y pe pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 268 - v o id dr vp s2 _ c l r fi fo( ) ; descript io n t h e m ac r o is u s ed to clea r t x fifo . p a ra m et er no n e i nclu de dr iv er /dr v p s2 . h ret urn va lue no n e . e x a m p le / * c lear t x fifo. */ _ dr vp s2 _ c l r fifo( ) ; _ dr v p s 2 _ ac k not alw ays p ro t o t y pe v o id _ dr vp s2 _ a c knot al w a ys( ) ; descript io n t h e m ac r o is u s ed to en ab le ac k n o t al w a y s .. i f p ar it y er r o r o r s to p b it is n o t r ec eiv ed co r r ec tly , ac k n o w led g e b it w i l l n o t b e s en t to h o s t a t 1 2 th clo ck . , p a ra m et er no n e i nclu de dr iv er /dr v p s2 . h ret urn va lue no n e . e x a m p le / * e n ab le ac k k n o w l w d e not al w a y s . */ _ dr vp s2 _ a c knot al w ays () _ dr v p s 2 _ ac ka lw ays p ro t o t y pe v o id _ dr vp s2 _ a c k al w ays( ) ; pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 269 - descript io n t h e m ac r o is u s ed to en ab le ac k al w a y s .. i f p ar it y er r o r o r s to p b it is n o t r ec eiv ed co r r ec tly , ac k n o w led g e b it w ill al w a y s s en d ac k n o w led g e to h o s t a t 1 2 th clo ck f o r h o s t to d ev ice co m m u n icatio n p a ra m et er no n e i nclu de dr iv er /dr v p s2 . h ret urn va lue no n e . e x a m p le / * e n ab le ac k k n o w l w d e al w a y s . */ _ dr vp s2 _ a c k al w a ys () _ dr v p s 2 _ rxi ntena ble p ro t o t y pe v o id _ dr vp s2 _ r xi nt e nab l e ( ) ; descript io n t h e m ac r o is u s ed to en ab le r x in te r r u p t . w h en ac k n o w led g e b it is s en t f r o m h o s t to d ev ic e , r x in ter r u p t w ill h ap p en p a ra m et er no n e i nclu de dr iv er /dr v p s2 . h ret urn va lue no n e . e x a m p le / * e n ab le r x in ter r u p t. */ _ dr vp s2 _ r xi nt e na b l e ( ) ; _ dr v p s 2 _ rxi ntd is ab le p ro t o t y pe v o id _ dr vp s2 _ r xi nt di sab l e ( ) ; pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 270 - descript io n t h e m ac r o is u s ed to d is ab le r x i n ter r u p t . p a ra m et er no n e i nclu de dr iv er /dr v p s2 . h ret urn va lue no n e . e x a m p le / * dis ab le r x i n ter r u p t. */ _ dr vp s2 _ r xi nt di sa b l e ( ) ; _ dr v p s 2 _ txi ntena ble p ro t o t y pe v o id _ dr vp s2 _ t xi n t e na b l e ( ) ; descript io n t h e m ac r o is u s ed to en ab le t x in ter r u p t . w h e n st op b it is tr an s m itted , t x in ter r u p t w ill h ap p en . p a ra m et er no n e i nclu de dr iv er /dr v p s2 . h ret urn va lue no n e . e x a m p le / * e n ab le t x in ter r u p t. */ _ dr vp s2 _ t xi n t e na b l e ( ) ; _ dr v p s 2 _ txi ntd is ab le p ro t o t y pe v o id _ dr vp s2 _ t xi n t di s a b l e () ; descript io n pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 271 - t h e m ac r o is u s ed to d is ab le t x in ter r u p t . p a ra m et er no n e i nclu de dr iv er /dr v p s2 . h ret urn va lue no n e . e x a m p le / * dis ab le t x in ter r u p t. */ _ dr vp s2 _ t xi n t di s a b l e ( ) ; _ dr v p s 2 _ p s 2 e na ble p ro t o t y pe v o id _ r vp s2 _ p s2 e na b l e ( ) ; descript io n t h e m ac r o is u s ed to en ab le p s / 2 d ev ice co n tr o ller . p a ra m et er no n e i nclu de dr iv er /dr v p s2 . h ret urn va lue no n e . e x a m p le / * e n ab le p s / 2 d ev ice co n tr o ll er . */ _d r vp s2 _ p s2 e na b l e ( ) ; _ dr v p s 2 _ p s 2 disable p ro t o t y pe v o id _d r vp s2 _ p s2 di sa b l e ( ) ; descript io n t h e m ac r o is u s ed to d is ab le ps / 2 d ev ice co n tr o ller . p a ra m et er pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 272 - no n e i nclu de dr iv er /dr v p s2 . h ret urn va lue no n e . e x a m p le / * dis ab le p s / 2 d ev ice co n tr o l ler . */ _d r vp s2 _ p s2 di s a b l e ( ) ; _ dr v p s 2 _ txfi fo p ro t o t y pe v o id _ dr vp s2 _ t xfi fo( d e p th ) ; descript io n t h e m ac r o is u s ed to s et t x f i fo d ep th . t h e r an g e o f t x fifo is [ 1 ,1 6 ] p a ra m et er da t a [ in] : sp ec if y t x fifo d ep th ( 1 ~1 6 ) . i nclu de dr iv er /dr v p s2 . h ret urn va lue no n e . e x a m p le / * set t x fifo d ep th to 1 6 b y tes. */ _ dr vp s2 _ t xfi fo ( 1 6 ) ; / * set t x fifo d ep th to 1 b y t es. */ _ dr vp s2 _ t xfi fo ( 1 ) ; _ dr v p s 2 _ s w ov e r ride p ro t o t y pe v o id _ dr vp s2 _ sw ove r r i de ( b o o l d ata , b o o l clk ) ; descript io n t h e m ac r o is u s ed to s et p s2 da t a a n d p s2 c l k li n e b y s o f t w ar e o v er r id e . i t? s eq u a l to th ese m ac o s : _ dr vp s2 _ p s2 da t a ( d ata) ; pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 273 - _ dr vp s2 _ p s2 c l k( clk ) ; _ dr vp s2 _ ove r r i de ( 1 ) ; p a ra m et er da t a [ in] sp ec if y p s2 d a t a li n e h ig h o r lo w clk [ i n] sp ec if y p s2 c l k l in e h i g h o r lo w i nclu de dr iv er /dr v p s2 . h ret urn va lue no n e . e x a m p le / * set p s2 d a t a to h i g h a n d s et p s2 c l k to lo w . */ _ dr vp s2 _ sw ove r r i de ( 1 , 0 ) ; / * set p s2 d a t a to lo w a n d s et p s2 c l k to h i g h . */ _ dr vp s2 _ sw ove r r i de ( 0 , 1 ) ; _ dr v p s 2 _ intc lr p ro t o t y pe v o id _ dr vp s2 _ i nt c l r ( u i n t 8 _ t in tclr ) ; descript io n t h e m ac r o is u s ed to clea r in te r r u p s tatu s . p a ra m et er intc lr [ in] sp ec if y to clea r t x o r r x in t er r u p t. i n tclr =0 x 1 f o r clea r r x in ter r u p t; i n tclr =0 x 2 f o r clea r t x in ter r u p t; i n tclr =0 x 3 f o r clea r r x an d t x in ter r u p t i nclu de dr iv er /dr v p s2 . h ret urn va lue no n e . e x a m p le / * c lear r x in ter r u p t. */ _ dr vp s2 _ i nt c l r ( 1 ) ; pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 274 - / * c lear t x in ter r u p t. */ _ dr vp s2 _ i nt c l r ( 2 ) ; / * c lear t x an d r x in ter r u p t. */ _ dr vp s2 _ i nt c l r ( 3 ) ; _ dr v p s 2 _ rxda ta p ro t o t y pe u in t8 _ t _ dr vp s2 _ r xd a t a( ) ; descript io n r ea d s 1 b y te f r o m t h e r ec eiv e r eg is ter . p a ra m et er no n e i nclu de dr iv er /dr v p s2 . h ret urn va lue on e b y te d ata r ec eiv ed . e x a m p le / * r ea d o n e b y te f r o m p s / 2 r ec eiv e d ata r eg is ter . */ u in t8 _ t u 8 r ec ei v eda ta; u 8 r ec ei v eda ta = _ dr vp s2 _ r xd a t a (); _ dr v p s 2 _ txdat aw ait p ro t o t y pe v o id _ dr vp s2 _ t xda t a w a i t ( u in t3 2 _ t d ata, u in t3 2 _ t le n ) ; descript io n t h e m ac r o is u s ed to w ai t t x fifo e mp t y, s et t x fifo d ep th ( len g t h - 1) an d f ill t x fifo 0 - 3 ( r e g is ter p s2 t xdat a 0 ) . data is s en t i m m ed iatel y if b u s is i n i d l e s tate . t h e r an g e o f le n g th i s f r o m 1 to 1 6 b y te s . i f t h e tr an s f er s ize i s m o r e th an 4 b y tes, u s er s h o u ld ca ll dr vp s2 _ t x da t a 1 ~3 ( ) af ter ca llin g _ d r vp s2 _ t xda t a w a i t ( ) to tr an s f er r e m in d d ata. w h en tr an s m itted d ata b y te n u m b er i s eq u al to fifode p t h th en t xe mp t y b it is s et to 1 p a ra m et er da t a [ in] sp ec if y th e d ata s e n t len [ in] pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 275 - sp ec if y th e le n g th o f th e d ata s en t. u n it i s b y te. r a n g e i s [ 1 , 1 6 ] i nclu de dr iv er /dr v p s2 . h ret urn va lue no n e e x a m p le / * w ait t x fifo e m p t y a n d th en w r ite 1 6 b y tes to t x fifo. t h e s ix teen b y tes co n s is t o f 0 x 0 1 to 0 x 1 6 . */ _ dr vp s2 _ t xda t a w a i t ( 0 x 0 4 0 3 0 2 0 1 , 1 6 ) ; _ dr vp s2 _ t x da t a 1 ( 0 x 0 8 0 7 0 6 0 5 ) ; _ dr vp s2 _ t x da t a 2 ( 0 x 0 c 0 b 0 a 0 9 ) ; _ dr vp s2 _ t x da t a 3 ( 0 x 1 0 0 f0 e 0 d) ; / * w ait t x fifo e m p t y a n d th en w r ite 5 b y te s to t x fifo. t h e s ix b y tes co n s is t o f 0 x 0 1 to 0 x 0 5 . */ _ dr vp s2 _ t xda t a w a i t ( 0 x 0 4 0 3 0 2 0 1 , 5 ) ; _ dr vp s2 _ t x da t a 1 ( 0 x 0 5 ) ; / * w ait t x fifo e m p t y a n d th en w r ite 3 b y te s to t x fifo. t h e th r ee b y te s co n s i s t o f 0 x 0 1 to 0 x 0 3 . */ _ dr vp s2 _ t xda t a w a i t ( 0 x 0 3 0 2 0 1 , 3 ) ; _ dr v p s 2 _ txdat a p ro t o t y pe v o id _ dr vp s2 _ t xda t a ( u i n t3 2 _ t d ata, u in t3 2 _ t le n ) ; descript io n t h e m ac r o is u s ed to s et t x fifo d ep th an d f ill t x fifo 0 - 3 . b u t n o t w ait t x fifo e mpt y. data is s en t i f b u s i s in i d l e s tate i m m ed iatel y . t h e r an g e o f le n is [ 1 , 1 6 ] w h en tr an s m itted d ata b y te n u m b er i s eq u al to fifode p t h th en t xe mp t y b it is s et to 1 . p a ra m et er da t a [ in] sp ec if y th e d ata s e n t len [ in] sp ec if y th e le n g th o f th e d ata s en t. u n it i s b y te. r a n g e i s [ 1 , 1 6 ] i nclu de dr iv er /dr v p s2 . h ret urn va lue pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 276 - no n e no t e i f th e tr a n s f er s ize is m o r e t h a n 4 b y tes, u s er s h o u ld is s u e _ dr vp s2 _ t x da t a 1 ~3 ( ) af ter is s u i n g _ dr vp s2 _ t xda t a ( ) ; e x a m p le /* w r ite 1 6 b y tes to t x fifo. t h e s ix teen b y tes co n s is t o f 0 x 0 1 to 0 x 1 6 . */ _ dr vp s2 _ t xda t a ( 0 x 0 4 0 3 0 2 0 1 , 1 6 ) ; _ dr vp s2 _ t x da t a 1 ( 0 x 0 8 0 7 0 6 0 5 ) ; _ dr vp s2 _ t x da t a 2 ( 0 x 0 c 0 b 0 a 0 9 ) ; _ dr vp s2 _ t x da t a 3 ( 0 x 1 0 0 f0 e 0 d) ; / * w r ite 5 b y te s to t x fifo. t h e s ix b y tes co n s i s t o f 0 x 0 1 t o 0 x 0 5 . */ _ dr vp s2 _ t xda t a ( 0 x 0 4 0 3 0 2 0 1 , 5 ) ; _ dr vp s2 _ t x da t a 1 ( 0 x 0 5 ) ; / * w r ite 3 b y te s to t x fifo. t h e th r ee b y te s co n s i s t o f 0 x 0 1 to 0 x 0 3 . */ _ dr vp s2 _ t xda t a ( 0 x 0 3 0 2 0 1 , 3 ) ; _ dr v p s 2 _ txdat a0 p ro t o t y pe v o id _ dr vp s2 _ t xda t a 0 ( u in t3 2 _ t d ata) ; descript io n t h e m ac r o is u s ed to f ill t x fifo 0 - 3 . b u t n o t w ait t x fifo e mpt y an d n o t set t x fifo d ep th . data is s en t if b u s is i n i dl e s tate i m m ed iatel y . w h en tr an s m itted d ata b y te n u m b er i s eq u al to fifode p t h th en t xe mp t y b it is s et to 1 . p a ra m et er da t a [ in] sp ec if y th e d ata t h at w ill b e s e n t i nclu de dr iv er /dr v p s2 . h ret urn va lue no n e . e x a m p le / * w r ite 1 6 b y tes to t x fifo. t h e s ix teen b y tes co n s is t o f 0 x 0 1 to 0 x 1 6 . */ w h ile( _ dr vp s2 _ i st xe m pty( ) == 0 ) ; _ dr vp s2 _ t xfi fo( 1 6 ) ; pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 277 - _ dr vp s2 _ t xda t a 0 ( 0 x 0 4 0 3 0 2 0 1 ); _ dr vp s2 _ t x da t a 1 ( 0 x 0 8 0 7 0 6 0 5 ) ; _ dr vp s2 _ t x da t a 2 ( 0 x 0 c 0 b 0 a 0 9 ) ; _ dr vp s2 _ t x da t a 3 ( 0 x 1 0 0 f0 e 0 d) ; _ dr v p s 2 _ txdat a 1 p ro t o t y pe v o id _ dr vp s2 _ t xda t a 1 ( u in t3 2 _ t d ata) ; descript io n t h e m ac r o is u s ed to f ill t x fifo 4 - 7 . b u t n o t w ait t x fifo e mpt y an d n o t set t x fifo d ep th . w h en tr an s m itted d ata b y te n u m b er i s eq u al to fifode p t h th en t xe mp t y b it is s et to 1 . p a ra m et er da t a [ in] sp ec if y th e d ata t h at w ill b e s e n t i nclu de dr iv er /dr v p s2 . h ret urn va lue no n e e x a m p le p lease r ef er to _ dr vp s2 _ t x da t a 0 ( ) ex a m p le. _ dr v p s 2 _ txdat a 2 p ro t o t y pe v o id _ dr vp s2 _ t xda t a 2 ( u in t3 2 _ t d ata) ; descript io n t h e m ac r o is u s ed to f ill t x fifo 8 - 1 1 . b u t n o t w a it t x fifo e mpt y an d n o t set t x fifo d ep th . w h en tr an s m itted d ata b y te n u m b er i s eq u al to fifode p t h t h en t xe mp t y b it is s et to 1 . p a ra m et er da t a [ in] sp ec if y th e d ata t h at w ill b e s e n t i nclu de pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 278 - dr iv er /dr v p s2 . h ret urn va lue no n e e x a m p le p lease r ef er to _ dr vp s2 _ t x da t a 0 ( ) ex a m p le. _ dr v p s 2 _ txdat a 3 p ro t o t y pe v o id _ dr vp s2 _ t xda t a 3 ( u in t3 2 _ t d ata) ; descript io n t h e m ac r o is u s ed to f ill t x fifo 12 - 1 5 . b u t n o t w ait t x fifo e mp t y an d n o t set t x fifo d ep th . w h en tr an s m itted d ata b y te n u m b er i s eq u al to fifode p t h th en t xe mp t y b it is s et to 1 . p a ra m et er da t a [ in] sp ec if y th e d ata t h at w ill b e s e n t. i nclu de dr iv er /dr v p s2 . h ret urn va lue no n e e x a m p le p lease r ef er to _ dr vp s2 _ t x da t a 0 ( ) ex a m p le. _ dr v p s 2 _ is tx e m p ty p ro t o t y pe u in t8 _ t _ dr vp s2 _ i st xe m pt y () ; descript io n t h e m ac r o is u s ed to ch ec k t x fifo w h et h er o r n o t e m p t y w h en tr an s m itted d ata b y te n u m b er i s eq u al to fifode p t h th en t xe mp t y b it is s et to 1 . p a ra m et er no n e i nclu de pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 279 - dr iv er / dr v p s2 . h ret urn va lue t x fifo em p t y s tat u s . 0 : t x fifo is em p t y . 1 : t x fifo is n o t e m p t y . e x a m p le p lease r ef er to _ dr vp s2 _ t x da t a 0 ( ) ex a m p le. _ dr v p s 2 _ is fra m e e rr p ro t o t y pe u in t8 _ t _ dr vp s2 _ i sf r a me e r r ( ) ; descript io n t h e m ac r o is u s ed to ch ec k wh eth er o r n o t f r a m e er r o r h ap p en . fo r h o s t to d ev ice co m m u n icatio n , i f st op b it is n o t r ec eiv ed it is a f r a m e er r o r . i f f r a m e er r o r o cc u r s , da t a lin e m a y k ee p at lo w s tate af te r 1 2 th clo ck . a t th i s m o m en t, s o f t w ar e o v er r id e p s2 c l k to s en d clo ck til l p s2 da t a r ele ase to h ig h s ta te. af ter t h at, d ev ice s e n d s a res e n d co m m a n d to h o s t p a ra m et er no n e i nclu de dr iv er /dr v p s2 . h ret urn va lue fra m e er r o r s tatu s . 0 : n o t f r a m e er r o r . 1 : fr a m e er r o r . e x a m p le / * c h ec k fra m e er r o r an d p r in t th e r esu lt. */ if ( _ dr vp s2 _ i sf r am e e r r () == 1 ) p r in tf ( f r a m e er r o r h ap p en !! \ n ); else p r in tf ( f r a m e er r o r n o t h ap p en !! \ n ); _ dr v p s 2 _ is rxbu s y p ro t o t y pe u in t8 _ t _ dr vp s2 _ i sr xb us y () ; pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 280 - descript io n t h e m ac r o is u s ed to ch ec k wh eth er o r n o t r x b u s y . i f b u s y it in d icate s t h at p s / 2 d ev ice is cu r r en tl y r ec eiv i n g d ata p a ra m et er no n e i nclu de dr iv er / dr v p s2 . h ret urn va lue r x b u s y f lag . 0 : rx is n o t b u s y , 1 : rx is b u s y . e x a m p le / * c h ec k r x i s b u s y o r n o t. */ if ( _ dr vp s2 _ i sr xb us y () == 1 ) p r in tf ( r x is b u s y ! \ n ); else p r in tf ( r x is n o t b u s y ! \ n ); 12.5. fu n ctio n s drvp s 2 _ ope n p ro t o t y pe in t3 2 _ t d r v p s2 _ op en ( ) ; descript io n t h is f u n ctio n is u s ed to in it ps / 2 i p . i t in clu d es e n ab le p s2 clo ck , en ab le p s / 2 co n tr o ller , clea r fifo, s et t x f i fo d ep t h to d ef au l t v al u e ze r o . p a ra m et er n o n e i nclu de dr iv er /dr v p s2 . h ret urn va lue e _ suc c e ss . e x a m p le pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 281 - / * i n it ialize p s / 2 i p . */ dr v p s2 _ op en ( ) ; drvp s 2 _ clos e p ro t o t y pe v o id dr v p s2 _ c lo s e( ) ; descript io n t h is f u n ctio n is u s ed to d is ab le p s2 co n tr o ller , d is ab le p s / 2 clo ck an d s et t x f i fo d ep th to d ef au lt v al u e ze r o p a ra m et er no n e i nclu de dr iv er / dr v p s2 . h ret urn va lue no n e e x a m p le / * c lo s e p s2 i p. */ dr v p s2 _ c lo s e ( ) ; drvp s 2 _ e nabl e int p ro t o t y pe in t3 2 _ t dr v p s2 _ e n ab lei n t ( u in t3 2 _ t u 3 2 i n ter r u p tfl ag , p fn_ dr vp s2 _ c al l b a c k p f n ca llb ac k ); descript io n t h is f u n ctio n is u s ed to en ab le t x /r x in ter r u p t a n d in s tall i n ter r u p t c all b ac k f u n ctio n . p a ra m et er u3 2 i nte rr up t f la g [ in] s p ec if y t x /r x i n ter r u p t f la g th at w ill b e en ab le . i t c an b e d r vp s2 _ t xi n t o r dr vp s2 _ r xi nt o r dr vp s 2 _ t xi n t | d r vp s2 _ r xi nt pfnca llb a c k [ in] s p ec if y th e i n ter r u p t c all b ac k f u n ctio n . w h en p s2 in ter r u p t h ap p en , th i s f u n ctio n w i ll b e ca ll ed pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 282 - i nclu de dr iv er / dr v p s2 . h ret urn va lue e _ suc c e ss e x a m p le / * e n ab le t x/ r x i n ter r u p t , in s tall t x/r x ca ll b ac k f u n ctio n : p s2 mo u s e_ i r qha n d ler ( ) ; */ dr v p s2 _ e n ab lei n t ( dr vp s2 _ t xi n t | dr vp s2 _ r xi nt , ps 2 mo u s e_ i r qha n d ler ) ; drvp s 2 _ dis a bl e int p ro t o t y pe void drvps2 _ dis ab lei n t( u i n t3 2 _ t u 3 2 i n ter r u p tfl a g ) ; descript io n t h is f u n ctio n is u s ed to d is ab le t x /r x in ter r u p t a n d u n i n s ta l l in ter r u p t c all b ac k f u n ctio n .. p a ra m et er u3 2 i nte rr up t f la g [ in] s p ec if y t x /r x i n ter r u p t f la g th at w ill b e d is ab led . i t c an b e dr vp s2 _ t xi n t o r dr vp s2 _ r xi nt o r dr vp s 2 _ t xi n t | d r vp s2 _ r xi nt . i nclu de dr iv er / dr v p s2 . h ret urn va lue no n e e x a m p le / * dis ab le t x/r x i n ter r u p t a n d u n i n s tal l t x an d r x ca ll b ac k f u n ctio n . */ dr v p s2 _ dis ab lei n t ( dr vp s2 _ t xi n t | dr vp s2 _ r xi nt ); drvp s 2 _ is inten a ble d p ro t o t y pe u in t3 2 _ t d r v p s2 _ i s i n ten ab led ( u in t3 2 _ t u 3 2 i n ter r u p tfl a g ) ; descript io n t h is f u n ctio n is u s ed to ch ec k w h et h er o r n o t in ter r u p t b e en ab led . p a ra m et er u3 2 i nte rr up t f la g [ in] pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 283 - s p ec if y t x /r x i n ter r u p t f la g th at w ill b e ch ec k ed . i t c an b e dr vp s2 _ t xi n t o r dr vp s2 _ r xi nt o r dr vp s 2 _ t xi n t | d r vp s2 _ r xi nt . i nclu de dr iv er / dr v p s2 . h ret urn va lue 0 : n o in ter r u p t b e en ab le. 2 : t x in ter r u p t b e en ab le 4 : rx in ter r u p t b e en ab le 6 : t x an d r x in ter r u p t b e e n ab le. e x a m p le / * c h ec k t x an d r x in ter r u p t en ab le o r n o t e n ab le. */ u in t3 2 _ u 3 2 t xr xi n ten ab le u 3 2 t xr xi n ten ab le = dr v p s 2 _ i s i n ten ab led ( dr vp s2 _ t x i nt | dr vp s2 _ r xi nt ) if ( u 3 2 t xr xi n te n ab le == 0 ) printf( no interrupt be enable!! \ n ); else if(u32txrxintenable ==2) pri ntf( tx interrupt be enable!! \ n ); else if(u32txrxintenable ==4) printf( rx interrupt be enable!! \ n ); else if(u32txrxintenable ==6) p r in tf ( t x an d r x in ter r u p t b e en ab le! ! \ n ); drvp s 2 _ cle a r in p ro t o t y pe u in t3 2 _ t d r v p s2 _ c lear i n t( u i n t3 2 _ t u 3 2 i n ter r u p tfl a g ) ; descript io n t h is f u n ctio n is u s ed to clea r in ter r u p t stat u s . p a ra m et er u3 2 i nte rr up t f la g [ in] s p ec if y t x / r x i n ter r u p t f la g t h at w ill b e clea r ed . i t c an b e dr vp s2 _ t xi n t o r dr vp s2 _ r xi nt o r dr vp s 2 _ t xi n t | d r vp s2 _ r xi nt i nclu de dr iv er / dr v p s2 . h ret urn va lue pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 284 - e _ suc c e ss : s u cc es s . e x a m p le / * c lear t x in ter r u p t. */ dr v p s2 _ c lear i n t ( dr vp s2 _ t xi nt ); / * c lear r x in ter r u p t. */ dr v p s2 _ c lear i n t ( dr vp s2 _ r xi nt ); / * c lear t x an d r x in ter r u p t. */ dr v p s2 _ c lear i n t ( dr vp s2 _ t xi nt | dr vp s2 _ r xi nt ); drvp s 2 _ ge tint s tatus p ro t o t y pe in t8 _ t d r v p s 2 _ geti n tst a tu s ( u in t3 2 _ t u 3 2 i n ter r u p tfl a g ) ; descript io n t h is f u n ctio n is u s ed to ch ec k in ter r u p t sta tu s . i f in ter r u p t th at b e ch ec k ed h ap p en s i t w ill r etu r n t r ue p a ra m et er u3 2 i nte rr up t f la g [ in] s p ec if y t x /r x i n ter r u p t f la g th at w ill b e ch ec k ed . i t c an b e d r vp s2 _ t xi n t o r dr vp s2 _ r xi nt i nclu de dr iv er / dr v p s2 . h ret urn va lue t r ue : in ter r u p t th at b e ch ec k ed h ap p en s f a l se: i n ter r u p t th at b e ch ec k ed d o esn ? t h ap p en . e x a m p le / * c h ec k t x in ter r u p t stat u s */ in t8 _ t i8 i n ter r u p tst at u s ; i8 i n ter r u p tst at u s = dr v p s2 _ g eti n tst a t u s ( d r vp s2 _ t xi n t ); if ( i8 i n ter r u p ts tatu s == t r ue ) p r in tf ( t x in ter r u p t th a t b e ch ec k ed h ap p en s \ n ) ; else p r in tf ( t x in ter r u p t d o esn ? t h ap p en \ n ) ; pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 285 - drvp s 2 _ s e tt x fif ode pt h p ro t o t y pe v o id dr v p s2 _ sett x fifode p th ( u in t1 6 _ t u 1 6 t x fifode p th ) ; descript io n t h is f u n ctio n is u s ed to s et t x fifo d ep th . t h e f u n ctio n will c all m ac r o dr vp s2 _ t xfi fo to s et t x fifo d ep th p a ra m et er u1 6 t x f i f o de pth [ in] s p ec if y t x fifo d ep th . t h e r an g e ca n b e [ 1 , 1 6 ] i nclu de dr iv er / dr v p s2 . h ret urn va lue no n e e x a m p le / * set t x fifo d ep th to 1 6 b y tes. */ dr v p s2 _ sett x fifode p th ( 1 6 ) ; / * set t x fifo d ep th to 1 b y t e. */ dr v p s2 _ sett x fifode p th ( 1 ) ; drvp s 2 _ rea d p ro t o t y pe in t3 2 _ t d r v p s2 _ r ea d ( u in t8 _ t * p u 8 r x b u f ) ; descript io n t h e f u n c tio n i s u s ed to r ea d o n e b y te to th e b u f f er o f p u 8 r x b u f . t h e f u n ctio n w ill ca ll m a cr o dr vp s2 _ r xd a t a to r ec eiv e d ata p a ra m et er pu 8 rx b uf [ o ut ] th e b u f f er i s u s ed to co n tain b y te r ec eiv ed . t h e s ize o f b u f f e r n ee d s o n e b y te o n l y i nclu de dr iv er / dr v p s2 . h ret urn va lue e _ suc c e ss : s u cc es s . e x a m p le pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 28 6 - / * r ea d r x d ata an d p r in t it. */ u in t 8 _t u 8 r xda ta ; dr v p s2 _ r ea d (& u 8 r xda ta) ; p r in tf ( r x d ata is % x \ n , u 8 r xda ta) ; drvp s 2 _ w rite p ro t o t y pe in t3 2 _ t dr v p s2 _ w r ite( u in t3 2 _ t * p u 3 2 t x b u f , u in t3 2 _ t u 3 2 w r iteb y te s ); descript io n t h e f u n c tio n i s u s ed to w r ite t h e b u f f er o f p u 3 2 t x b u f an d t h e len g t h o f u 3 2 w r iteb y t es to h o s t . i f d ata co u n t se n t is le s s t h an 1 6 b y tes, p lease u s e m ac r o dr vp s2 _ t xda t a x x x f o r s p ee d p a ra m et er pu 3 2 t x b uf [ in] th e d ata th at w i ll b e s en t to h o s t . u3 2 writ eb y t es [ in] th e len g t h o f d ata t h at w ill b e s en t to h o s t . i nclu de dr iv er / dr v p s2 . h ret urn va lue e _ suc c e ss : s u cc es s . e x a m p le / * w r ite 6 4 b y tes to t x b u f f er an d t x b u f f er w ill s e n d th e 6 4 b y tes o u t. */ u in t3 2 _ t a u 3 2 t xda ta[ 6 4 ] ; dr v p s2 _ w r ite( au 3 2 t xda ta, 6 4 ) ; drvp s 2 _ ge tv e rs ion p ro t o t y pe in t3 2 _ t d r v p s2 _ getve r s io n ( v o id ) ; descript io n pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 287 - r etu r n th e c u r r en t v er s io n n u m b er o f d r i v er . i nclu de dr iv er / dr v p s2 . h ret urn va lue ps2 driver current version number : 31:24 23:16 15:8 7:0 00000000 major_num minor_num build_num e x a m p le / * get p s / 2 d r iv er cu r r en t v er s io n n u m b er * / in t3 2 _ t i3 2 p s 2 ver s io n nu m ; i3 2 p s 2 ver s io n nu m = dr v p s2 _ getve r s io n (); pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 288 - 13. fmc driv er 13.1. fmc introduction numicro tm nuc100 series equips with 128/64/32k bytes on chip em b ed d ed f lash f o r ap p licatio n p r o g r a m m e m o r y ( a p r om ) , 4 k b y tes f o r i sp l o ad er p r o g r am m e m o r y ( l d r om ) , an d u s er co n f ig u r atio n ( c o n f ig 0 & c o n f i g 1 ) . user co n f ig u r atio n b lo ck p r o v id es sev er al b y tes to co n tr o l sy s te m lo g ic, li k e f l ash s ec u r it y lo ck , b o o t selec t, b r o w n o u t v o ltag e lev el, d ata f las h b ase ad d r ess , . . . , an d s o o n . nu mic r o tm nuc1 0 0 s er ies also p r o v id e ad d itio n al 4 k b y tes d ata f la s h f o r u s er to s to r e s o m e ap p licatio n d ep en d ed d ata b ef o r e ch ip p o w er o f f . fo r 1 2 8 k b y te s d ev ice, th e d ata f las h is s h ar ed w it h 1 2 8 k p r o g r am m e m o r y an d its s h ar ed ad d r ess is d ef in ed b y u s er i n c o n f i g 1 . t h e d ata f lash s ize is d ef i n ed b y u s er d ep en d s o n u s e r ap p l icatio n r eq u est. 13.2. fmc fe atu r e the fmc in cl u d es f o llo w in g f ea tu r es: ? 1 2 8 /6 4 / 3 2 k b ap p licatio n p r o g r a m m e m o r y ( a p r om ) . ? 4 k b in s y s te m p r o g r a m m i n g l o ad er p r o g r am m e m o r y ( l d r om ) . ? 4 k b d ata f lash w i th 5 1 2 b y tes p ag e er ase u n it f o r u s er to s to r e d ata ? p r o g r am m ab le d at a f las h s tar t a d d r ess an d m e m o r y s ize f o r 1 2 8 kb p r o g r am m e m o r y . ? p r o v id e u s er co n f i g u r at io n to co n tr o l s y s te m lo g ic . ? a p r om ca n n o t b e u p d ated w h en t h e m c u is r u n n i n g i n a p r om ; l d r om ca n n o t b e u p d ated w h en t h e mc u is r u n n in g i n l dr om m e mory addre s s ma p block name size start address end address ap rom 32 kb 64 kb 128 kb (128 - 0.5*n) kb 0x00000000 0x00007fff 0x0000ffff 0x0001ffff if dfen=0 for 128 kb (dfbadr - 1) if dfen=1 for 128 kb data flash 4 kb 4 kb 0 kb (0.5*n) kb 0x0001f000 0x0001f000 none dfbadr 0x0001ff ff 0x0001ffff none if dfen=0 for 128 kb 0x0001ffff if dfen=1 for 128 kb ld rom 4kb 0x00100000 0x00100fff user configuration 2 words 0x00300000 0x00300004 pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 289 - fla s h mem or y s truct ure 13.3. type definition e _ fm c_boo tse lec t enumeratio n identifier v alue description e _fmc _a p ro m 0 boo t f r o m a p ro m e_fmc_ldrom 1 b oo t from ldro ml 13.4. functions drv fm c_enableisp p ro t o t y pe v o id dr v f mc_ e n ab lei sp ( v o id ) ; descript io n pdf create 8 trial www.nuance.com a p p l i c a t i o n p r o g r a m 6 4 k b y t e s a p p l i c a t i o n p r o g r a m 3 2 k b y t e s 1 2 8 k f l a s h m e m o r y d e v i c e 6 4 k f l a s h m e m o r y d e v i c e 3 2 k f l a s h m e m o r y d e v i c e r e s e r v e d r e s e r v e d d a t a f l a s h 4k b y t e s d a t a f l a s h 4 k b y t e s f i x e d s t a r t a d r r e s s f i x e d s t a r t a d d r e s s 0x0 0 0 1 _f0 0 0 d f bad r [3 1 : 0 ] 0 x0 0 0 1 _ f f f f 0x0 0 0 1 _f f f f 0x0 0 0 1 _ f 0 0 0 0x0 0 0 1 _ f f f f a p p l i c a t i o n p r o g r a m (1 2 8 -0.5*n)k b y t e s d a t a f l a s h 0 .5* n 1 k b y t e s p r o g r a m m a b l e s t a r t a d d r e s s n o te : n i s th e n u m b e r o f p a g e s.
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 290 - t o en ab le i sp f u n ctio n . t h is f u n ct io n w ill c h ec k if i n ter n al 2 2 m o s cillato r is en ab le d o r n o t. i f n o t, th i s f u n ctio n w ill en ab l e 2 2 m o s cillato r au to m a ticall y . user ca n d is ab le 2 2 m o s cillato r b y u s i n g dr v sys_ seto s cc tr l ( ) if n ee d ed af ter i sp f in i s h ed . no t e p lease m ak e s u r e t h at th e r eg i s ter w r i te - p r o tectio n f u n ctio n h as b ee n u n lo ck ed b ef o r e u s i n g th is a p i . user ca n c h ec k t h e s tatu s o f th e r eg is ter w r ite - p r o tectio n f u n ctio n w i th dr v sys_ i s p r o tecte d r eg l o c k ed ( ) . p a ra m et er no n e i nclu de dr iv er /dr v fmc . h ret urn va lue no n e e x a m p le dr v fm c _ e n ab lei sp ( ); /* e n ab le i sp f u n c tio n * / drv fm c_ dis a ble i s p p ro t o t y pe v o id dr v f mc_ dis ab lei sp ( v o id ) ; descript io n t o d is ab le i sp f u n ctio n . no t e p lease m ak e s u r e t h at th e r eg i s ter w r ite - p r o tectio n f u n ctio n h as b ee n u n lo c k ed b ef o r e u s i n g th is a p i . user ca n c h ec k t h e s tatu s o f th e r eg is ter w r ite - p r o tectio n f u n ctio n w i th dr v sys_ i s p r o tecte d r eg l o c k ed ( ) . p a ra m et er no n e i nclu de dr iv er /dr v fmc . h ret urn va lue no n e e x a m p le dr v fm c _ dis ab lei sp ( ); / * dis ab le i sp f u n ct io n * / pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 291 - drv fm c_boot s e le c t p ro t o t y pe v o id dr v fmc _ b o o tselect( e _ fmc _ b oot sel e c t b o o t) ; descript io n t o s elec t n ex t b o o tin g f r o m ap r om o r l dr om . no t e p lease m ak e s u r e t h at th e r eg i s ter w r ite - p r o tectio n f u n ctio n h as b ee n u n lo ck ed b ef o r e u s i n g th is a p i . user ca n c h ec k t h e s tatu s o f th e r eg is ter w r ite - p r o tectio n f u n ctio n w i th dr v sys_ i s p r o tecte d r eg l o c k ed ( ) . p a ra m et er bo o t [ in] sp ec if y e _ fm c _ a p r om o r e _ fmc _ l d r om . i nclu de dr iv er /dr v f mc. h ret urn va lue no n e e x a m p le dr v fm c _ b o o tselect ( e _ fmc _ l d r om ) ; / * nex t b o o tin g f r o m l d r om */ dr v fm c _ b o o tselect ( e _ fmc _ ap r om ) ; /* ne x t b o o tin g f r o m a p r om */ drv fm c_ ge t boo tse le c t p ro t o t y pe e _ fmc _ b oot sel e c t dr v fm c _ getb o o tselect( v o id ) ; descript io n t o ge t c u r r en t b o o t selec t setti n g . p a ra m et er no n e . i nclu de dr iv er /dr v fmc . h ret urn va lue e _ fmc _ a p r om t h e cu r r en t b o o t selec t setti n g i s i n a p r om e _ fmc _ l d r om t h e cu r r en t b o o t selec t setti n g i s i n ld r om pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 292 - e x a m p le e _ fmc _ b oot sel e c t e_ b o o tselect / * c h ec k th i s b o o tin g i s f r o m a p r om o r l dr om */ e_ b o o tselect = dr v fmc _ get b o o tselect ( ); drvfmc _ e nabl e ldu pdate p ro t o t y pe v o id dr v fmc _ e n ab le l du p d ate ( v o id ); descript io n to en ab le l dr om u p d ate f u n ctio n . l d r om ca n b e u p d at ed if l d r om u p d ate f u n ctio n is en ab led w h en t h e m c u r u n s i n a p r om . no t e p lease m ak e s u r e t h at th e r eg i s ter w r ite - p r o tectio n f u n ctio n h as b ee n u n lo ck ed b ef o r e u s i n g th is a p i . user ca n c h ec k t h e s tatu s o f th e r eg is ter w r ite - p r o tectio n f u n ctio n w i th dr v sys_ i s p r o te cted r eg l o c k ed ( ) . p a ra m et er no n e i nclu de dr iv er /dr v fmc . h ret urn va lue no n e e x a m p le dr v fm c _ e n ab le l dup d ate ( ); / * e n ab le l d r om u p d ate f u n ctio n */ drvfmc _ dis a ble ldu pdate p ro t o t y pe v o id dr v fmc _ dis ab le l d up d ate ( v o id ); descript io n to d is ab le l dr om u p d ate f u n ctio n . no t e p lease m ak e s u r e t h at th e r eg i s ter w r ite - p r o tectio n f u n ctio n h as b ee n u n lo ck ed b ef o r e u s i n g th is a p i . user ca n c h ec k t h e s tatu s o f th e r eg is ter w r ite - p r o tectio n f u n ctio n w i th dr v sys_ i s p r o tecte d r eg l o c k ed ( ) . p a ra m et er pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 293 - no n e i nclu de dr iv er /dr v fmc . h ret urn va lue no n e e x a m p le dr v fm c _ dis ab le l dup d ate ( ); / * dis ab le l d r om u p d ate f u n ctio n */ drvfmc _ e nabl e con fi g upd a te p ro t o t y pe v o id dr v fmc _ e n ab le c o n f ig up d ate ( v o id ); descript io n to en ab le c o n f ig u p d a te f u n ct io n . i f c o n g i f u p d ate f u n ctio n is en ab led , th e u s er co n f i g u r atio n ca n b e u p d ate r e g ar d less o f m c u is r u n n i n g in a p r om o r l d r om . no t e p lease m ak e s u r e t h at th e r eg i s ter w r ite - p r o tectio n f u n ctio n h as b ee n u n lo ck ed b ef o r e u s i n g th is a p i . user ca n c h ec k t h e s tatu s o f th e r eg is ter w r ite - p r o tectio n f u n ctio n w i th dr v sys_ i s p r o tecte d r eg l o c k ed ( ) . p a ra m et er no n e i nclu de dr iv er /dr v fmc . h ret urn va lue no n e e x a m p le dr v fm c _ e n ab le c o n f ig up d at e ( ); / * e n ab le c o n f ig u p d ate f u n ct io n */ drvfmc _ dis a ble con f ig upd a te p ro t o t y pe v o id dr v fmc _ dis ab le c o n f i g up d ate ( v o id ); descript io n to d is ab le c o n f i g u p d ate f u n c tio n . pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 294 - no t e p lease m ak e s u r e t h at th e r eg i s ter w r ite - p r o tectio n f u n ctio n h as b ee n u n lo ck ed b ef o r e u s i n g th is a p i . user ca n c h ec k t h e s tatu s o f th e r eg is ter w r ite - p r o tectio n f u n ctio n w i th dr v sys_ i s p r o tecte d r eg l o c k ed ( ) . p a ra m et er no n e i nclu de dr iv er /dr v fmc . h ret urn va lue no n e e x a m p le dr v fm c _ dis ab le c o n f ig up d ate ( ); / * dis a b le c o n f i g u p d ate f u n c tio n */ drvfmc _ e nabl e ap u pdate p ro t o t y pe v o id dr v fmc _ e n ab le ap u p d ate ( v o id ); descript io n to en ab le a p r om u p d ate f u n ctio n . a p r om ca n b e u p d ate d if a p r om u p d ate f u n ctio n i s en ab led w h en t h e m c u r u n s i n a p r om . no t e 1 on l y nu m icr o tm nuc1 x 0 x x x c x s er ies ( e x . nu c 1 4 0 ve 3 c n) s u p p o r t th is f u n ctio n . p lease r ef er to nu mic r o tm nuc1 0 0 ser ies p r o d u cts selec tio n g u i d e o f a p p en d ix i n d etails. no t e 2 p lease m ak e s u r e t h at th e r eg i s ter w r ite - p r o tectio n f u n ct io n h as b ee n u n lo ck ed b ef o r e u s i n g th is a p i . user ca n c h ec k t h e s tatu s o f th e r eg is ter w r ite - p r o tectio n f u n ctio n w i th dr v sys_ i s p r o tecte d r eg l o c k ed ( ) . p a ra m et er no n e i nclu de dr iv er /dr v fmc . h ret urn va lue no n e e x a m p le dr v fm c _ e n ab le ap up d ate ( ); / * e n ab le ap r om u p d ate f u n ctio n */ pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 295 - drvfmc _ dis a ble ap u pdate p ro t o t y pe v o id dr v fmc _ dis ab le ap up d ate ( v o id ); descript io n to d is ab le a p r om u p d ate f u n ctio n . no t e 1 on l y nu m icr o tm nuc1 x 0 x x x c x s er ies ( e x . nu c 1 4 0 ve 3 c n) s u p p o r t th is f u n ctio n . p lease r ef er to nu mic r o tm nuc1 0 0 ser ies p r o d u cts selec tio n g u i d e o f a p p en d ix i n d etails. no t e 2 p lease m ak e s u r e t h at th e r eg i s ter w r ite - p r o tectio n f u n ctio n h as b ee n u n lo ck ed b ef o r e u s i n g th is a p i . user ca n c h ec k t h e s tatu s o f th e r eg is ter w r ite - p r o tectio n f u n ctio n w i th dr v sys_ i s p r o tecte d r eg l o c k ed ( ) . p a ra m et er no n e i nclu de dr iv er /dr v fmc . h ret urn va lue no n e e x a m p le dr v fm c _ dis ab le ap up d ate ( ); /* dis ab le ap r om u p d ate f u n ctio n */ drvfmc _ e nabl e p o w e rs a v ing p ro t o t y pe v o id dr v fmc _ e n ab lep o w er sav i n g ( v o id ); descript io n to en ab le f las h ac ce s s p o w er s av i n g f u n ctio n . i f c p u clo ck is s lo w er th a n 2 4 mh z , u s er c an en ab le f la s h p o w er s av i n g f u n ctio n . no t e p le ase m ak e s u r e t h at th e r eg i s ter w r ite - p r o tectio n f u n ctio n h as b ee n u n lo ck ed b ef o r e u s i n g th is a p i . user ca n c h ec k t h e s tatu s o f th e r eg is ter w r ite - p r o tectio n f u n ctio n w i th dr v sys_ i s p r o tecte d r eg l o c k ed ( ) . p a r a m et er no n e pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 296 - i nclu de dr iv er /dr v fmc . h ret urn va lue no n e e x a m p le dr v fm c _ e n ab lep o w er sa v in g ( ); / * e n ab le f las h p o w er s a v i n g f u n ct io n */ drvfmc _ dis a ble p ow e rs a v ing p ro t o t y pe v o id dr v fmc _ dis ab lep o w er sav i n g ( v o id ); descript io n to d is ab le f lash ac ce s s p o w er s a v i n g f u n ctio n . no t e p lease m ak e s u r e t h at th e r eg i s ter w r ite - p r o tectio n f u n ctio n h as b ee n u n lo ck ed b ef o r e u s i n g th is a p i . user ca n c h ec k t h e s tatu s o f th e r eg is ter w r ite - p r o tectio n f u n ctio n w i th dr v sys_ i s p r o te cted r eg l o c k ed ( ) . p a ra m et er no n e i nclu de dr iv er /dr v fmc . h ret urn va lue no n e e x a m p le dr v fm c _ dis ab lep o w er sa v i n g ( ); / * dis ab le f las h p o w er s a v i n g f u n ctio n */ drvfmc _ w rite p ro t o t y pe in t3 2 _ t dr v fmc _ w r ite ( u i n t3 2 _ t u 3 2 ad d r , u in t3 2 _ t u 3 2 d a ta) ; descript io n t o w r ite w o r d d ata in to a p r om , l d r om , data fla s h o r c o n f i g . t h e me m o r y ma p o f a p r o m a n d data flas h ar e d ep en d ed o n th e p r o d u ct o f nu mic r o tm nuc1 0 0 s er ies . p lea s e r ef er to nu mic r o tm nuc1 0 0 ser ies p r o d u cts selec t io n g u i d e o f a p p en d ix f o r flas h s ize. t h e co r r esp o n d in g f u n ctio n in c o n f ig 0 a n d c o n f i g 1 ar e d escr ib ed in fmc sectio n o f t r m in d etails. pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 297 - no t e p lease m ak e s u r e t h at th e r eg i s ter w r ite - p r o tectio n f u n ctio n h as b ee n u n lo ck ed b ef o r e u s i n g th is a p i . user ca n c h e ck t h e s tatu s o f th e r eg is ter w r ite - p r o tectio n f u n ctio n w i th dr v sys_ i s p r o tecte d r eg l o c k ed ( ) . p a ra m et er u3 2 a dd r [ in] w o r d a d d r ess o f a p r om , l d r om , data fla s h o r c o n f i g . u3 2 da t a [ in] w o r d d ata to b e p r o g r a m me d in to a p r om , l dr o m, data flas h o r c o n f ig . i nclu de dr iv er /dr v fmc . h ret urn va lue 0 : su cc ee d <0 : failed e x a m p le / * p r o g r a m w o r d d ata 0 x 1 2 3 4 5 6 7 8 in to ad d r ess 0 x 1 f0 0 0 */ dr v fm c _ w r ite ( 0 x 1 f0 0 0 , 0 x 1 2 3 4 5 6 7 8 ); drvfmc _ rea d p ro t o t y pe in t3 2 _ t dr v fmc _ r ea d ( u i n t 3 2 _ t u 3 2 ad d r , u in t3 2 _ t * u 3 2 d ata) ; descript io n t o r ea d d ata f r o m a p r o m, l dr om , data fla s h o r c o n f i g . t h e me m o r y ma p o f a p r o m an d data flas h ar e d ep en d ed o n th e p r o d u ct o f nu m icr o tm nuc1 0 0 s er ies . p lease r ef er to n u mic r o tm nu c 1 0 0 ser ies pro d u cts selec tio n g u id e o f a p p en d ix f o r fla s h s ize. no t e p lease m ak e s u r e t h at th e r eg i s ter w r ite - p r o tectio n f u n ctio n h as b ee n u n lo ck ed b ef o r e u s i n g th is a p i . user ca n c h ec k t h e s tatu s o f th e r eg is ter w r ite - p r o tectio n f u n ctio n w i th dr v sys_ i s p r o tecte d r eg l o c k ed ( ) . p a ra m et er u3 2 a dd r [ in] w o r d a d d r ess o f a p r om , l d r om , data fla s h o r c o n f i g . u3 2 da t a [ in] t h e w o r d d ata to s to r e d ata f r o m a p r om , l dr om , data flas h o r c o n f ig . i nclu de pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 298 - dr iv er / dr v fmc . h ret urn va lue 0 : su cc ee d <0 : failed e x a m p le u in t3 2 _ t u 3 2 data ; / * r ea d w o r d d ata f r o m ad d r ess 0 x 1 f0 0 0 , an d r ea d d ata is s to r ed to u 3 2 data */ dr v fm c _ r ea d ( 0 x 1 f0 0 0 , & u 3 2 data ) ; drvfmc _ e ra s e p ro t o t y pe in t3 2 _ t dr v fmc _ e r ase ( u i n t3 2 _ t u 3 2 ad d r ) ; descript io n t o p ag e er ase a p r om , l dr om , data flas h o r c o n f ig . t h e f las h p ag e er ase u n it i s 5 1 2 b y te s . t h e me m o r y ma p o f ap r o m an d data flas h ar e d ep en d ed o n th e p r o d u ct o f nu mic r o tm nu c 1 0 0 s er ies . please r ef er to nu mic r o tm nu c 1 0 0 ser ies p r o d u cts selec tio n gu id e o f a p p en d ix f o r flas h s ize. no t e p lease m ak e s u r e t h at th e r eg i s ter w r ite - p r o tectio n f u n ctio n h as b ee n u n lo ck ed b ef o r e u s i n g th is a p i . user ca n c h ec k t h e s tatu s o f th e r eg is ter w r ite - p r o tectio n f u n ctio n w i th dr v sys_ i s p r o tecte d r eg l o c k ed ( ) . p a ra m et er u3 2 a dd r [ in] flas h p ag e b ase ad d r ess o f ap r om , l dr o m an d data fla s h , o r c o n f i g 0 ad d r s s s . i nclu de dr iv er /dr v fmc . h ret urn va lue 0 : su cc ee d <0 : failed e x a m p le / * p ag e e r as e f r o m 0 x 1 f0 0 0 to 0 x 1 f1 ff */ dr v fm c _ e r ase ( 0 x 1 f0 0 0 ); drvfmc _ w rite con fig p ro t o t y pe pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 299 - in t3 2 _ t dr v fmc _ w r itec o n f ig ( u i n t3 2 _ t u 3 2 d ata0 , u in t3 2 _ t u 3 2 d ata1 ) ; descript io n t o er ase c o n f i g an d w r ite d at a in to c o n f i g 0 an d c o n f i g 1 . t h e co r r esp o n d in g f u n ctio n s i n c o n f i g 0 an d c o n f i g 1 ar e d escr ib ed in fmc sectio n o f t r m in d etails. no t e p lease m ak e s u r e t h at th e r eg i s ter w r ite - p r o tectio n f u n ctio n h as b ee n u n lo ck ed b ef o r e u s i n g th is a p i . user ca n c h ec k t h e s tatu s o f th e r eg is ter w r ite - p r o tectio n f u n ctio n w i th dr v sys_ i s p r o tecte d r eg l o c k ed ( ) . p a ra m et er u3 2 da t a 0 [ in] w o r d d ata to b e p r o g r a m m ed in to c o n f i g 0 . u3 2 da t a 1 [ in] w o r d d ata to b e p r o g r a m m ed in to c o n f i g 1 . i nclu de dr iv er /dr v fmc . h ret urn va lue 0 : su cc ee d <0 : failed e x a m p le /* p r o g r a m w o r d d ata 0 x ff ff ff fe i n to c o n f i g 0 an d w o r d d ata 0 x 1 e 0 0 0 in to c o n f ig 1 */ dr v fm c _ c o n f i g ( 0 x ff ff f f fe , 0 x 1 e 0 0 0 ); drv fm c_re a ddatafl a s hbas e add r p ro t o t y pe u in t3 2 _ t d r v fmc _ r ea d data f lash b ase a d d r ( v o id ) ; descript io n t o r ea d d ata f lash b ase ad d r es s . fo r 1 2 8 k b y tes f las h d ev ice, th e b ase ad d r ess o f d ata f las h is d ef in ed b y u s er in c o n f i g 1 . fo r less 1 2 8 k b y te s f las h d ev ice, th e b ase ad d r ess is f ix ed at 0 x 1 f0 0 0 . p a ra m et er no n e i nclu de dr iv er /dr v fmc . h ret urn va lue pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 300 - data flas h b ase ad d r ess e x a m p le u in t3 2 _ t u 3 2 data ; / * r ea d data fla s h b ase ad d r ess * / u 3 2 data = dr v fm c _ r ea d dat aflas h b ase a d d r ( ); drvfmc _ e nabl e low fre qopt m ode p ro t o t y pe v o id dr v fmc _ e n ab le l o w fre q op t mo d e ( v o id ); descript io n to e n ab le f las h ac ce s s lo w f r e q u en c y o p ti m izatio n m o d e . i t c an i m p r o v e f las h ac ce s s p er f o r m a n ce w h en c p u r u n s at lo w f r eq u en c y . no t e 1 on l y nu m icr o tm nuc1 x 0 x x x c x s er ies ( e x . nu c 1 4 0 ve 3 c n) an d l o w den s it y s er ies s u p p o r t th is f u n ctio n . p lease r ef er to nu mic r o tm nu c 1 0 0 ser ies p r o d u cts selec tio n gu id e o f a p p en d i x in d etail s . a n d , set th is b it o n l y w h e n hc l k 2 5 mh z. i f hc l k > 2 5 mh z, c p u w il l f etc h w r o n g co d e an d ca u s e f ail r es u lt. no t e 2 p lease m ak e s u r e t h at th e r eg i s ter w r ite - p r o tectio n f u n ctio n h as b ee n u n lo ck ed b ef o r e u s i n g th is a p i . user ca n c h ec k t h e s tatu s o f th e r eg is ter w r ite - p r o tectio n f u n ctio n w i th dr v sys_ i s p r o tecte d r eg l o c k ed ( ) . p a ra m et er no n e i nclu de dr iv er /dr v fmc . h ret urn va lue no n e e x a m p le / * e n ab le f las h ac ce s s lo w f r e q u en c y o p ti m i za tio n m o d e * / dr v fm c _ e n ab le l o w fre q op t mo d e ( ); drvfmc _ dis a ble low fre qopt m ode p ro t o t y pe v o id dr v fmc _ dis ab le l o w fre q op t mo d e ( v o id ); pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 301 - descript io n to d is ab le f lash ac ce s s lo w f r eq u en c y o p ti m izatio n m o d e . no t e 1 on l y nu m icr o tm nuc1 x 0 x x x c x s er ies ( e x . nu c 1 4 0 ve 3 c n) an d l o w den s it y s er ies s u p p o r t th is f u n ctio n . p lease r ef er to nu mic r o tm nu c 1 0 0 ser ies p r o d u cts selec tio n gu id e o f a p p en d i x in d etail s . no t e 2 p lease m ak e s u r e t h at th e r eg i s ter w r ite - p r o tectio n f u n ctio n h a s b ee n u n lo ck ed b ef o r e u s i n g th is a p i . user ca n c h ec k t h e s tatu s o f th e r eg is ter w r ite - p r o tectio n f u n ctio n w i th dr v sys_ i s p r o tecte d r eg l o c k ed ( ) . p a ra m et er no n e i nclu de dr iv er /dr v fmc . h ret urn va lue no n e e x a m p le / * dis ab le f las h ac ce s s lo w f r e q u en c y o p ti m izatio n m o d e * / dr v fm c _ dis ab le l o w fre q op t mo d e ( ); drvfmc _ ge tve rs ion p ro t o t y pe u in t3 2 _ t dr v fmc _ getve r s io n ( v o id ); descript io n get th i s m o d u le ? s v er s io n . p a ra m et er no n e i nclu de dr iv er /dr v fmc .h ret urn va lue ver s i o n n u m b er : 31:24 23:16 15:8 7:0 00000000 major_num minor_num build_num pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 302 - 14. usb dr iver 14.1. introduction t h is ar ticle is p r o v id ed f o r m a n u f ac t u r er s w h o ar e u s i n g u s b dev ice co n tr o ller to co m p le te th eir usb ap p licatio n s . i t is ass u m ed th a t th e r ea d er is f a m iliar w it h th e un i v er s al ser ial b u s sp ec if i ca tio n , r e v is io n 1 . 1 . 14.2. feat ure ? c o n f o r m to usb 2 . 0 fu ll sp ee d , 1 2 m b p s . ? p r o v id e 1 in ter r u p t so u r ce w it h 4 in ter r u p t e v e n t s . ? su p p o r t co n tr o l, b u lk , i n ter r u p t, an d i s o ch r o n o u s tr an s f er s . ? su s p e n d w h e n n o b u s s i g n al in g f o r 3 m s . ? p r o v id e 6 en d p o in ts f o r co n f ig u r atio n . ? i n clu d e 5 1 2 b y tes i n ter n al s r a m a s usb b u f f er . ? p r o v id e r em o te w a k e - u p ca p ab ilit y . pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 303 - 14.3. usb framework fig u r e 1 4 - 1 : u sb fra m e w o r k a b o v e f i g u r e s h o w s t h e f r a m e w o r k o f usb d ev ice lib r ar y . t h e lo w e s t la y er is usb co n tr o l ler . t h e usb co n tr o ller w ill r ai s e d if f er en t i n ter r u p t e v e n t s ac co r d in g to u sb , b us a n d f lo atin g d etec tio n s tat u s . a l l th e ev en t s ar e h a n d led b y u sb d r iv er b y r elativ e e v en t h a n d ler s . usb d r iv er also tak e ca r e th e b asic h an d ler o f co n tr o l p ip e o f usb p r o t o co l. mo s t f u n ct io n d ep en d en t h an d ler s an d usb d escr ip to r s m u s t b e p r o v id ed b y u s er ap p licatio n s o r usb class d ef in it io n s . pdf create 8 trial www.nuance.com endpoint configuration usb descriptors class function handlers control pipe handlers usb initiator usb event handlers register & interrupt control usb class ( hid / uac / udc ...) ( un ) plug event wakeup event bus events usb events endpoint events user / usb class usb driver usb controller
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 304 - 14.4. call flo w fig u r e 14 - 2 : u sb dr iv er c all flo w t h e ab o v e f ig u r e s h o w s t h e ca ll f lo w o f u sb d r iv er . t h e dr v usb _ op en is u s ed to in i tial t h e usb d ev ice co n tr o ller . t h en usb f lo atin g d etec tio n is en ab led to d etec t u sb p lu g / u n - p l u g ev e n ts . i f usb attac h ed , it n ee d to ca ll th e usb clas s d r iv er to in itial u sb class s p ec i f i ed d escr ip tio n s , ev en t h a n d ler s . fin al l y , all r elate d usb in ter r u p ts ar e en a b led to h an d le th e usb ev e n ts . 14.5. con s tan t de fin i tio n usb register address constant name value description usbd_ inten 0x40060000 usb interrupt enable register address usbd_ intsts 0x40060004 usb interrupt event status register address usbd_faddr 0x40060008 usb device function address register address usbd_ ep sts 0x4006000c usb endpoint status register address address usbd_attr 0x40060010 usb bus status and a ttribution register address usbd_fl detb 0x40060014 usb floating d etec t ed register address usbd_bufseg 0x40060018 setup token buffer segmentation register address usbd_bufseg0 0x40060020 endpoint 0 buffer segmentation register address usbd_mxpld0 0x40060024 endpoint 0 maximal p ayload register address pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 305 - constant name value description usbd_cfg0 0x40060028 endpoint 0 configuration register address usbd_cfgp0 0x4006002c endpoint 0 set stall and clear in/out ready control register address usbd_bufseg1 0x40060030 endpoint 1 buffer segmentation register address usbd_mxpld1 0x40060034 endpoint 1 maximal p aylo ad register address usbd_cfg1 0x40060038 endpoint 1 configuration register address usbd_cfgp1 0x4006003c endpoint 1 set stall and clear in/out ready control register address usbd_bufseg2 0x40060040 endpoint 2 buffer segmentation register address usbd_m xpld2 0x40060044 endpoint 2 maximal p ayload register address usbd_cfg2 0x40060048 endpoint 2 configuration register address usbd_cfgp2 0x4006004c endpoint 2 set stall and clear in/out ready control register address usbd_bufseg3 0x40060050 endpoint 3 buf fer segmentation register address usbd_mxpld3 0x40060054 endpoint 3 maximal p ayload register address usbd_cfg3 0x40060058 endpoint 3 configuration register address usbd_cfgp3 0x4006005c endpoint 3 set stall and clear in/out ready control register addres s usbd_bufseg4 0x40060060 endpoint 4 buffer segmentation register address usbd_mxpld4 0x40060064 endpoint 4 maximal p ayload register address usbd_cfg4 0x40060068 endpoint 4 configuration register address usbd_cfgp4 0x4006006c endpoint 4 set stall and c lear in/out ready control register address usbd_bufseg5 0x40060070 endpoint 5 buffer segmentation register address usbd_mxpld5 0x40060074 endpoint 5 maximal p ayload register address usbd_cfg5 0x40060078 endpoint 5 configuration register address usbd_cf gp5 0x4006007c endpoint 5 set stall and clear in/out ready control register address usbd_drvse0 0x40060090 usb d rive se0 control register address usb_sram_base 0x40060100 usb pdma c ontrol r egister address inten re gis ter bit d e finition constant name val ue description inten_innak 0x00008000 active nak interrupt f unction and its s tatus flag for in t oken inten_wakeup _ en 0x00000100 wake up function enable inten_wakeup _ie 0x00000008 usb wake up interrupt enable inten_fld et_ie 0x00000004 floating detect in terrupt enable inten_usb _ie 0x00000002 usb event interrupt enable pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 306 - constant name val ue description inten_bus _ie 0x00000001 bus event interrupt enable intsts re gis ter bit definition constant name value description intsts_setup 0x80000000 setup event status intsts_ep ev t 5 0x00200000 en dpoint 5 s usb event status intsts_ epevt 4 0x00100000 endpoint 4 s usb event status intsts_ epevt 3 0x00080000 endpoint 3 s usb event status intsts_ epevt 2 0x00040000 endpoint 2 s usb event status intsts_ epevt 1 0x00020000 endpoint 1 s usb event sta tus intsts_ epevt 0 0x00010000 endpoint 0 s usb event status intsts_wakeup _sts 0x00000008 wakeup i n terrupt status intsts_fld et_sts 0x00000004 floating detected interrupt status intsts_usb _sts 0x00000002 usb event interrupt status intsts_bus _sts 0x000 00001 bus interrupt status att r regi s ter bit d e finition constant name value description attr_bytem 0x00000400 cpu access usb ram size mode select attr_pwrdn 0x00000200 power down phy, low active attr_dppu_en 0x00000100 pull - up resistor on d+ enable a ttr_usb_en 0x00000080 usb controller enable attr_rwakeup 0x00000020 remote wake up attr_phy_en 0x00000010 phy function enable attr_timeout 0x00000008 time out status attr_resume 0x00000004 resume status attr_suspend 0x00000002 suspend status attr_usb rst 0x00000001 usb reset status con fiura tion r e gis ter bit definition co n stan t name value description cf g _ c stall 0x00000200 clear stall response pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 307 - constant name value description cfg _dsq _sync 0x00000080 data sequence synchronization cfg _ state 0x00000060 endpoint state cfg_ept_in 0x000 00040 in endpoint cfg_ept_out 0x00000020 out endpoint cfg _isoch 0x00000010 isochronous endpoint cfg _ep _num 0x0000000f endpoint number e x tera - con fiura tion regi s ter bit d e finitio n constant name value description cfgp_ s stall 0x00000002 set the device to respond stall cfgp_ clrrdy 0x00000001 clear ready 14.6. macr o _ dr v usb _ e na ble_ m is c_i nt p ro t o t y pe v o id _ dr vusb _ e n a b l e _ mi sc _ i nt ( u in t3 2 _ t u 3 2 flag s ) ; descript io n e n ab le/dis ab le m is ce l lan eo u s in ter r u p ts i n cl u d in g usb ev e n t, w ak eu p ev e n t, flo at - d etec ti o n ev en t a n d b u s e v en t. p a ra m et er u3 2 f la g s [ in] usb in ter r u p t e v e n t s . i t c an b e f o llo w in g f lag s . i e f_ w a ke up : w ak eu p in ter r u p t f la g . i e f_ fl d : f lo at - d etec tio n in te r r u p ts f la g . i e f_ usb : u sb ev en t i n ter r u p t f la g . i e f_ b us : b u s ev e n t in ter r u p t f lag . u 3 2 flag = 0 w ill d i s ab le all u sb in ter r u p ts . i nclu de dr iv er /dr v u s b . h pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 308 - ret urn va lue no n e e x a m p le _ dr vusb _ e n a b l e _ mi s c _ i nt ( 0 ) ; /* di s ab le all us b - r elate d in ter r u p ts . * / _ dr vusb _ e n a b l e _ mi s c _ i nt ( i e f_ w a ke up | i e f_ w a ke up e n | i e f_ f l d | i e f_ usb | i e f_ b us) ; / * e n a b le w ak e u p , f lo at - d et ec tio n , u sb an d b u s in ter r u p ts * / _ dr v usb _ e na ble_ w ak e up p ro t o t y pe v o id _ dr vusb _ e n a b l e _ w a ke up ( v o id ) ; descript io n e n ab le usb w a k e u p f u n ct io n . i f usb w a k e u p f u n ct io n is e n ab led , an y ac t iv i t y o f usb b u s co u ld b e u s ed to w a k eu p c p u f r o m p o w er d o w n . p a ra m et er no n e i nclu de dr iv er /dr v u s b . h ret urn va lue no n e e x a m p le _ dr vusb _ e n a b l e _ w a k e up ( ) ; /* t o en ab le th e usb w a k e u p f u n ctio n * / _ dr v usb _ disable _ w ak e up p ro t o t y pe v o id _ dr vusb _ di s a b l e _ w a ke up ( v o id ) ; descript io n dis ab le usb w ak e u p f u n c tio n . i f usb w a k eu p f u n ctio n is d i s ab le, usb ca n ? t u s ed to w a k e u p u p c p u f r o m p o w er d o w n . p a ra m et er no n e i nclu de dr iv er /dr v u s b . h ret urn va lue pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 309 - no n e e x a m p le _ dr vusb _ di s a b l e _ w a k e up ( ) ; /* t o av o id w a k e u p c p u b y usb * / _ dr v usb _ e na ble_ w ak e up_ int p ro t o t y pe v o id _ dr vusb _ e n a b l e _ w a ke up _ i nt ( v o id ) ; descript io n e n ab le w a k e u p in ter r u p t. usb w ill r ai s e a w a k e u p ev e n t in te r r u p t w h en w a k e u p in ter r u p t i s en ab led . p a ra m et er no n e i nclu de dr iv er /dr v u s b . h ret urn va lue no n e e x a m p le dr vusb _ e n a b l e _ w a ke up _ i n t ( ) /* t o en ab le w a k eu p ev en t i n ter r u p t * / _ dr v u sb _ disable _ w ak e up_ int p ro t o t y pe v o id _ dr vusb _ di s a b l e _ w a ke up _ i nt ( v o id ) ; descript io n dis ab le w ak e u p in ter r u p t to av o id usb r aise a n in ter r u p t wh en w a k e u p f r o m p o w er d o w n . p a ra m et er no n e i nclu de dr iv er /dr v u s b . h ret urn va lue no n e e x a m p le pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 310 - dr vusb _ di s a b l e _ w a ke up _ i n t ( ) /* t o d is ab le w a k e u p ev en t in ter r u p t * / _ dr v usb_ e na ble_ fld e t_i nt p ro t o t y pe v o id _ dr vusb _ e n a b l e _ f l d et _ i n t ( v o id ) ; descript io n e n ab le f lo at - d etec tio n i n ter r u p t to r aise a n in ter r u p t w h e n us b p lu g - i n o r u n - p l u g . p a ra m et er no n e i nclu de dr iv er /dr v u s b . h ret urn va lue no n e e x a m p le _ dr vusb _ e n a b l e _ f l d et _ i n t ( ) /* t o en ab le f lo at - d etec tio n in ter r u p t * / _ dr v usb _ disable _ fld e t_i nt p ro t o t y pe v o id _ dr vusb _ di s a b l e _ fl d et _ i nt ( v o id ) ; descript io n dis ab le f lo at - d etec tio n i n ter r u p t. p a ra m et er no n e i nclu de dr iv er /d r v u s b . h ret urn va lue no n e e x a m p le _ dr vusb _ di s a b l e _ f l d et _ i n t ( ) /* t o d is ab le f lo at - d etec tio n in ter r u p t * / pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 311 - _ dr v usb_ e na ble_ usb_ int p ro t o t y pe v o id _ dr vusb _ e n a b l e _ u sb _ i n t ( v o id ) ; descript io n e n ab le usb in ter r u p t . i t c o u ld b e u s ed to co n tr o l u sb in ter r u p t o n l y a n d _ dr vusb _ e n a b l e _ mi s c _ i nt ( ) ca n b e u s ed to co n tr o l all usb r elate d in ter r u p ts at t h e s a m e ti m e. p a ra m et er no n e i nclu de dr iv er /dr v u s b . h ret urn va lue no n e e x a m p le _ dr vusb _ e n a b l e _ usb _ i nt ( ) /* t o en ab le usb in ter r u p t * / _ dr v usb _ disable _ usb_ int p ro t o t y pe v o id _ dr vusb _ di s a b l e _ usb _ i nt ( v o id ) ; descript io n dis ab le usb in ter r u p t. p a ra m et er no n e i nclu de dr iv er /dr v u s b . h ret urn va lue no n e e x a m p le _ dr vusb _ di s a b l e _ usb _ i nt ( ) /* t o d is ab le usb in t er r u p t * / pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 312 - _ dr v usb_ e na ble_ bu s _ int p ro t o t y pe v o id _ dr vusb _ e n a b l e _ b us_ i nt ( v o id ) ; descript io n e n ab le usb b u s i n ter r u p t . p a ra m et er no n e i nclu de dr iv er /dr v u s b . h ret urn va lue no n e e x a m p le _ dr vusb _ e n a b l e _ b us_ i nt ( ) /* t o en ab le usb b u s in ter r u p t * / _ dr v usb _ disable _ bu s _ int p ro t o t y pe v o id _ dr vusb _ di s a b l e _ b us_ i nt ( v o id ) ; des cr iptio n dis ab le b u s i n ter r u p t. p a ra m et er no n e i nclu de dr iv er /dr v u s b . h ret urn va lue no n e e x a m p le _ dr vusb _ di s a b l e _ b us_ i nt ( ) /* t o d is ab le usb b u s in ter r u p t * / _ dr v usb_ clear _ e p _ read y _ an d_tri g_ s tal l p ro t o t y pe pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 313 - v o id _ dr vusb _ c l e ar _ e p _ r e ady_ a nd_ t r i g_ st a l l ( u in t3 2 _ t u 3 2 e p i d ) ; descript io n c lear s p ec if ied usb e n d p o in t h ar d w ar e i n / ou t r ea d y a n d r esp o n d st a l l , p a ra m et er u3 2 e p i d [ in] e p i d en tity ( v alid v al u e: 0 ~ 5 ) . i nclu de dr iv er /dr v u s b . h ret urn va lue no n e e x a m p le _ dr vusb _ c l e ar _ e p _ r e a d y_ and_ t r i g_ st a l l ( 3 ) /* t o clea r r ea d y f lag o f u sb en d p o in t id en tit y 3 an d let it t o r esp o n s e st a l l . * / no t es her e, e p ( en d p o in t) id en tit y m ea n s n u m b er o f usb d ev ice h ar d w ar e , n o t u sb en d p o in t n u m b er d ef i n ed b y usb s ta n d ar d . _ dr v usb _ clear _ e p _ read y p ro t o t y pe v o id _ dr vusb _ c l e ar _ e p _ r e ady ( u in t3 2 _ t u 3 2 e p id ) ; descript io n c lear ep i n /ou t read y . p a ra m et er u3 2 e p id [ in] e p i d en tity ( v alid v al u e: 0 ~ 5 ) . i nclu de dr iv er /dr v u s b . h ret urn va lue no n e pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 314 - e x a m p le _ dr vusb _ c l e ar _ e p _ r e a d y ( 1 ) /* t o clea r r ea d y f l ag o f usb en d p o in t id e n tit y 1 . * / _ dr v u sb _ s e t_ s e t up_ bu f p ro t o t y pe v o id _ dr vusb _ set _ se t up _ b uf ( u in t3 2 _ t u 3 2 b u f a d d r ) ; descript io n sp ec if y b u f f er ad d r ess f o r set u p tr an s ac tio n . t h is b u f f er is u s ed to s to r e s etu p to k en d ata a n d its s ize i s f i x ed to b e 8 b y tes a cc o r d in g to usb s tan d ar d . t h er ef o r e, th e b u f f er ad d r ess m u s t b e 8 b y tes ali g n m e n t. p a ra m et er u3 2 b ufa dd r [ in] b u f f er ad d r ess f o r s etu p to k e n . i t c o u ld b e usb _ b a +0 x 1 0 0 ~ usb _ b a +0 x 2 f 8 w h er e usb _ b a is 0 x 4 0 0 6 0 0 0 0 . i nclu de dr iv er /dr v u s b . h ret urn va lue no n e e x a m p le _ dr vusb _ set _ se t up _ b u f ( 0 x 4 0 0 6 0 2 f8 ) /* set th e s e tu p p ac k et ad d r ess to 0 x 4 0 0 6 0 2 f8 * / _ dr v usb_ s e t_ e p _ bu f p ro t o t y pe v o id _ dr vusb _ set _ ep _ b uf ( u in t3 2 _ t u 3 2 e p id , u in t3 2 _ t u 3 2 b u f a d d r ) ; descript io n sp ec if y b u f f er ad d r ess f o r s p e cif ied h ar d w ar e en d p o in t id en t it y an d it m u s t b e 8 b y tes alig n m e n t. t h is b u f f er w o u ld b e u s ed to b u f f er th e d ata o f i n/out usb tr an s ac tio n . t h e b u f f er s ize u s ed b y i n/out usb tr an s ac tio n i s d ep en d en t o n m a x i m u m p a y lo ad o f r elate d en d p o in t id en tit y . p a ra m et er pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 315 - u3 2 e p i d [ in] e p id en tit y ( v alid v a lu e: 0 ~ 5 ) . u3 2 b ufa dd r [ in] used to s et b u f f er ad d r ess an d v alid ad d r ess is f r o m 0 x 4 0 0 6 0 1 0 0 ~ 0 x 4 0 0 6 0 2 f8 . fu r t h er m o r e , b u f f er ad d r ess + m ax i m u m p a y lo ad s ize m u s t l ess t h an 0 x 4 0 0 6 0 2 ff . i nclu de dr iv er /dr v u s b . h ret urn va lue no n e e x a m p le _ dr vusb _ set _ ep _ b uf ( 1 , 0 x 4 0 0 6 0 1 0 0 ) /* set t h e b u f f er ad d r ess o f en d p o in t id en tit y 1 to 0 x 4 0 0 6 0 1 0 0 * / _ dr v usb _ trig_ e p p ro t o t y pe v o id _ dr vusb _ t r i g_ e p ( u in t3 2 _ t u 3 2 e p id , u in t3 2 _ t u 3 2 t r ig size ); descript io n t r ig g er n ex t tr a n s ac tio n f o r s p ec if ied en d p o in t id e n tit y a n d t h e tr an s ac tio n s ize is also d ef i n ed at th e s a m e ti m e. p a ra m et er u3 2 e p id [ in] e p id en tit y ( v alid v a lu e: 0 ~ 5 ) f o r tr ig g er data i n o r ou t tr a n s ac tio n . u3 2 t rig size [ in] fo r data ou t tr an s ac tio n , it m ea n s m ax i m u m d ata s ize tr an s f er r ed f r o m ho s t; f o r data i n tr an s ac t io n , it m ea n s h o w m an y d ata tr an s f er r ed to ho s t. i nclu de dr iv er /dr v u s b . h ret urn va lue no n e e x a m p le pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 316 - / * t r ig g er th e tr a n s ac tio n o f e n d p o in t id en tit y 1 an d th e tr a n s ac tio n p a y lo ad s ize i s 6 4 b y te s * / _ dr vusb _ t r i g_ e p ( 1 , 6 4 ) _ dr v usb _ ge t_ e p _ da ta_s ize p ro t o t y pe u in t3 2 _ t _ dr vusb _g e t _ e p _ da t a _ siz e ( u in t3 2 _ t u 3 2 e p id ); descript io n l e n g t h o f d ata tr an s m itted to o r r ec eiv ed f r o m ho s t f o r s p ec if ied en d p o in t id e n tit y . p a ra m et er u3 2 e p id [ in] e p id en tit y ( v alid v a lu e: 0 ~ 5 ) . i nclu de dr iv er /dr v u s b . h ret urn va lue fo r i n en d p o in t: len g th o f d ata tr an s m itti n g to h o s t i n b y tes. fo r out en d p o in t: a ctu a l len g th o f d ata r ec eiv i n g f r o m h o s t in b y te s . e x a m p le / * t o g et th e s ize o f r ec ei v ed d ata o f en d p o in t id en tit y 1 . * / s ize = _ dr vusb _ ge t _ e p_ da t a _ si z e ( 1 ) ; _ dr v usb _ s e t_ e p _ tog _ bit p ro t o t y pe v o id _ dr vusb _ set _ e p_ t og_ b i t ( u in t3 2 _ t u 3 2 e p id , in t3 2 _ t b data 0 ) descript io n sp ec if y data 0 o r data 1 f o r s p ec if ied en d p o in t id e n tit y . t h is b it w ill to g g le a u to m atica ll y af ter h o s t ac k th e i n to k e n . pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 317 - p a ra m et er u3 2 e p id [ in] e p id en tit y ( v alid v a lu e: 0 ~ 5 ) . bda t a0 [ in] sp ec if y d a t a 0 o r da t a 1 f o r in tr an s ac tio n . t r ue is f o r da t a 0 , f al se is f o r da t a 1 . i nclu de dr iv er /dr v u s b . h ret urn va lue no n e e x a m p le / * t o s et th e to g g le b it a s d at a 0 f o r en d p o in t id en tit y 1 * / _ dr vusb _ set _ e p_ t og_ b i t ( 1 , t r ue ) ; _ dr v usb_ s e t_ e v e nt_fl ag p ro t o t y pe v o id _ dr vusb _ set _ e ve n t _ fl a g ( u in t3 2 _ t u 3 2 data ) ; descript io n set i n ter r u p t e v e n t fla g to cle ar th e m . t h e in ter r u p t e v en t f l ag s ar e w r ite o n e clea r . p a ra m et er u3 2 da t a [ in] sp ec if y th e e v en t to b e clea r . i t c o u ld b e events value description evf_setup 0x80000000 got a setup token event evf_eptf5 0x00200000 got usb event from endpoint identity 5 evf_eptf4 0x00100000 got usb event from endpoint identity 4 evf_eptf3 0x00080000 got usb event from endpoint identity 3 evf_eptf2 0x00040000 got usb event from endpoint identity 2 evf_eptf1 0x00020000 got usb event from endpoint identity 1 evf_eptf0 0x00010000 got usb event from endpoint identity 0 evf_wakeup 0x00000008 got a wakeup event evf_fld 0x00000004 got float - detection event evf_usb 0x 00000002 got usb event include endpoint events or setup event evf_bus 0x00000001 got usb bus event pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 318 - i nclu de dr iv er /dr v u s b . h ret urn va lue no n e e x a m p le _ dr vusb _ set _ e ve n t _ fl a g( e v f_ b us ) ; / * c lear us b b u s ev en t * / _ dr vusb _ set _ e ve n t _ fl a g( e v f_ b us | e vf_ f l d) ; / * c lear usb b u s ev e n t a n d f lo at - d etec t io n ev e n t * / _ dr v usb_ ge t_ e v e nt_fla g p ro t o t y pe u in t3 2 _ t _ dr vusb _ ge t _ e ve n t _ f l a g ( v o id ) ; descript io n g et i n ter r u p t e v e n t fla g s p a ra m et er no n e i nclu de dr iv er /dr v u s b . h ret urn va lue r etu r n e vf r eg is ter v al u e . p lease r ef er t o _ dr vusb _ set _ e ve nt _ fla g( ) f o r d etail ev en t i n f o r m atio n . e x a m p le u 3 2 e v en t s = _ dr vu sb _ ge t _ e vf (); /* ge t e v e n ts * / _ dr v usb_ clear _ e p _ s tal l p ro t o t y pe v o id _ dr vusb _ c l e ar _ e p _ st a l l ( u in t3 2 _ t u 3 2 e p i d ) ; descript io n sto p to f o r ce s p ec if ied en d p o in t id en ti t y to r esp o n d st al l to h o s t. pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 319 - p a ra m et er u3 2 e p id [ in] e p id en tit y ( v alid v a lu e: 0 ~ 5 ) . i nclu de dr iv er /dr v u s b . h ret urn va lue no n e e x a m p le _ dr vusb _ c l e ar _ e p _ s t al l ( 1 ) ;/ * c lear th e st al l o f en d p o in t id e n tit y 1 * / _ dr v usb_ trig_ e p _ s tal l p ro t o t y pe v o id _ dr vusb _ t r i g_ e p _ st a l l ( u in t3 2 _ t u 3 2 e p i d ) ; descript io n fo r ce e p x ( x = 0 ~ 5 ) to r esp o n s e st al l p a ra m et er u3 2 e p id [ in] e p id en tit y ( v alid v a lu e: 0 ~ 5 ) . i nclu de dr iv er /dr v u s b . h ret urn va lue no n e e x a m p le _ dr vusb _ t r i g_ e p_ st a l l ( 1 ) ; / * fo r ce to st a l l e n d p o in t id en tit y 1 * / _ dr v usb_ clear _ e p _ dsq _ s y nc p ro t o t y pe v o id _ dr vusb _ c l e ar _ e p _ dsq _ sync ( u in t3 2 _ t u 3 2 e p i d pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 320 - ) ; descript io n c lear th e e n d p o in t to g g le b it t o da t a 0 , i.e f o r ce th e to g g le b it to b e da t a 0 . t h is b it w ill to g g le a u to m a ticall y af ter i n t o k en ac k f r o m h o s t. p a ra m et e r u3 2 e p id [ in] e p i d en tity ( v alid v al u e: 0 ~ 5 ) . i nclu de dr iv er /dr v u s b . h ret urn va lue no n e e x a m p le / * fo r ce th e to g g le b it o f e n d p o in t id en tit y 2 to b e da t a 0 * / _ dr vusb _ c l e ar _ e p _ dsq _ sync ( 2 ) ; _ dr v usb_ s e t_cfg p ro t o t y pe v o id _ dr vusb _ set _ c fg ( u in t3 2 _ t u 3 2 c fgn u m , u in t3 2 _ t u 3 2 data ) ; descript io n t h is m ac r o is u s ed to s et usb c fg r eg i s ter . p a ra m et er u3 2 cf g nu m [ i n] c fg n u m b er ( v alid v al u e: 0 ~ 5 ) . u3 2 da t a [ in] sp ec if y th e s e tti n g f o r c fg r e g is ter . i nclu de dr iv er /dr v u s b . h ret urn va lue no n e pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 321 - e x a m p le / * se t u sb c fg2 co n tr o l r eg i s ter as 0 x 3 * / _ dr vusb _ set _ c fg ( 2 , 0 x 3 ) ; _ dr v usb_ ge t_cfg p ro t o t y pe u in t3 2 _ t _ dr vusb _ ge t _ c fg ( u in t3 2 _ t u 3 2 c fgn u m ) ; descript io n get cu r r en t se tti n g o f u sb c f g r eg is ter . p a ra m et er u3 2 cf g nu m [ i n] c fg n u m b er ( v alid v al u e: 0 ~ 5 ) . i nclu de dr iv er /dr v u s b . h ret urn va lue r etu r n s p ec i f ied c fg r e g is ter v alu e e x a m p le / * get t h e s etti n g o f usb c f g2 co n tr o l r eg is ter * / u32 c f g = _ dr v usb _ ge t _ c fg ( 3 ) ; _ dr v usb_ s e t_fad dr p ro t o t y pe v o id _ dr vusb _ set _ fa dd r ( u in t3 2 _ t u 3 2 a d d r ) descript io n t o s et u sb d ev ice ad d r ess . t h e v alid ad d r ess is f r o m 0 ~ 1 2 7 . p a ra m et er pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 322 - u3 2 addr [ in] t h e usb d ev ice ad d r ess an d it c o u ld b e 0 ~ 1 2 7 . i nclu de dr iv er /dr v u s b . h ret urn va lue no n e e x a m p le / * s e t t h e usb d ev cie ad d r ess as 3 * / _ dr vusb _ set _ fa dd r ( 3 ) ; _ dr v usb_ ge t_fad dr p ro t o t y pe u in t3 2 _ t _ dr vusb _ ge t _ fa dd r ( v o id ) descript io n t o g et usb d ev ice ad d r ess . p a ra m et er no n e i nclu de dr iv er /dr v u s b . h ret urn va lue r etu r n usb d ev ice ad d r ess . e x a m p le / * g e t u sb d ev cie ad d r ess * / u 3 2 a d d r = _ dr vusb _ ge t _ f a ddr (); _ dr v usb_ ge t_ ep s ts p ro t o t y pe u in t3 2 _ t _ dr vusb _ ge t _ ep st s ( v o i d ) pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 323 - descript io n ge t u sb en d p o in t s tate s r eg i s ter ( ep s t s) v alu e. t h e s tates r eg is ter co u ld b e u s ed to id en d it y th e d etail in f o r m a tio n o f u sb ev en t. fo r d etail i n f o r m atio n o f ep st s, p lease r ef er e to nu mic r o tm t ec h n ical r ef er e n ce ma n u al. p a ra m et er no n e i nclu de dr iv er /dr v u s b . h ret urn va lue r etu r n st s r eg is ter v alu e e x a m p le / * g e t u sb st s r eg is ter v alu e * / u 3 2 r eg = _ dr vusb _ ge t _ s t s (); _ dr v usb_ s e t_cfg p p ro t o t y pe v o id _ dr vusb _ set _ c fgp ( u in t 8 _t u 8 c fgp n u m , u in t3 2 _ t u 3 2 data ) ; descript io n t o s et ex tr a co n f i g u r atio n r eg i s ter ( c fgp ) . t h e c fgp r eg is t er co u ld b e u s ed to st a l l th e en d p o in t a n d clea r en d p o in t r e ad y f la g . c fgp [ 1 ] : st a l l co n tr o l b it. set ? 1 ? to f o r ce th e en d p o in t to r esp o n s e st al l to h o s t. c fgp [ 0 ] : read y f la g an d it i s w r ite o n e clea r . p a ra m et er u8 cf g p nu m [ in] c fgp r eg is ter n u m b er ( v alid v alu e : 0 ~ 5 ) . u3 2 da t a [ in] sp ec if y d ata i n c fgp r eg is ter to st a l l t h e en d p o in t o r clea r r ea d y f la g . i nclu de dr iv er /dr v u s b . h ret urn va lue pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 324 - no n e e x a m p le / * t o s t a l l t h e en d p o in t id e n tit y 1 . * / _ dr vusb _ set _ c fgp ( 1 , 0 x 2 ) ; _ dr v usb_ ge t_cfg p p ro t o t y pe u in t3 2 _ t _ dr vusb _ ge t _ c fgp ( u in t3 2 _ t u 3 2 c fgp nu m ) ; descript io n get th e v a lu e o f ex tr a co n f i g u r atio n r eg is ter ( c fgp ) p a ra m et er u3 2 cf g p nu m [ i n] c fgp r eg is ter n u m b er ( v alid v alu e : 0 ~ 5 ) . i nclu de dr iv er /dr v u s b . h ret urn va lue r etu r n c fgp r eg is ter v a lu e e x a m p le / * get t h e r eg is ter v al u e o f c f g1 * / _ dr vusb _ g e t _ c fgp ( 1 ) ; _ dr v usb_ e na ble_ usb p ro t o t y pe v o id _ dr vusb _ e n a b l e _ u sb ( v o id ) descript io n e n ab le usb , p hy an d u s e r em o te w ak e - up p a ra m et er pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 325 - n o n e i nclu de dr iv er /dr v u s b . h ret urn va lue no n e e x a m p le / * e n ab le usb , p hy an d r e m o te w ak e u p . * / _ dr vusb _ e n a b l e _ usb ( ) ; _ dr v usb_ disable _ usb p ro t o t y pe v o id _ dr vusb _ di s a b l e _ usb ( v o id ) descript io n dis ab le usb , p hy b u t sti ll e n ab le r em o te w a k e - up p a ra m et er no n e i nclu de dr iv er /dr v u s b . h ret urn va lue no n e e x a m p le / * dis ab le u sb , p hy b u t sti ll en ab le r e m o te w ak e u p . * / _ dr vusb _ di s a b l e _ usb ( ) ; _ dr v us b_ dis ab le _ p hy p ro t o t y pe v o id _ dr vusb _ di s a b l e _ p hy ( v o id ) descript io n dis ab le p hy an d r e m o te w ak e - up . p a ra m et er pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 326 - no n e in clu de dr iv er /dr v u s b . h ret urn va lue no n e e x a m p le / * dis ab le p hy an d r e m o te wak eu p . * / _ dr vusb _ di s a b l e _ p hy () ; _ dr v us b_ en ab le_ se0 p ro t o t y pe v o id _ dr vusb _ en a b l e _ s e 0 ( v o id ) descript io n fo r ce usb to d r iv e se0 to b u s . i t c an b e u s ed to s i m u late u n p lu g ev e n t to let h o s t r e - co n n ec t to d ev ice. fo r m o r e in f o r m at i o n ab o u t se 0 , p lease r ef er to usb s tan d ar d . p a ra m et er no n e i nclu de dr iv er /dr v u s b . h ret urn va lue no n e e x a m p le / * fo r ce b u s to b e se0 s tate * / _ dr vusb _ e n a b l e _ se0 ( ) ; _ dr v usb_ dis ab le _ se0 p ro t o t y pe v o id _ dr vus b_ di s a b l e _ se0 ( v o id ) descript io n sto p to d r iv e se0 to usb b u s . pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 327 - p a ra m et er no n e i nclu de dr iv er /dr v u s b . h ret urn va lue no n e e x a m p le / * sto p to d r iv e se0 s tate to usb b u s * / _ dr vusb _ di s a b l e _ se0 ( ) ; _ dr v usb_ s e t_cfg _e p 0 p ro t o t y pe v o id _ dr vusb _ set _ c fg _e p 0 ( u in t3 2 _ t u 3 2 data ) descript io n stall co n tr o l a n d clea r i n /o u t r ea d y f la g o f en d p o in t id e n tit y 0. p lease r ef er to _ dr vusb _ set _ c fgp ( ) f o r th e b it d ef i n itio n o f c fgp r eg is ter . p a ra m et er u3 2 da t a [ in] sp ec if y d ata i n c fgp r eg is ter to st a l l t h e en d p o in t o r clea r r ea d y f la g . i nclu de dr iv er /dr v u s b . h ret urn va lue no n e e x a m p le / * t o s t a l l e n d p o in t id en ti t y 0 * / _ dr vusb _ s e t _ c fg _e p 0 ( 0 x 2 ) ; _ dr v usb_ s e t_cfg _e p 1 p ro t o t y pe pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 328 - v o id _ dr vusb _ set _ c fg _e p 1 ( u in t3 2 _ t u 3 2 data ) descript io n stall co n tr o l a n d clea r i n /o u t r ea d y f la g o f en d p o in t id e n tit y 1 . p lease r ef er to _ dr vusb _ set _ c fgp ( ) f o r th e b it d ef i n itio n o f c fgp r eg is ter . p a ra m et er u3 2 da t a [ in] sp ec if y d ata i n c fgp r eg is ter to st a l l t h e en d p o in t o r clea r r ea d y f la g . i nclu de dr iv er /dr v u s b . h ret urn va lue no n e e x a m p le / * t o s t a l l e n d p o in t id en ti t y 1 * / _ dr vusb _ s e t _ c fg _e p 1 ( 0 x 2 ) ; _ dr v usb_ s e t_cfg _e p 2 p ro t o t y pe v o id _ dr vusb _ set _ c fg _e p 2 ( u in t3 2 _ t u 3 2 data ) descript io n stall co n tr o l a n d clea r i n /o u t r ea d y f la g o f en d p o in t id e n tit y 2 . p lease r ef er to _ dr vusb _ set _ c fgp ( ) f o r th e b it d ef i n itio n o f c fgp r eg is ter . p a ra m et er u3 2 da t a [ in] sp ec if y d ata i n c fgp r eg is ter to st a l l t h e en d p o in t o r clea r r ea d y f la g . i nclu de dr iv er /dr v u s b . h ret urn va lue no n e pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 329 - e x a m p le / * t o s t a l l e n d p o in t id en ti t y 2 * / _ dr vusb _ s e t _ c fg _e p 2 ( 0 x 2 ) ; _ dr v usb_ s e t_cfg p 3 p ro t o t y pe v o id _ dr vusb _ set _ c fg _e p 3 ( u in t3 2 _ t u 3 2 data ) descript io n stall co n tr o l a n d clea r i n /o u t r ea d y f la g o f en d p o in t id e n tit y 3 . p lease r ef er to _ dr vusb _ set _ c fgp ( ) f o r th e b it d ef i n itio n o f c fgp r eg is ter . p a ra m et er u3 2 da t a [ in] sp ec if y d ata i n c fgp r eg is ter to st a l l t h e en d p o in t o r clea r r ea d y f la g . i nclu de dr iv er /dr v u s b . h ret urn va lue no n e e x a m p le / * t o s t a l l e n d p o in t id en ti t y 3 * / _ dr vusb _ s e t _ c fg _e p 3 ( 0 x 2 ) ; _ dr v usb_ s e t_cfg p 4 p ro t o t y pe v o id _ dr vusb _ set _ c fg _e p 4 ( u in t3 2 _ t u 3 2 data ) desc ript io n stall co n tr o l a n d clea r i n /o u t r ea d y f la g o f en d p o in t id e n tit y 4 . p lease r ef er to _ dr vusb _ set _ c fgp ( ) f o r th e b it d ef i n itio n o f c fgp r eg is ter . p a ra m et er pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 330 - u3 2 da t a [ in] sp ec if y d ata i n c fgp r eg is ter to st a l l t h e en d p o in t o r clea r r ea d y f la g . i nclu d e dr iv er /dr v u s b . h ret urn va lue no n e e x a m p le / * t o s t a l l e n d p o in t id en ti t y 4 * / _ dr vusb _ s e t _ c fg _e p 4 ( 0 x 2 ) ; _ dr v usb_ s e t_cfg p 5 p ro t o t y pe v o id _ dr vusb _ set _ c fg _e p 5 ( u in t3 2 _ t u 3 2 data ) descript io n stall co n tr o l a n d clea r i n /o u t r ea d y f la g o f en d p o in t id e n tit y 5 . p lease r ef er to _ dr vusb _ set _ c fgp ( ) f o r th e b it d ef i n itio n o f c fgp r eg is ter . p a ra m et er u3 2 da t a [ in] sp ec if y d ata i n c fgp r eg is ter to st a l l t h e en d p o in t o r clea r r ea d y f la g . i nclu de dr iv er /dr v u s b . h ret urn va lue no n e e x a m p le / * t o s t a l l e n d p o in t id en t i t y 5 * / _ dr vusb _ s e t _ c fg _e p 5 ( 0 x 2 ) ; pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 331 - 14.7. functions drvus b_g e tve rs ion p ro t o t y pe u in t3 2 _ t dr v u sb _ getve r s io n ( v o id ); descript io n get th i s m o d u le ? s v er s io n . p a ra m et er no n e i nclu de dr iv er /dr v u s b . h ret urn va lue ver s io n n u m b er : e x a m p le / * t o g et m o d u le ? s v er s io n * / u 3 2 ver s io n = dr v u sb _ getve r s io n (); drvus b_o pen p ro t o t y pe in t3 2 _ t dr v usb _ op en ( v o id * p vo id ) descript io n t h is f u n ctio n is u s ed to r eset u sb co n tr o ller , in itial t h e us b en d p o in ts , in ter r u p t s , an d u sb d r iv er s tr u ct u r es. i t a ls o u s ed t o ca ll th e r elativ e h an d ler w h e n th e u sb is attac h ed b ef o r e usb d r iv er o p en ed . t h e u s er m u s t p r o v id e th e m ater ial s b e f o r e th e y ca n ca ll dr v usb _ op en , in cl u d in g s e p descr ip tio n , g _ s b u s op s . 31:24 23:16 15:8 7:0 00000000 major_n um minor_num build_num pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 332 - s e p descr ip tio n : t h e s tr u ctu r e t y p e o f s e p desc r ip tio n is as f o llo w s : typ ed ef s tr u ct { //b it7 is d ir ec to r y b it, 1 : in p u t; 0 : o u tp u t u in t3 2 _ t u 3 2 e p a d d r ; u in t3 2 _ t u 3 2 ma xp a ck ets iz e; u in t 8 _t * u 8 s r a mb u ffer ; }s _ dr v us b _ e p _ c trl; t h is s tr u ct u r e is u s ed to s et th e en d p o in t n u m b er , m a x i m u m p ac k et s ize, an d b u f f er o f s p ec if ied en d p o in t h ar d w ar e. t h er e ar e 6 en d p o in ts h ar d w ar e av ailab le in nu c 1 0 0 s er ies usb co n tr o ller . g _ s b u s op s : t h e s tr u ctu r e t y p e o f g _ s b u s o p s is as f o llo w s : typ ed ef s tr u ct { p f n _ dr v us b _ c a ll b a c k a p fn c a llb a ck ; v o id * a p c a llb a ck a r g u ; }s _ dr v us b _ e v e n t_ p r oc e s s i t is u s ed to in s tall t h e usb b u s ev e n t h a n d ler , s u c h as f o llo w s : /* b u s ev e n t c a l l b a c k * / s _ drvu s b_ e ve nt _ pr oces s g _ sbu so p s[ 6 ] = { {null , null } , /* a tt a c h e v e n t c a ll b a c k * / {null , null } , /* d e ta c h e v e n t c a ll b a c k * / {dr v us b_ bu sre se tca ll b a c k , & g _ hid _ sd e v ice }, /* b u s re se t e v e n t c a ll b a c k * / {null , null } , /* b u s s u sp e n d e v e n t c a ll b a c k * / {null , null } , /* b u s re su m e e v e n t c a ll b a c k * / {dr v us b_ ctrls e tu p ack , & g _ hi d_ sd e v ice }, / * se tu p e v e n t c a ll b a c k * / }; p a ra m et er pvo id nul l none callback function if the pvoid is not null, it will be the callback function of usb pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 333 - interrupt and it is called after drvusb_predispatchevent in usb interrupt handler i nclu de dr iv er /dr v u s b . h ret urn va lue e _ suc c e ss : s u cc ee d e x a m p le / * t o o p en usb d ev ice * / i3 2 r et = dr v usb _ op en ( 0 ) ; if ( i3 2 r et ! = e _ su c c e ss ) r etu r n i3 2 r et; drvus b_clos e p ro t o t y pe v o id dr v u sb _ c lo s e ( v oi d ); descript io n c lo s e usb co n tr o ller an d d is a b le usb in ter r u p t . i nclu de dr iv er /dr v u sb .h ret urn va lue no n e e x a m p le / * t o clo s e usb d ev ice * / dr v usb _ c lo s e( ) ; drvus b_p re di s patc h e v e nt p ro t o t y pe v o id dr v usb _ p r edisp atch e v en t( v o id ) ; descript io n p r e - d is p atch ev e n t b ase o n e v f r eg is ter . p a ra m et er no n e pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 334 - i nclu de dr iv er /dr v u s b . h ret urn va lue no n e e x a m p le / * t o p r e d is p atch usb d ev ice ev en t s at i r q h an d ler * / usb d_ i r qha n d ler ( ) { dr v usb _ p r edisp atch e v en t( ) ; } drvus b_dis patc he v e nt p ro t o t y pe v o id dr v usb _ dis p atc h e v e n t ( v o id ) descript io n d is p atch m is c a n d en d p o in t e v en t . mi s c ev e n t i n cl u d e attac h /d etac h /b u s r eset /b u s s u s p en d /b u s r es u m e an d s e tu p ac k, misc e v en t ' s h a n d ler is d ef in ed b y g _ s b u s op s [ ] . t h e u s er m u s t p r o v id e g _ s b u s op s [ ] b ef o r e u s in g usb d r iv er . p a ra m et er no n e i nclu de dr iv er /dr v u sb .h ret urn va lue no n e e x a m p le / * t o d is p atch usb ev en t s to h an d le t h e m b y r elate d ca llb ac k f u n cito n s . * / dr v usb _ dis p atc h e v e n t( ) ; drvus b_i s data 0 p ro t o t y pe in t3 2 _ t d r v usb _ i s data 0 ( u i n t 3 2 _ t u 3 2 e p i d ) descript io n t o ch ec k if t h e c u r r en t d a t a is d a t a 0 . i f it is f alse, t h en i t s h o u ld b e da t a 1 . pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 335 - p a ra m et er u 3 2 e p i d t h e h ar d w ar e en d p o in t id . t h e id co u ld b e 0 ~ 5 . i nclu de dr iv er /dr v u sb .h ret urn va lue true the current data packet is data0 false the current data packet is data1 e x a m p le / * get to g g le b it o f e n d p o in t i d en tit y 2 * / if ( dr v u sb _ i s data 0 ( 2 ) ) { / * t h e to g g le b it o f e n d p o in t i d en tit y 2 is d a t a 0 * / } drvus b_g e tu s bsta t e p ro t o t y pe e _ dr vusb _ st a t e dr v us b _ getusb state( v o id ) descript io n get cu r r en t u sb s tate e _ dr v usb _ st a t e . t h e s tatu s li s t as f o llo w s: usb status description edrvusb_detached the usb has been detached. edrvusb_attached the usb has been attached. edrvusb_powered the usb is powered. edrvusb_default the usb is in normal state. edrvusb_address the usb is in address state. edrvusb_co nfigured the usb is in configuration state. edrvusb_suspended the usb is suspended. p a ra m et er no n e i nclu de dr iv er /dr v u sb .h ret urn va lue t o r etu r n th e c u r r en t u sb s tat e. e x a m p le / * get cu r r e n t u sb s tate */ eusb state = dr v u sb _ getusb state( ) ; pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 336 - if ( eusb state == ed r vu sb _ de t a c he d) { / * usb u n p lu g * / } drvus b_s e tu s bsta te p ro t o t y pe v o id dr v usb _ setu s b state( e _ dr vusb _ st a t e eusb state) descript io n t o c h an g e c u r r en t u sb s tate . p lease r ef er to dr v usb _ getusb state f o r av ai lab le s tates. p a ra m et er eusb state t h e usb s tate. i nclu de dr iv er /dr v u sb .h ret urn va lue no n e e x a m p le / * s et c u r r en t u sb s tate */ dr v usb _ s etu s b state( edr v usb _ de t a c he d ); drvus b_ ge tepide nt i ty p ro t o t y pe u in t3 2 _ t d r v usb _ gete p i d en tit y ( u in t3 2 _ t u 3 2 e p nu m , u i n t3 2 _ t u 3 2 e p a ttr) descript io n t o g et en d p o in t i n d ex b ase o n en d p o in t n u m b er an d d ir ec tio n . t h e en d p o in t id is u s ed to id en ti f y t h e h ar d w ar e en d p o in t r eso u r ce . t h e r an g e o f en d p o in t i n d ex co u ld b e 0 ~ 5 . t h e en d p o in t n u m b er is a s s i g n ed b y s o f t w ar e an d it c o u ld b e 0 ~ 1 5 ac co r d in g to usb s tan d ar d . ho s t w ill ac ce s s th e d ev ice th r o u g h r elativ e e n d p o in t n u m b e r . p a ra m et er u32epnum the endpoint number (0 ~ 15) u32epattr the endpoint number attribute. it could be ep_input or ep_output i nclu de dr iv er /dr v u sb .h ret urn va lue pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 337 - 0 ~5 the endpoint id of specified endpoint addres s. otherwise can't get relativ e endpoint id according to the input endpoint address . e x a m p le / * get t h e h ar d w ar e en d p o in t i d en tit y o f usb out en d p o in t 3 */ u 3 2 e p i d = dr v usb _ gete p i d en tit y ( 3 , e p _ ou t p ut ) ; drvus b_ ge tepid p ro t o t y pe u in t3 2 _ t d r v usb _ gete p i d ( u i n t3 2 _ t u 3 2 e p nu m ) descript io n get en d p o in t i n d ex b ase o n en d p o in t ad d r ess . t h is ar g u m e n t u 3 2 e p nu m i s d if f er en t f r o m dr v usb _ gete p i d en tit y 's b ec au s e it s ar g u m e n t i n cl u d es d ir ec tio n b it ( b it 7 ) . eg : 0 x 8 1 . i f t h e b it 7 is h ig h , it i n d icate s t h is i s e p _ i n p u t , o th er w i s e it is e p _ ou t p u t . p a ra m et er u 3 2 e p nu m t h e en d p o in t a d d r ess w it h d ir ec tio n in f o r m at io n at b it 7 . i nclu de dr iv er /dr v u sb .h ret urn va lue 0~5 the endpoint id of specified endpoint address. o th erwise can't get relativ e endpoint id according to the input endpoint address . e x a m p le / * get t h e h ar d w ar e en d p o in t i d en tit y o f usb i n en d p o in t 4 */ u 3 2 e p i d = dr v usb _ gete p i d en tit y ( 0 x 8 4 ); drvus b_da taouttrig ger p ro t o t y pe in t3 2 _ t d r v usb _ data o u tt r ig g er ( u i n t3 2 _ t u 3 2 e p nu m , u in t 3 2 _ t u 3 2 size) descript io n t r ig g er d ata o u t r ea d y f lag b y w r ite mx p l d r eg i s ter . i t in d i ca tes th e r elati v e en d p o in t b u f f er is r ea d y to r ec ei v e d ata o u t p ac k et. p a ra m et er pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 338 - u32epnum the endpoint number (0~15) u32size maximum size want to receive from usb i nclu de dr iv er /dr v u sb .h return value 0 succee d <0 can't get relativ e endpoint id according to the input endpoint address . e x a m p le / * t r ig g er en d p o in t n u m b er 2 to r ec eiv e out p ac k et o f h o s t an d th e m a x i m u m p ac k et s ize is 6 4 b y tes */ drvusb_dataouttrigger( 2 , 64 ); drvus b_g e tout data p ro t o t y pe u in t 8 _ t * dr v u sb _ getou tda t a( u in t3 2 _ t u 3 2 e p nu m , u i n t3 2 _ t * u 3 2 size) descript io n t h is f u n ctio n w ill r et u r n t h e b u f f er p o in ter o f u 3 2 e p nu m ' s o u t u sb sr am b u f f er . user ca n u s e t h is p o in ter to g e t th e d ata p ay lo ad o f c u r r en t d ata o u t p ac k et. p a ra m et er u 3 2 epnum the endpo int number (0~15) u32size data size receive d from usb i nclu de dr iv er /dr v u sb .h ret urn va lue t o r etu r n usb sr a m ad d r ess . e x a m p le / * get t h e b u f f er ad d r ess an d s ize o f r ec eiv ed d ata o f en d p o in t n u m b er 2 */ p u 8 e p b u f = dr v usb _ geto u t data ( 2 , & u 3 2 size) ; drvus b_ data in p ro t o t y pe pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 339 - in t3 2 _ t dr v usb _ data i n ( u in t3 2 _ t u 3 2 e p nu m , co n s t u i n t 8 _t * u 8 b u f f er , u i n t3 2 _ t u 3 2 size) descript io n t r ig g er r ea d y f lag f o r s en d i n g d ata af ter r ec eiv e i n to k en f r o m h o s t, usb w il l sen d t h e d ata . if u 8 b u f f er == nu l l & & u 3 2 size == 0 th en s e n d d a t a 1 al w a y s el s e d a t a 0 an d d a t a 1 b y t u r n s . p a ra m et er u32epnum the endpoint number (0~15) u8buffer the data buffer for data in token u32size the size of data buffer i nclu de dr iv er /dr v u sb .h return value 0 successful e_drvusb_size_too_long the size is lar ger than maximum packet size e x a m p le / * p r ep ar e 2 b y tes d ata f o r en d p o in t n u m b er 0 i n tr an s ac tio n . */ dr v usb _ data i n ( 0 , au 8 data , 2 ) ; drvus b_bus res e tc a ll bac k p ro t o t y pe v o id dr v usb _ b u s r eset c allb ac k ( v o id * p vo id ) descript io n b u s r eset h a n d ler . af ter r ec eiv in g b u s r eset e v en t , th i s h a n d l er w ill b e ca lled . i t w il l r eset usb ad d r ess , ac ce p t se t up p ac k et an d in i tial t h e en d p o in t s . p a ra m et er p vo id p ar am eter p ass ed b y g _ s b u s o p s [ ] . i nclu de dr iv er /dr v u sb .h ret urn va lue no n e e x a m p le pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 340 - / * b u s e v e n t c all b ac k * / s_ dr vu sb _ e ve nt _ p r oc e ss g _ s b u s op s [ 6 ] = { {nu l l , nu l l }, /* at tach ev e n t c allb ac k * / {nu l l , nu l l }, /* d etac h ev e n t c allb ac k * / {dr v usb _ b u s r eset c allb ac k , & g _ hi d_ s de v ice} , / * b u s r eset e v e n t c allb ac k * / {nu l l , nu l l }, /* b u s s u s p e n d ev e n t c allb ac k * / {nu l l , nu l l }, /* b u s r es u m e ev e n t c allb ac k * / {dr v usb _ c tr lse tu p a c k , & g _ hi d_ s dev ice} , /* s et u p ev en t c allb ac k * / }; drvus b_i nsta ll cl a s s dev ic e p ro t o t y pe v o id * dr v u sb _ i n s tall c las s d ev ice( s_ dr vusb _ c l a s s * s usb c la s s ) descript io n r eg i s ter usb clas s d ev ice to usb d r iv er . p a ra m et er s usb c la s s usb class s tr u ct u r e p o in ter . i nclu de dr iv er /dr v u sb .h ret urn va lue r etu r n usb d r iv er p o in ter e x a m p le / * r e g is ter u sb class d ev ice to usb d r iv er . */ g _ hi d_ s dev ice. d ev ice = ( v o i d * ) dr v usb _ i n s tal lc la s s de v i ce ( & s hid u s b c las s ) ; drvus b_i nsta ll ct rlha ndle r p ro t o t y pe in t3 2 _ t d r v usb _ i n s ta llc tr l h an d ler ( v o id * * d e v ice, s_ dr vusb _ c t r l _ c al l b a c k_ e nt r y * p s c tr l c allb ac k e n tr y , u in t3 2 _ t u 3 2 r eg c n t ) descript io n pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 341 - r eg i s ter ctr l p ip e h an d ler in cl u d in g set up a c k , i n a c k , out a c k h a n d le f o r stan d ar d /ven d o r /c la s s co m m an d . parameter device usb driver device pointer . psctrlcallbackentry handler structure pointer . u32regcnt handler structure size . i nclu de dr iv er /dr v u sb .h return value 0 success e_drvusb_null_pointer n ull function pointer e x a m p le / * r e g is ter ctr l p ip e h an d ler . */ i3 2 r et = dr v usb _ i n s tal lc tr l han d ler ( g _ hi d_ s de v ice. d ev i ce , g _ asc tr l c allb ac k e n tr y , s izeo f ( g _ a s c tr l c allb ac k e n tr y ) / sizeo f ( g _ as c tr l c allb ac k e n tr y [ 0 ] ) ) ; drvus b_ct rls e tu pac k p ro t o t y pe v o id dr v usb _ c tr lse tu p a c k ( v o id * p a r g u ) descript io n w h en set up ac k in ter r u p t h a p p en , th is f u n ctio n w ill b e ca ll ed . i t w i ll c all set up h an d ler th at dr v usb _ i n s tal lc tr lha n d l er r eg is ter ed b ase o n co m m a n d ca teg o r y a n d co m m an d . p a ra m et er p a r g u p ar am eter p ass ed b y g _ s b u s o p s [ ] . i nclu de dr iv er /dr v u sb .h ret urn va lue no n e e x a m p le / * b u s e v e n t c all b ac k * / s_ dr vu sb _ e ve nt _ p r oc e ss g _ s b u s op s [ 6 ] = { {nu l l , nu l l }, /* at tach ev e n t c allb ac k * / {nu l l , nu l l }, /* d etac h ev e n t c allb ac k * / pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 342 - {dr v usb _ b u s r eset c allb ac k , & g _ hi d_ s de v ice} , / * b u s r eset e v e n t c allb ac k * / {nu l l , nu l l }, /* b u s s u s p e n d ev e n t c allb ac k * / {nu l l , nu l l }, /* b u s r es u m e ev e n t c allb ac k * / {dr v usb _ c tr lse tu p a c k , & g _ hi d_ s dev ice} , /* s et u p ev en t c allb ac k * / }; drvus b_ct rlda tainac k p ro t o t y pe v o id dr v usb _ c tr ldatai n a c k ( v o id * p a r g u ) descript io n w h en i n ac k i n ter r u p t h ap p e n , th is f u n ctio n w ill b e ca lled . i t w ill ca l l i n ac k h an d ler t h at dr v usb _ i n s ta llc tr l han d ler r eg is ter ed b ase o n co m m a n d ca teg o r y an d co m m a n d . p a ra m et er p a r g u p ar am eter p ass ed b y g _ s b u s o p s [ ] . i nclu de dr iv er /dr v u sb .h ret urn va lue no n e e x a m p le / * usb e v e n t c a ll b a c k * / s _ drv u s b_ e v ent _ p roces s g _ su sb op s [ 1 2 ] = { {drv usb_ ctrl da tain a c k , & g _ h id_ sd e v ice }, / * c trl p ip e 0 (e p a d d re ss 0 ) in a ck c a ll b a c k * / {drv usb_ ctrl da tao u ta c k , & g _ hid _ sd e v ice }, / * c trl p ip e 0 (e p a d d re ss 0 ) o u t a ck c a ll b a c k * / {hid _ in tin ca ll b a c k , & g _ h id_ sd e v ice }, / * ep a d d re ss 1 in a ck c a ll b a c k * / {nu ll , nu l l }, /* ep a d d re ss 1 ou t a ck c a ll b a c k * / {nu ll , nu l l }, /* ep a d d re ss 2 i n a ck c a ll b a c k * / {hid _ in tou tcall b a c k , & g _ hid _ sd e v ic e }, / * ep a d d re s s 2 o u t a ck c a ll b a c k * / {nu ll , nu l l }, /* ep a d d re ss 3 i n a ck c a ll b a c k * / {nu ll , nu l l }, /* ep a d d re ss 3 ou t a ck c a ll b a c k * / {nu ll , nu l l }, /* ep a d d re ss 4 i n a ck c a ll b a c k * / {nu ll , nu l l }, /* ep a d d re ss 4 ou t a ck c a ll b a c k * / {nu ll , nu l l }, /* ep a d d re ss 5 i n a ck c a ll b a c k * / {nu ll , nu l l }, /* ep a d d re ss 5 ou t a ck c a ll b a c k * / }; drvus b_ct rlda taouta c k p ro t o t y pe v o id dr v usb _ c tr ldata ou t ac k ( v o id * p a r g u ) descript io n w h en out ac k in ter r u p t h ap p en , th i s f u n ctio n w i ll b e ca lled . i t w ill ca ll ou t h an d ler t h at dr v usb _ r e g is ter c tr l r eg i s ter ed b ase o n co m m a n d ca teg o r y an d co m m a n d . pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 343 - p a ra m et er p a r g u p ar am eter p ass ed b y g _ s b u s o p s [ ] . i nclu de dr iv er /dr v u sb .h ret urn va lue no n e e x a m p le / * usb e v e n t c a ll b a c k * / s _ drv u s b_ e v ent _ p roces s g _ su sb op s [ 1 2 ] = { {drv usb_ ctrl da tain a c k , & g _ hid _ sd e v ice }, / * c trl p ip e 0 (e p a d d re ss 0 ) in a ck c a ll b a c k * / {drv us b_ ctrl da tao u ta c k , & g _ hid _ sd e v ice }, / * c trl p ip e 0 (e p a d d re ss 0 ) ou t a ck c a ll b a c k * / {hid _ in tin ca ll b a c k , & g _ hid _ sd e v ice }, / * ep a d d re ss 1 in a ck c a ll b a c k * / {nu ll , nu l l }, /* ep a d d re ss 1 ou t a ck c a ll b a c k * / {nu ll , nu l l }, /* ep a d d re ss 2 i n a ck c a ll b a c k * / {hid _ in tou tcall b a c k , & g _ hid _ sd e v ic e }, / * ep a d d re ss 2 ou t a ck c a ll b a c k * / {nu ll , nu l l }, /* ep a d d re ss 3 i n a ck c a ll b a c k * / {nu ll , nu l l }, /* ep a d d re ss 3 ou t a ck c a ll b a c k * / {nu ll , nu l l }, /* ep a d d re ss 4 i n a ck c a ll b a c k * / {nu ll , nu l l }, /* ep a d d re ss 4 ou t a ck c a ll b a c k * / {nu ll , nu l l }, /* ep a d d re ss 5 i n a ck c a ll b a c k * / {nu ll , nu l l }, /* ep a d d re ss 5 ou t a ck c a ll b a c k * / }; drvus b_ct rlda tainde fault p ro t o t y pe v o id dr v usb _ c tr ldatai n de f a u lt( v o id * p vo id ) descript io n i n ac k d ef a u lt h a n d ler . i t is u s ed to r etu r n ac k f o r n ex t o ut to k en . p a ra m et er p vo id p ar am eter p ass ed b y dr v usb _ i n s tall c tr lhan d ler . i nclu de dr iv er /dr v u sb .h ret urn va lue no n e e x a m p le / * i f n o co n tr o l d ata i n ca llb a ck in s talled , j u s t u s e d ef a u lt o n e * / if ( p s e n tr y - >p f n c tr lda tai n c al lb ac k == nul l ) p s e n tr y - >p f n c tr ldatai n c allb a ck = dr v usb _ c tr l data i n de f a u lt; pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 344 - drvus b_ct rlda taoutd e fault p ro t o t y pe v o id dr v usb _ c tr ldata ou t de f au lt( v o id * p vo id ) descript io n out a c k d ef a u lt h an d ler . i t is u s ed to r etu r n ze r o d ata len g th p ac k et w h en n e x t i n to k e n . p a ra m et er pv o id p ar am eter p ass ed b y dr v usb _ i n s tall c tr lhan d ler . i nclu de dr iv er /dr v u sb .h ret urn va lue no n e e x a m p le / * i f n o co n tr o l d ata out ca ll b ac k in s talled , j u s t u s e d ef au lt o n e * / if ( p s e n tr y - >p f n c tr lda taou tc allb ac k == nu l l ) p s e n tr y - >p f n c tr ldatao u t c all b ac k = dr v u sb _ c tr ldata ou t def a u lt; drvus b_re s e t p ro t o t y pe v o id dr v usb _ r ese t( u i n t3 2 _ t u 3 2 e p nu m ) descript io n r esto r e th e s p ec i f ied c fgx a n d c fgp x r eg is ter s ac co r d in g t h e en d p o in t n u m b er . p a ra m et er u 3 2 e p nu m t h e en d p o in t n u m b er to r eset i nclu de dr iv er /dr v u sb .h ret urn va l ue no n e e x a m p le / * r e s et en d p o in t n u m b er 2 * / dr v usb _ r ese t( 2 ); pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 345 - drvus b_clr ct rlre a d y p ro t o t y pe v o id dr v usb _ c lr c tr lr ea d y ( v o id ) descript io n c lear ctr l p ip e r ea d y f la g t h at w a s s et b y mx p l d. p a ra m et er no n e i nclu de dr iv er /dr v u sb .h ret urn va lue no n e e x a m p le / * c lear co n tr o l e n d p o in t r ea d y f la g * / dr v usb _ c lr c tr lr ea d y () ; drvus b_clr ct rlre a d y and trigs tall p ro t o t y pe v o id dr v usb _ c lr c tr lr ea d y a n d t r ig stall( v o id ) ; descript io n c lear co n tr o l p ip e r ea d y f la g t h at w as s et b y mx p l d a n d s e n d st al l . p a ra m et er no n e i nclu de dr iv er / dr v u sb .h ret urn va lue no n e e x a m p le / * c lear co n tr o l p ip e r ea d y f la g th at w a s s et b y m xp l d a n d s en d st al l . */ dr v usb _ c lr c tr lr ea d y an d t r ig stal l( ) ; pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 346 - drvus b_g e tse tu pbu ff e r p ro t o t y pe u in t3 2 _ t d r v usb _ getset u p b u f f er ( v o id ) descript io n get s etu p b u f f er ad d r ess of us b sr a m to r ea d th e r ec eiv e d s etu p p ac k et d ata. p a ra m et er no n e i nclu de dr iv er /dr v u sb .h ret urn va lue setu p b u f f er ad d r ess e x a m p le /* get setup buffer address of usb sram . */ setupbuffer = (uint8_t *)drvusb_getsetupbuffer(); drvus b_g e tf re e s ram p ro t o t y pe u in t3 2 _ t d r v usb _ getfr ee sr a m ( v o id ) descript io n get f r ee usb sr am b u f f er a d d r ess af ter e p ass ig n b ase o n s e p descr ip tio n [ i] . u 3 2 ma x p ac k etsize i n dr v usb _ op en . us er ca n g et t h is f o r d u al b u f f er . p a ra m et er no n e i nclu de dr iv er /dr v u sb .h ret urn va lue fre e usb sr a m ad d r es s e x a m p le / * get t h e b ase ad d r ess o f f r ee usb sr a m */ u 3 2 b asea d d r = dr v usb _ get fre es r a m ( ); pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 347 - drvus b_e nabl e s e lfp owe r p ro t o t y pe v o id dr v usb _ e n ab lesel f p o w er ( v o id ) descript io n e n ab le s el f - p o w er attr ib u tio n o f usb d ev ice. p a ra m et er no n e i nclu de dr iv er /dr v u sb .h re t urn va lue no n e e x a m p le / * set a f lag to n o te th e usb d ev ice is s e lf - p o w er */ dr v usb _ e n ab lesel f p o w er (); drvus b_dis a bl e s e lfpow e r p ro t o t y pe v o id dr v usb _ dis ab lesel f p o w er ( v o id ) descript io n dis ab le s el f - p o w er attr ib u tio n o f usb d ev ice. p a ra m et er no n e i nclu de d r iv er /dr v u sb .h ret urn va lue no n e e x a m p le /* c lear t h e f lag to n o te t h e u sb d ev ice is n o t sel f - p o w er */ dr v usb _ dis ab lesel f p o w er ( ) ; pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 348 - drvus b_i s s e lfpow e r e nabl e d p ro t o t y pe in t3 2 _ t dr v usb _ i s sel f p o w er e n ab led ( v o id ) descript io n self - p o w er is en ab le o r d is ab le . pa ra m et er no n e i nclu de dr iv er /dr v u sb .h return value true the device is self - powered. false the device is bus - powered. e x a m p le /* c h ec k if t h e usb d ev ice i s s elf - p o w er */ if ( dr v u sb _ i s self p o w er e n ab l ed ()) { / * t h e usb d ev ice is s el f - p o w er * / } drvus b_e nabl e rem ot e w a k e up p ro t o t y pe v o id dr v usb _ e n ab ler e m o te w ak eu p ( v o id ) descript io n e n ab le r e m o te w ak e u p attr ib u tio n o f usb d ev ice. p a ra m et er no n e i nclu de dr iv er /dr v u sb .h ret urn va lue no n e e x a m p le /* set t h e f lag to n o te t h e usb d ev ice s u p p o r ts r e m o te w ak e u p */ pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 349 - dr v usb _ e n ab ler e m o tew ak e u p ( ) ; drvus b_dis a bl e rem ot e w a k e up p ro t o t y pe v o id dr v usb _ dis ab le r e m o te w ak eu p ( v o id ) descript io n dis ab le r e m o te w ak e u p attr ib u tio n . p a ra m et er no n e i nclu de dr iv er /dr v u sb .h ret urn va lue no n e e x a m p le /* c lear t h e f lag to n o te t h e u sb d ev ice d o esn ? t s u p p o r t r em o te w ak e u p */ dr v usb _ dis ab le r e m o tew a k eu p ( ) ; drvus b_i s rem ot e w a k e upen a ble d p ro t o t y pe in t3 2 _ t d r v usb _ i s r e m o tew ak eu p e n ab led ( in t3 2 _ t * p b v o id ) descript io n r etu r n r e m o te w a k eu p is e n ab lin g o r d is ab le . p a ra m et er no n e i nclu de dr iv er /dr v u sb .h ret urn va lue t r ue su p p o r t r em o te w a k eu p f a l se no t su p p o r t r em o te w a k eu p e x a m p le /* c h ec k if t h e usb d ev ice s u p p o r ts r em o te w ak e u p . */ pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 350 - if ( dr v u sb _ i s r e m o tew a k eu p e n ab led ()) { / * r e m o te w a k eu p en ab le f la g is s et * / } drvus b_s e tm a x p ow e r p ro t o t y pe in t3 2 _ t dr v usb _ setma x p o w er ( u in t3 2 _ t u 3 2 ma x p o w er ) descript io n c o n f i g u r e m ax p o w er . t h e u n it is 2 m a . ma x i m u m ma x p o w er 0 x fa ( 5 0 0 m a ) , d ef a u lt is 0 x 3 2 ( 1 0 0 m a ) p a ra m et er u 3 2 ma x p o w er ma x i m u m p o w er v a lu e i nclu de dr iv er /dr v u sb .h ret urn va lue 0 : su cc es s f u l <0 : w r o n g m ax i m u m v a lu e e x a m p le /* set t h e m a x i m u m p o w er is 1 5 0 m a */ dr v usb _ setma x p o w er ( 7 5 ) ; drvus b_g e tm a x p ow e r p ro t o t y pe in t3 2 _ t dr v usb _ getm ax p o wer ( v o id ) descript io n get cu r r en t m ax p o w er . t h e u n it is i n 2 m a , i.e . 0 x 3 2 is 1 0 0 m a. p a ra m et er no n e i nclu de dr iv er /dr v u sb .h ret urn va lue r etu r n th e m a x i m u m p o w er . ( 2 m a u n it) pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 351 - e x a m p le /* get t h e m a x i m u m p o w er */ i3 2 p o w er = dr v usb _ g etm a x p o w er (); drvus b_e nabl e u sb p ro t o t y pe v o id dr v usb _ e n ab leu sb ( s_ dr vusb _ de vi c e * p s de v ic e ) descript io n e n ab le usb , p hy an d r em o te w a k eu p . p a ra m et er p s dev ice u sb d r iv er d ev ice p o in ter i nclu de dr iv er /dr v u sb .h ret urn va lue no n e e x a m p le /* e n ab le usb , p hy an d r e m o te w ak e u p f u n ctio n . */ dr v usb _ e n ab leu sb ( p s de v i ce ) ; drvus b_dis a bl e u sb p ro t o t y pe v o id dr v usb _ dis ab leu sb ( s_ dr vusb _ de vi c e * p s dev ice) descript io n dis ab le usb , p hy b u t k ee p r e m o te w ak e u p f u n ctio n o n . p a ra m et er p s dev ice usb d r iv er d ev ice p o in ter i nclu de dr iv er /dr v u sb .h ret urn va lue no n e pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 352 - e x a m p le /* e n ab le usb , p hy an d r e m o te w ak e u p f u n ctio n . */ dr v usb _ dis ab le u sb ( p s dev i ce ) ; drvus b_p re di s patc h w a k e upev e nt p ro t o t y pe v o id dr v usb _ p r edisp atch w ak eu p e v en t( s_ d r vu sb _ de vi c e * p s de v ice) descript io n p r e - d is p atch w ak e u p ev e n t . t h is f u n ctio n d o es n o th in g an d r eser v es f o r f u r t h er u s ag e p a ra m et er p s dev ice usb d r iv er d ev ice p o in ter i nclu de dr iv er /dr v u sb .h ret urn va lue no n e e x a m p le n /a drvus b_p re di s patc h fdt e v e nt p ro t o t y pe v o id dr v usb _ p r edisp atch fd t e v en t( s_ dr vu sb _ de vi c e * p s dev ice) descript io n p r e - d is p atch p lu g - i n a n d p lu g - o u t e v e n t p a ra m et er p s dev ice usb d r iv er d ev ice p o in ter i nclu de dr iv er /dr v u sb .h ret urn va lue no n e e x a m p le pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 353 - / * p r e - d is p atch f lo at - d etec tio n ev en t. * / dr v usb _ p r edisp atch f dt e v en t( & g s usb de v ice) ; drvus b_p re di s patc h buse v e nt p ro t o t y pe v o id dr v usb _ p r edisp atch b u s e v e n t( s_ dr vusb _ de vi c e * p s dev ice) descript io n p r e - d is p atch b us e v e n t p a ra m et er p s dev ice usb d r iv er d ev ice p o in ter i ncl u de dr iv er /dr v u sb .h ret urn va lue no n e e x a m p le / * p r e - d is p atch b u s ev e n t. * / dr v usb _ p r edisp atch b u s e v e n t( & g s usb de v ice) ; drvus b_p re di s patc h e p e v e nt p ro t o t y pe v o id dr v usb _ p r edisp atch e p e v en t( s_ d r vu sb _ de vi c e * p s dev ice) descript io n p r e - d is p atch e p ev en t i n clu d i n g i n ac k/i n n a k /out ac k/i so e n d . t h is f u n ctio n is u s ed to r ec o g n ize en d p o in t e v en t s a n d r ec o r d th em f o r f u r th er p r o ce s s i n g o f dr v usb _ dis p atc h ep e v en t (). a ll e p ev e n t h a n d ler s ar e d ef i n ed at g _ s u s b op s [ ] . p a ra m et er p s dev ice usb d r iv er d ev ice p o in ter i nclu de dr iv er /dr v u sb .h ret urn va lue no n e e x a m p le pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 354 - / * c lear u sb ev en t s in d i v id u a ll y i n s tead o f i n to tal. oth er w i s e, in co m in g usb ev e n t s m a y b e clea r ed m i s ta k en l y . p r e - d is p at ch usb ev e n t. * / dr v usb _ p r edisp atch e p e v en t( & g s usb de v ice) ; drvus b_dis patc hw a k e upev e nt p ro t o t y pe v o id dr v usb _ dis p atc h w ak e u p e v e n t( s_ dr v usb _ de vi c e * p s de v ice) descript io n dis p atch w a k e u p ev en t. t h is f u n ct io n d o es n o t h in g a n d r eser v es f o r f u r t h er u s ag e. p a ra m et er p s dev ice usb d r iv er d ev ice p o in ter i nclu de dr iv er /dr v u sb .h ret urn va lue no n e e x a m p le n/ a dr v usb_ dis patc hm is c e v e nt p ro t o t y pe v o id dr v usb _ dis p atc h misce v en t( s_ dr vu sb _ de vi c e * p s dev ice) descript io n dis p atch mi s c ev e n t . t h e ev e n t is s et b y attac h /d etac h /b u s r eset/b u s s u s p en d /b u s r esu m e a n d s etu p ac k . misc e v en t ' s h a n d ler is d ef in ed at g _ s b u s op s [ ] . pa ra m et er p s dev ice usb d r iv er d ev ice p o in ter i nclu de dr iv er /dr v u sb .h ret urn va lue no n e e x a m p le / * p ar s in g th e mi s c ev e n t s an d ca ll r elativ e h a n d les * / pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 355 - dr v usb _ dis p atc h misce v e n t( & g s u s b dev ice) ; drvus b_dis patc he p e v e nt p ro t o t y pe v o id dr v usb _ dis p atc h e p e v en t( s_ dr v usb _ de vi c e * p s dev ice) descript io n dis p atch e p ev en t, th e e v en t i s s et b y dr v usb _ p r edisp atch e p e v en t () in cl u d in g i n a c k / i n nak/ou t ac k/i so e n d . t h e e p ev en t' s h a n d ler is d ef i n ed at g _ s usb op s [ ] . p a ra m et er p s dev ice usb d r iv er d ev ice p o in ter i nclu de dr iv er /dr v u sb .h ret urn va lue no n e e x a m p le / * p ar s in g th e e n d p o in t e v e n t s an d ca ll r elativ e h a n d ler s * / dr v usb _ dis p atch e p e v e n t ( & g s u s b dev ice) ; drvus b_ct rls e tu pse ta ddre s s p ro t o t y pe v o id dr v usb _ c tr lse tu p set a d d r ess ( v o id * p vo id ) descript io n setu p a c k h a n d ler f o r s et a d d r ess co m m a n d . p a ra m et er p vo id p ar am eter p ass ed b y dr v usb _ i n s tall c tr lhan d ler i nclu de dr iv er /dr v u sb .h ret urn va lue no n e e x a m p le / * c trl p ip e c a ll b a c k . * / pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 356 - / * it w il l b e c a ll b y drv usb_ ctrl s e tu p a c k , drv usb_ ctrl da tain a c k a n d drv usb_ ctrl da tao u ta c k * / / * i f in a c k h a n d ler an d o u t a c k h a n d ler i s 0 , d e f a u lt h a n d ler w il l b e c a ll e d */ s _ drv u s b_ ct rl _ call b a c k_ ent ry g _ a sctrlcallb a c k en try [ ] = { // re q u e st t y p e , c o m m a n d , se tu p a c k h a n d ler, i n a c k h a n d ler, o u t a c k h a n d ler, p a ra m e ter {req_ s t a n d a rd, s et _ ad d res s , drv usb_ ctrl s e tu p s e ta d d re ss , drv usb_ ctrl da tai n s e ta d d re ss , 0 , & g _ hid _ sd e v ice } }; drvus b_ct rls e tu pcle a rs e tf e a tu re p ro t o t y pe v o id dr v usb _ c tr lse tu p c lear setfeat u r e( v o id * p vo id ) descript io n setu p a c k h a n d ler f o r c lear f ea t u r e co m m a n d . p a ra m et er p vo id p ar am eter p ass ed b y dr v usb _ i n s tall c tr lhan d ler i nclu de dr iv er /dr v u sb .h ret urn va lue no n e e x a m p le s _ drv u s b_ ct rl _ call b a c k_ ent ry g _ a sctrlcallb a c k en try [ ] = { // re q u e st t y p e , c o m m a n d , se tu p a c k h a n d ler, i n a c k h a n d ler, o u t a c k h a n d ler, p a ra m e ter {req_ s t a n d a rd, cl e a r_ f eat ure, drv usb_ ctrl s e tu p cl e a rs e tf e a tu re , 0 , 0 , & g _ hid _ sd e v ic e } }; drvus b_ct rls e tu pge tc onf igura tion p ro t o t y pe v o id dr v usb _ c tr lse tu p get c o n f i g u r atio n ( v o id * p vo id ) descript io n setu p a c k h a n d ler f o r get co n f ig u r atio n co m m a n d . p a ra m et er p vo id p ar am eter p ass ed b y dr v usb _ i n s tall c tr lha n d ler i nclu de dr iv er /dr v u sb .h ret urn va lue no n e pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 357 - e x a m p le s _ drv u s b_ ct rl _ call b a c k_ ent ry g _ a sctrlcallb a c k en try [ ] = { // re q u e st t y p e , c o m m a n d , se tu p a c k h a n d ler, i n a c k h a n d ler, o u t a c k h a n d ler, p a ra m e ter {req_ s t a n d a rd, g et _ con f ig ur at ion , drv usb_ ctrl s e t u p g e tco n f i g u ra ti o n , 0 , 0 , & g _ hid _ sd e v ic e } }; drvus b_ct rls e tu pge tstatu s p ro t o t y pe v o id dr v usb _ c tr lse tu p get st atu s ( v o id * p vo id ) descript io n setu p a c k h a n d ler f o r g et s t atu s co m m a n d . p a ra m et er p vo id p ar am eter p ass ed b y dr v usb _ i n s tall c tr lhan d ler i nclu de dr iv er /dr v u sb . h ret urn va lue no n e e x a m p le s _ drv u s b_ ct rl _ call b a c k_ ent ry g _ a sctrlcallb a c k en try [ ] = { // re q u e st t y p e , c o m m a n d , se tu p a c k h a n d ler, i n a c k h a n d ler, o u t a c k h a n d ler, p a ra m e ter {req_ s t a n d a rd, g et _ s tat us, drv usb_ ctrl s e tu p g e ts tatu s, 0 , 0 , & g _ hid _ sd e v ice } }; drvus b _ ct rls e tu pge tint e rfac e p ro t o t y pe v o id dr v usb _ c tr lse tu p geti n ter f ac e( v o id * p vo id ) descript io n setu p a c k h a n d ler f o r g et in ter f ac e co m m an d . p a ra m et er p vo id p ar am eter p ass ed b y dr v usb _ i n s tall c tr lhan d ler i nclu de dr iv er /dr v u sb .h ret urn va lue pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 358 - no n e e x a m p le s _ drv u s b_ ct rl _ call b a c k_ ent ry g _ a sctrlcallb a c k en try [ ] = { // re q u e st t y p e , c o m m a n d , se tu p a c k h a n d ler, i n a c k h a n d ler, o u t a c k h a n d ler, p a ra m e ter {req_ s t a n d a rd, g et _ in t erf a ce, drv usb_ ctrl s e tu p g e ti n terf a c e , 0 , 0 , & g _ hid _ sd e v ice } }; drvus b_ct rls e tu p s e tint e rfac e p ro t o t y pe v o id dr v usb _ c tr lse tu p s eti n t er f ac e( v o id * p vo id ) descript io n setu p a c k h a n d ler f o r s et in t er f ac e co m m an d . p a ra m et er p vo id p ar am eter p ass ed b y dr v usb _ i n s tall c tr lhan d ler i nclu de dr iv er /dr v u sb .h ret urn va lue no n e e x a m p le s _ drv u s b_ ct rl _ call b a c k_ ent ry g _ a sctrlcallb a c k en try [ ] = { // re q u e st t y p e , c o m m a n d , se tu p a c k h a n d ler, i n a c k h a n d ler, o u t a c k h a n d ler, p a ra m e ter {req_ s t a n d a rd, s et _ int e rf a ce, drv usb_ ctrl s e tu p s e ti n terf a c e , 0 , 0 , & g _ hid _ sd e v ice } }; drvus b_ct rls e tu pse tc onf igura tion p ro t o t y pe v o id dr v usb _ c tr ls e tu p set c o n f i g u r atio n ( v o id * p vo id ) descript io n setu p a c k h a n d ler f o r s et co n f ig u r atio n co m m a n d . p a ra m et er p vo id p ar am eter p ass ed b y dr v usb _ i n s tall c tr lhan d ler i nclu de dr iv er /dr v u sb .h pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 359 - ret urn va lue no n e e x a m p le s _ drv u s b_ ct rl _ call b a c k_ ent ry g _ a sctrlcallb a c k en try [ ] = { // re q u e st t y p e , c o m m a n d , se tu p a c k h a n d ler, i n a c k h a n d ler, o u t a c k h a n d ler, p a ra m e ter {req_ s t a n d a rd, s et _ con f ig ur at ion , drv usb_ ctrl s e t u p s e tc o n f i g u ra ti o n , 0 , 0 , & g _ hid _ sd e v ic e } }; drvus b_ct rlda tains e ta ddre s s p ro t o t y pe v o id dr v usb _ c tr ldatai n set a d d r ess ( v o id * p vo id ) descript io n setu p a c k h a n d ler f o r s et ad d r ess co m m a n d . p a ra m et er p vo id p ar am eter p ass ed b y dr v usb _ i n s tall c tr lhan d ler i nclu de dr iv er /dr v u sb .h ret urn va lue no n e e x a m p le s _ drv u s b_ ct rl _ call b a c k_ ent ry g _ a sctrlcallb a c k en try [ ] = { // re q u e st t y p e , c o m m a n d , se tu p a c k h a n d ler, i n a c k h a n d ler, o u t a c k h a n d ler, p a ra m e ter {req_ s t a n d a rd, s et _ ad d res s , drv usb_ ctrl s e tu p s e ta d d re ss , drv usb_ ctrl da tai n s e ta d d re ss , 0 , & g _ hid _ sd e v ice } }; drvus b_ me mc p y p ro t o t y pe v o id dr v usb _ m e m cp y ( u i n t8 _ t * p i8 des t, u i n t8 _ t * p i8 src , u in t3 2 _ t u 3 2 size) descript io n t h e usb b u f f er is r ec o m m e n d ed to b e b y te ac ce s s t h u s t h is f u n ctio n is i m p le m e n ted b y b y te ac ce s s . p a ra m et er p i8 dest : desti n atio n p o in ter pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 360 - p i8 src : so u r ce p o in ter u 3 2 size : data s ize. t h e u n it is b y te. i nclu de dr iv er /dr v u sb .h re t urn va lue no n e e x a m p le / * co p y 6 4 b y tes d a ta f ro m usb s ra m to s ra m * / drv usb_ m e m c p y (0 x 2 0 0 0 0 8 0 0 , 0 x 4 0 0 6 0 1 0 0 , 6 4 ) ; pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 361 - 15. pdm a dri ver 15.1. pdma introduction t h e n u mic r o tm nuc1 0 0 s er ies co n tai n s a p er ip h er al d ir ec t m e m o r y ac ce s s ( p dm a ) co n tr o ller th at tr an s f er s d ata to an d f r o m m e m o r y o r tr an s f er d ata to an d f r o m p er ip h er als a d v an ce d p er ip h er al b u s ( a p b ) . t h e p dm a h a s u p to n i n e ch a n n el s o f dm a ( p er ip h er al - to - me m o r y o r me m o r y - to - p er ip h er a l o r me m o r y - to - me m o r y ) . fo r ea ch p dm a c h an n el ( p dm a c h 0 ~c h8 ) , th er e is o n e w o r d b u f f er to d o tr an s f er buffer between the p er ip h er als a p b i p an d me m o r y . so f t w ar e ca n s to p th e p dm a o p er atio n b y d is ab le p dm a [ p dm a c e n] . t h e c p u ca n r ec o g n ize t h e co m p let io n o f a p dm a o p er atio n b y s o f t w ar e p o llin g o r w h en it r ec eiv e s an i n ter n al p dm a i n ter r u p t. t h e p dm a co n tr o ller ca n i n cr e m e n t so u r ce o r d esti n at io n ad d r ess an d f i x ed th e m as w e ll. 15.2. pdm a fea tu re the pdma includ es f o llo w in g f ea t u r es: ? ? advanced mic r o co n tr o ller b u s a r c h itect u r e a d v a n ce d hig h - p er f o r m a n ce b u s ( a m b a a hb ) m aster / s la v e in ter f ac e co m p at i b le, f o r d ata tr an s f er an d r eg i s t er r ea d /w r ite . ? ? pdma sup p o r t 32 - b it so u r ce an d d esti n at io n ad d r ess in g r an g e ad d r ess in cr e m en t a n d f i x e d . ? ? up to 9 ch an n e ls o f dm a . p l ea s e r ef er to nu mic r o tm nu c 1 0 0 ser ies p r o d u c ts selectio n gu id e o f a p p en d i x to k n o w t h e n u m b er o f dm a ch a n n e l. 15.3. con s tan t de fin i tio n constant name value description channel_offset 0x 10 0 pdma channel register offset 15.4. type definition e_drvpdma_channel_index enumeration identifier value description ed rvpdma_channel_0 0 pdma channel 0 pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 362 - edrvpdma_channel_ 1 1 pdma channel 1 edrvpdma_channel_ 2 2 pdma channel 2 edrvpdma_channel_ 3 3 pdma channel 3 edrvpdma_channel_ 4 4 pdma channel 4 edrvpdma_channel_ 5 5 pdma channel 5 edrvpdma_channel_ 6 6 pdma channel 6 edrvpdma_channel_ 7 7 pdma channel 7 edrvpdma_channel_ 8 8 pdma channel 8 e_drvpdma_direction_select enumeration identifier value description edrvpdma_direction_incremented 0 source/destination address direction is incremented. edrvpdma_direction_fixed 2 source/destination address direction is fixed. e_drvpdma_transfer_width enumeration identifier value description edrvpdma_width_32bits 0 one word is transferred for every pdma operation in ip - to - memory/memory - to - ip mode. edrvpdma_width_8bits 1 one byt e is transferred for every pdma operation in ip - to - memory/memory - to - ip mode. edrvpdma_width_16bits 2 half word is transferred for every pdma operation in ip - to - memory/memory - to - ip mode. e_drvpdma_int_enable enumeration identifier value description edrvp dma_tabort 1 target abort interrupt/flag edrvpdma_blkd 2 transferred done interrupt/flag e_drvpdma_apb_device enumeration identifier value description edrvpdma_spi0 0 pdma source/destination apb device is spi0 edrvpdma_spi1 1 pdma source/destination a pb device is spi1 edrvpdma_spi2 2 pdma source/destination apb device is spi2 edrvpdma_spi3 3 pdma source/destination apb device is spi3 edrvpdma_uart0 4 pdma source/destination apb device is uart0 edrvpdma_uart1 5 pdma source/destination apb device is uart1 edrvpdma_adc 7 pdma source/destination apb device is adc edrvpdma_i2s 8 pdma source/destination apb device is i2s pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 363 - e_drvpdma_apb_rw enumeration identifier value description edrvpdma_read_apb 0 read data from apb device to memory edrvpdma_write_ap b 1 write data from memory to apb device e_drvpdma_mode enumeration identifier value description edrvpdma_mode_mem2mem 0 pdma mode is memory - to - memory edrvpdma_mode_apb2mem 1 pdma mode is apb device - to - memory edrvpdma_mode_mem2apb 2 pdma mode is memory - to - apb device 15.5. fu n ctio ns drv p dm a_i nit p ro t o t y pe v o id dr v p dm a _ i n it ( v o id ) ; descript io n t h e f u n c tio n i s u s ed to en ab le a hb p dm a en g i n e clo ck . p a ra m et er no n e i nclu de dr iv er /dr v p dm a .h ret urn va lue no n e e x a m p le / * e n ab le a hb p dm a e n g in e clo ck */ dr v p dm a _ i n it (); drv p dm a _ clos e p ro t o t y pe v o id dr v p dm a _ c lo s e ( v o id ) ; pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 364 - descript io n t h e f u n c tio n i s u s ed to d is ab le all p dm a ch a n n el clo ck a n d a hb p dm a clo ck p a ra m et er no ne i nclu de dr iv er /dr v p dm a .h ret urn va lue no n e e x a m p le /* disable all pdma channel clock and ahb pdma c lock */ drv pdma _close (); drv p dm a _ ch e nabl e tra nsfe r p ro t o t y pe in t3 2 _ t dr v p dm a _ c he n ab lelt r an s f er ( e _ dr vp dm a _ c h ann e l _ i nde x ec h an n el ) ; descript io n t h e f u n c tio n i s u s ed to e n ab le p dm a s p ec i f ied ch a n n el a n d en ab le s p ec if ied c h an n el d ata r ea d o r w r ite t r an s f er p a ra m et er echa nn el [ in] sp ec if y e dr vp dm a _ c h a n ne l _ 0 ~8 i nclu de dr iv er /dr v p dm a . h ret urn va lue e _ suc c e ss : s u cc es s . e _ dr vp dm a _ e r r _ p or t _ i nval i d : i n v al id p o r t n u m b er e x a m p le / * e n ab le p dm a ch a n n el0 an d en ab le ch an n el0 d ata r ea d / w r ite tr an s f er * / dr v p dm a _ c he n ab let r an s f e r ( edrvp dm a _ c h a nne l _ 0 ) ; pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 365 - drv p dm a _ ch s of twar e res e t p ro t o t y pe in t3 2 _ t dr v p dm a _ c hso f t w ar ere s et ( e _ dr vp dm a _ c h ann e l _ i nde x ec h an n el ) ; descript io n t h e f u n c tio n i s u s ed to do s o f t w ar e r eset s p ec i f ied ch a n n el. p a ra m et er echa nn el [ in] sp ec if y e dr vp dm a _ c h a n ne l _ 0 ~8 i nclu de dr iv er /dr v p dm a . h ret urn va lue e _ suc c e ss : s u cc es s . e _ dr vp dm a _ e r r _ p or t _ i nval i d : i n v al id p o r t n u m b er no t e t h e f u n c tio n w il l r eset th e s p ec if ied ch a n n el in ter n al s ta te m ac h in e a n d p o in ter s . t h e co n te n ts o f co n tr o l r eg is ter w il l n o t b e clea r ed . e x a m p le / * so f t w ar e r eset p dm a c h an n el0 an d g et r et u r n ed v al u e */ in t3 2 _ t i3 2 r etva l_ c h0 so f t war eres et; i3 2 r etva l_ c h0 so f t w ar ere s e t = dr v p dm a _ c h0 so f t w ar eres et( edrvp dm a _ c h a n ne l _ 0 ) ; drv p dm a _ ope n p ro t o t y pe in t3 2 _ t dr v p dm a _ op e n ( e _ dr vp dm a _ c h a nne l _ i nde x s c h a n n el, st r _ p dm a _ t * s p ar a m ) ; pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 366 - descript io n t h e f u n c tio n co n f i g u r e s p dm a s e tti n g p a ra m et er echa nn el [ in] sp ec if y e dr vp dm a _ c h a n ne l _ 0 ~8 s p a ra m [ in] t h e s tr u ct p ar a m eter to co n f i g u r e p dm a , i t in clu d es s sr c c tr l.u3 2 a d d r : so u r ce a d d r ess . ( m us t be w o rd a lig n m e nt) s sr c c tr l. ead d r dir ec tio n : so u r ce a d d r ess dir ec tio n edrvp dm a _ di r e c t i on_ i nc r e me nt e d : so u r ce ad d r ess d ir ec tio n is i n cr e m en ted edrvp dm a _ di r e c t i on_ fix e d : so u r ce ad d r ess d ir ec tio n is f ix ed s dest c tr l.u3 2 a d d r : desti n ati o n a d d r ess . ( m u s t be w o rd a lig n m e nt) s dest c tr l. e a d d r dir ec tio n : de s tin a tio n a d d r ess dir ec tio n . i t c o u ld b e edrvp dm a _ di r e c t i on_ i nc r e me nt e d / edrvp d ma _ di r e c t i on_ fix e d . edrvp dm a _ di r e c t i on_ i nc r e me nt e d : desti n atio n ad d r ess d ir ec tio n is in cr e m en t ed edrvp dm a _ di r e c t i on_ fix e d : desti n atio n ad d r ess d ir ec tio n is f ix ed u8 t r a ns wid th : p er ip h er al t r a n s f er w id th . t h is f ield i s m ea n in g f u l o n l y w h e n t h e o p er atio n m o d e s e tti n g ar e a p b to m e m o r y o r m e m o r y to a p b . i t c o u ld b e edrvp dm a _ w i dt h_ 8 b i t s / edrvp dm a _ w i dt h_ 16 b i t s / edrvp dm a _ w i dt h_ 32 b i t s . edrvp dm a _ w i dt h_ 8 b i t s : on e b y te ( 8 b its ) is tr an s f er r ed f o r ev er y p dm a o p er atio n . edrvp dm a _ w i dt h_ 16 b i t s : on e h alf - w o r d ( 1 6 b its ) is tr an s f er r ed f o r ev er y p dm a o p er atio n . edrvp dm a _ w i dt h_ 32 b i t s : on e w o r d ( 3 2 b its ) is tr an s f er r ed f o r ev er y p dm a o p er atio n . u8 mo d e : op er atio n mo d e edrvp dm a _ mo de _ me m2 me m : me m o r y to m e m o r y m o d e. edrvp dm a _ mo de _ a p b 2 me m : a p b to m e m o r y m o d e. edrvp dm a _ mo de _ me m2 a p b : m e m o r y to a p b m o d e. i3 2 b ytecn t : p dm a t r an s f er b y te c o u n t i nclu de dr iv er /dr v p dm a . h ret urn va lue e _ suc c e ss : s u cc es s e _ dr vp dm a _ e r r _ p or t _ i nval i d : i n v al id p o r t nu m b er e x a m p le /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - * / pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 367 - / * set p dm a ch a n n el1 to uart 1 t x - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */ / * set p dm a tr an s f er d o n e ca llb ac k f u n ctio n a n d tr ig g er p dm a f u n ct io n . */ /* - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - * / / * p dm a setti n g * / uart p o r t = ua r t 1 _ b a se; dr v p dm a _ se tc h fo r a p b dev ice( edr vp dm a _ c h a nne l _ 1 , edrvp dm a _ u a r t 1 , edr vp dm a _ w r i t e _ a p b ) ; / * c h1 t x settin g * / s p dm a . s src c tr l .u 3 2 a d d r = ( u in t3 2 _ t) src a r r a y ; s p dm a . s dest c tr l . u 3 2 a d d r = uart p o r t; s p dm a . u 8 t r an s w id th = edr vp dm a _ w i dt h_ 8 b i t s; s p dm a . u 8 mo d e = edrvp dm a _ mo de _ me m2 a p b ; s p dm a . s src c tr l . e a d d r dir ec t io n = edrvp dm a _ di r e c t i on_ i nc r e me nt e d; s p dm a . s dest c tr l . e a d d r dir ec tio n = edrvp dm a _ di r e c t i on_ fix e d; s p dm a . i3 2 b y te c n t = u ar t _ t e st_ l e ngt h; dr v p dm a _ op e n ( edrvp dm a _ c h a nne l _ 1 , & s p dm a ) ; / * e n ab le i nt * / dr v p dm a _ e n ab lei n t( ed r vp dm a _ c h a nne l _ 1 , edrvp dm a _ b l kd ) ; / * i n s tall ca llb ac k f u n ctio n * / dr v p dm a _ i n s tall c allb ac k ( edrvp dm a _ c h anne l _ 1 , edrvp dm a _ b l kd, ( p fn_ d r v p dm a _ c al l b a c k) ); / * e n ab le u ar t p dm a an d t r ig g er p dm a s p ec if ied c h a n n el * / dr v p dm a _ c he n ab let r an s f e r ( edrvp dm a _ c h a nne l _ 1 ); drv p dm a _ cle a rintfl a g p ro t o t y pe v o id dr v p dm a _ c lear i n t flag ( e _ dr vp dm a _ c h ann e l _ i nde x ec h an n el, e _ dr vp dm a _ i nt _ fl a g e i n tfl a g ) ; descript io n t h e f u n c tio n i s u s ed to clea r i n ter r u p t stat u s f o r s p ec if ied c h an n el. p a ra m et er echa nn el [ in] sp ec if y e dr vp dm a _ c h a n ne l _ 0 ~8 ein t f la g [ in] i n ter r u p t so u r ce : edrvp dm a _ t a b or t : r ea d /w r ite t ar g et a b o r t edrvp dm a _ b l kd : b lo ck t r an s f er do n e i nclu de dr iv er /dr v p dm a . h pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 368 - ret urn va lue no n e e x a m p le / * c lear c h an n el0 b lo ck tr an s f er d o n e in ter r u p t f la g . */ dr v p dm a _ c lear i n t flag ( ed r vp dm a _ c h anne l _ 0 , edr vp dm a _ b l k d_ flag ) ; / * c lear c h an n el1 r ea d / w r ite t ar g et ab o r t in ter r u p t f la g * / dr v p dm a _ c lear i n t flag ( ed r vp dm a _ c h anne l _ 1 , edr vp dm a _ t a b or t ) ; drv p dm a _ p olli nt p ro t o t y pe in t3 2 _ t dr v p dm a _ p o llin t( e _ dr vp dm a _ c h ann e l _ i nde x ec h an n el, e _ dr vp dm a _ i nt _ fl a g ei n tfl a g ) ; descript io n t h e f u n c tio n i s u s ed to p o llin g ch an n el i n ter r u p t stat u s p a ra m et er echa nn el [ in] sp e cif y e dr vp dm a _ c h a n ne l _ 0 ~8 ein t f la g [ in] i n tter r u p t so u r ce : edrvp dm a _ t a b or t : r ea d /w r ite t ar g et a b o rt edrvp dm a _ b l kd : b lo ck t r an s f er do n e i nclu de dr iv er /dr v p dm a . h ret urn va lue t r u e: i n ter r u p t statu s is s et. fals e: i n ter r u p t stat u s i s clea r . e x a m p le / * get ch a n n e l 5 tr an s f er d o n e in ter r u p t stat u s * / in t3 2 _ t i3 2 c h an n el5 t r an s f er do n e; / * e n ab le i nt * / pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 369 - dr v p dm a _ e n ab lei n t( ed r vp dm a _ c h a nne l _ 5 , edrvp dm a _ b l kd ) ; / * c h ec k ch a n n e l5 tr an s f er d o n e in ter r u p t f la g * / if ( dr v p dm a _ p o llin t ( edrvp dm a _ c h a nne l _ 5 , edrvp dm a _ b l kd_ f l a g ) == t r u e ) p r in tf ( c h a n n e l5 b lo ck tr an s f e r d o n e in ter r u p t f la g is s e t! ! \ n ) else p r in tf ( c h a n n e l5 b lo ck tr an s f e r d o n e in ter r u p t f la g is n o t set ! ! \ n ) drv p dm a _ s e ta p btrans ferwidt h p ro t o t y pe in t3 2 _ t dr v p dm a _ se t a p b t r an s f er w id th ( e _ dr vp dm a _ c h ann e l _ i nde x e c h an n el, e _ dr vp dm a _ t r ans fer_ w i dt h e t r an s f er w id th ) ; descript io n t h e f u n c tio n i s u s ed to s et a p b tr an s f er w id t h f o r s p ec if ied ch an n el. p a ra m et er echa nn el [ in] sp ec if y e dr vp dm a _ c h a n ne l _ 0 ~8 etra ns f er wi dth [ in] edrvp dm a _ w i dt h_ 3 2 b i t s : on e w o r d ( 32 b its ) is tr an s f er r ed f o r ev er y p dm a o p er atio n . edrvp dm a _ w i dt h_ 8 b i t s : on e b y te ( 8 b its ) is tr an s f er r ed f o r ev er y p dm a o p er atio n . edrvp dm a _ w i dt h_ 1 6 b i t s : on e h alf - w o r d ( 16 b its ) is tr an s f er r ed f o r ev er y p dm a o p er atio n . i nclu de dr iv er /dr v p dm a . h ret urn va lue e _ suc c e s s : s u cc es s e _ dr vp dm a _ e r r _ p or t _ i nval i d : i n v alid p o r t n u m b er no t e t h is f u n ctio n is m ea n in g f u l o n l y w h e n p dm a m o d e s elec t is a p b - to - me m o r y o r me m o r y - to - a p b m o d e. e x a m p le pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 370 - / * set c h an ee l 7 p er ip h er al b u s w id th to 8 b its . * / dr v p dm a _ se t a p b t r an s f er w id th ( edrvp dm a _ c h an ne l _ 7 , edrvp dm a _ w i dt h_ 8 b i t s ) drv p dm a _ s e tc hfo rapbdev ic e p ro t o t y pe in t3 2 _ t dr v p dm a _ se tc h fo r a p b dev ice( e _ dr vp dm a _ c h ann e l _ i nde x ec h an n el, e _ dr vp dm a _ a p b _ de vi c e ede v ice, e _ dr vp dm a _ a p b _ r w erw a p b ) ; descript io n t h e f u n c tio n i s u s ed to s el ec t p dm a ch a n n el f o r a p b d ev ice p a ra m et er echa nn el [ in] sp ec if y e dr vp dm a _ c h a n ne l _ 0 ~8 ede v ice [ in] c h a n n el f o r a p b d ev ice . i t in clu d es o f edrvp dm a _ sp i 0 ~3 , edrvp dm a _ u a r t 0 ~1 , edrvp dm a _ a d c , edrvp dm a _ i 2 s erwa p b [ in] : p dm a tr an s f er d ata d ir ec tio n edrvp dm a _ w r i t e _ a p b : p dm a tr an s f er d ata f r o m m e m o r y to s p ec if ied a p b . edrvp dm a _ r e a d_ a p b : pdm a tr a n s f er d ata f r o m s p ec if ied a p b to m e m o r y . i nclu de dr iv er /dr v p dm a . h ret urn va lue e _ suc c e ss : s u cc es s e _ dr vp dm a _ e r r _ p or t _ i nval i d : i n v al id p o r t e _ dr vp dm a _ f al se_ i np ut : i n v alid a p b d ev ice e x a m p le / * set p dm a ch a n n el1 to uart 1 t x p o r t* / dr v p dm a _ se tc h fo r a p b dev ice( edr vp dm a _ c h a nne l _ 1 , edrvp dm a _ u a r t 1 , edr vp dm a _ w r i t e _ a p b ) ; / * set p dm a ch a n n el0 to sp i 0 r x p o r t* / pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 371 - dr v p dm a _ se tc h fo r a p b dev ice( edr vp dm a _ c h a nne l _ 0 , edrvp dm a _ sp i 0 , edrvp dm a _ r e a d _ a p b ) ; drv p dm a _ s e t s ourc e add re s s p ro t o t y pe in t3 2 _ t dr v p dm a _ se t so u r ce a d d r ess ( e _ dr vp dm a _ c h ann e l _ i nde x ec h an n el, u in t3 2 _ t u 3 2 so u r ce a d d r ) ; descript io n t h e f u n c tio n i s u s ed to s et s o u r ce ad d r ess f o r s p ec if ied ch an n el. p a ra m et er echa nn el [ in] sp ec if y e dr vp dm a _ c h a n ne l _ 0 ~8 u3 2 so urce addres s [ in] so u r ce ad d r ess i nclu de dr iv er /dr v p dm a . h ret urn va lue e _ suc c e ss : s u cc es s e _ dr vp dm a _ e r r _ p or t _ i nval i d : i n v al id p o r t n u m b er e x a m p le / * set c h an n el 0 s o u r ce ad d r ess to s p ec if ied ad d r ess . * / dr v p dm a _ set so u r ce a d d r es s ( edrvp dm a _ c h anne l _ 0 , 0 x 2 0 0 0 1 0 0 0 ) ; drv p dm a _ s et des t add re s s p ro t o t y pe in t3 2 _ t dr v p dm a _ se t dest a d d r ess ( e _ dr vp dm a _ c h ann e l _ i nde x ec h an n el, u in t3 2 _ t u 3 2 dest a d d r ) ; descript io n pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 372 - t h e f u n c tio n i s u s ed to s et d es tin atio n ad d r ess f o r s p ec if ied c h an n el. p a ra m et er ech a nn el [ in] sp ec if y e dr vp dm a _ c h a n ne l _ 0 ~8 u3 2 dest addres s [ in] desti n atio n ad d r ess i nclu de dr iv er /dr v p dm a . h ret urn va lue e _ suc c e ss : s u cc es s e _ dr vp dm a _ e r r _ p or t _ i nval i d : i n v al id p o r t n u m b er e x a m p le / * set c h an n el 0 d esti n atio n ad d r ess to s p ec if ied ad d r ess . * / dr vpdma_ set dest address ( edrvpdma_channel_ 0, 0x200012 00); drv p dm a _ dis a ble int p ro t o t y pe in t3 2 _ t dr v p dm a _ di s ab lei n t( e _ dr vp dm a _ c h ann e l _ i nde x ec h an n el, e _ dr vp dm a _ i nt _ e n a b l e ei n tso u r ce ) ; descript io n t h e f u n c tio n i s u s ed to d is ab le i n ter r u p t f o r s p ec i f ied ch a n n e l. p a ra m et er echa nn el [ in] sp ec if y e dr vp dm a _ c h a n ne l _ 0 ~8 ein t so urce [ in]: i n ter r u p t so u r ce edrvp dm a _ t a b or t : r ea d /w r ite t ar g et a b o rt edrvp dm a _ b l kd : b lo ck t r an s f er do n e i nclu de dr iv er /dr v p dm a . h ret urn va lue pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 373 - e _ suc c e ss : s u cc es s e _ dr vp dm a _ e r r _ p or t _ i nv al i d : i n v alid p o r t n u m b er e x a m p le / * di s ab le ch a n n el3 r ea d / w r ite tar g et ab o r t in ter r u p t * / dr v p dm a _ di s ab lei n t( ed r v p dm a _ c h anne l _ 3 , edrv p dm a _ t a b or t ); drv p dm a _ e nabl e int p ro t o t y pe in t3 2 _ t dr v p dm a _ e n ab lei n t( e _ dr vp dm a _ c h ann e l _ i nde x ec h an n el, e _ dr vp dm a _ i nt _ e n a b l e ei n tso u r ce ); descript io n t h e f u n c tio n i s u s ed to en ab le i n ter r u p t f o r s p ec if ied ch an n el . p a ra m et er echa nn el [ in] sp ec if y e dr vp dm a _ c h a n ne l _ 0 ~8 ein t so urce [ in]: i n t er r u p t so u r ce edrvp dm a _ t a b or t : r ea d /w r ite t ar g et a b o rt edrvp dm a _ b l kd : b lo ck t r an s f er do n e i nclu de dr iv er /dr v p dm a . h ret urn va lue e _ suc c e ss : s u cc es s e _ dr vp dm a _ e r r _ p or t _ i nval i d : i n v alid p o r t n u m b er e x a m p le / * e n ab le c h an n el0 b lo ck tr an s f er d o n e in ter r u p t. * / dr v p dm a _ en ab lei n t( ed r vp dm a _ c h a nne l _ 0 , edrvp dm a _ b l kd ); drv p dm a _ ge ta p btrans ferwidt h p ro t o t y pe in t3 2 _ t dr v p dm a _ get a p b t r an s f er w id th ( pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 374 - e_ dr vp dm a _ c h ann e l _ i nde x ec h an n el ); descript io n t h e f u n c tio n i s u s ed to g et p er ip h er al tr an s f er w id th f r o m s p ec if ied ch a n n el. p a ra m et er echa nn el [ in] sp ec if y e dr vp dm a _ c h a n ne l _ 0 ~8 i nclu de dr iv er /dr v p dm a . h ret urn va lue 0 : on e w o r d ( 3 2 b its ) is tr an s f er r ed f o r ev er y p dm a o p er atio n . 1 : on e b y te ( 8 b its ) is tr an s f er r ed f o r ev er y p dm a o p er atio n . 2: on e h al f - w o r d ( 1 6 b its ) is tr an s f er r ed f o r ev er y p dm a o p er atio n . e _ dr vp dm a _ e r r _ p or t _ i nval i d : i n v alid p o r t n u m b er no t e t h is f u n ctio n is m ea n in g f u l o n l y w h e n p dm a m o d e s elec t i o n is a p b - to - me m o r y / me m o r y - to - a p b m o d e. e x a m p le / * get p er ip h er al tr an s f er w id t h f r o m c h a n n el 3 * / in t3 2 _ t i3 2 c h an n el3 a p b t r an s f er w id th ; i3 2 c h an n el3 a p b t r an s f er w id th = dr v p dm a _ get a p b t r an s f er w id th ( ed r vp dm a _ c h a n ne l _ 3 ); drv p dm a _ ge tc hfo rapbdev ic e p ro t o t y pe i n t3 2 _ t dr v p dm a _ get c h fo r a p b dev ice( e _ dr vp dm a _ a p b _ de vi c e ede v ice, e _ dr vp dm a _ a p b _ r w erw a p b ) ; descript io n t h e f u n c tio n i s u s ed to g et p d ma c h an n el f o r s p ec if ied a p b d ev ice p a ra m et er ede v ice [ in] c h a n n el f o r a p b d ev ice . i t in clu d es o f pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 375 - edrvp dm a _ sp i 0 ~3 , edrvp dm a _ u a r t 0 ~1 , edrvp dm a _ a d c , edrvp dm a _ i 2 s erwa p b [ in] : sp ec if y a p b d ir ec tio n edrvp dm a _ r e a d_ a p b : a p b to m e m o r y edrvp dm a _ w r i t e _ a p b : m e m o r y to a p b i nclu de dr iv er /dr v p dm a . h ret urn va lue 0 : c h an n el 0 1 : c h an n el 1 2 : c h an n el 2 3 : c h an n el 3 4 : c h an n el 4 5 : c h an n el 5 6 : c h an n el 6 7 : c h an n el 7 8 : c h an n el 8 e _ dr vp dm a _ f al se_ i np ut : w r o n g p ar a m eter oth er s : r eser v ed no t e i f a p b dev ice d o n ? t b e ass ig n ed to an y c h a n n el, t h e d ef a u lt r etu r n v a lu e w i ll b e 1 5 ( 0 x f). e x a m p le / * get u ar t 0 r x p dm a ch an n el * / in t3 2 _ t i3 2 getch a n n e l4 a p b dev ice; i3 2 getch a n n e l4 a p b dev ice = dr v p dm a _ get c hfo r a p b dev ice( edrvp dm a _ u ar t 0 , edrvp dm a _ r e a d_ a p b ); drv p dm a_g e tc urre n td e s ta ddr p ro t o t y pe u in t3 2 _ t dr v p dm a _ get c u r r en tde s t ad d r ( e _ dr vp dm a _ c h ann e l _ i nde x ec h an n el ) ; descript io n t h e f u n c tio n i s u s ed to g et c u r r en t d esti n a tio n ad d r ess f r o m s p ec if ied ch a n n el. pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 376 - p a ra m et er echa nn el [ in] sp ec if y e dr vp dm a _ c h a n ne l _ 0 ~8 i nclu de dr iv er /dr v p dm a . h ret urn va lue c u r r en t d esti n a tio n ad d r ess no t e c u r r en t d esti n a tio n ad d r ess i n d icate s th e d esti n atio n ad d r ess w h er e th e p dm a tr an s f er is j u s t o cc u r r in g . e x a m p le / * get c h a n n el5 cu r r en t d esti n atio n ad d r ess ; * / u in t3 2 _ t u 3 2 c h a n n el5 c u r de s t a d d r ; u 3 2 c h a n n el5 c u r dest a d d r = dr v p dm a _ get c u r r en tde s t ad d r ( edrvp dm a _ c h a n ne l _ 5 ); drv pd ma _ ge tc urre n tsourc e add r p ro t o t y pe u in t3 2 _ t dr v p dm a _ get c u r r en tso u r ce a d d r ( e _ dr vp dm a _ c h ann e l _ i nde x ec h an n el ) descript io n t h e f u n c tio n i s u s ed to g et c u r r e n t so u r ce ad d r ess f r o m s p ec i f ied ch a n n e l . p a ra m et er echa nn el [ in] sp ec if y e dr vp dm a _ c h a n ne l _ 0 ~8 i nc lu de dr iv er /dr v p dm a . h ret urn va lue c u r r e n t so u r ce ad d r ess r eg i s te r in d icate s th e s o u r ce ad d r ess w h er e th e p dm a tr an s f er i s j u s t o cc u r r in g . e x a m p le / * get c h an n el7 cu r r en t so u r ce ad d r ess . * / pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 377 - u in t3 2 _ t u 3 2 c h a n n el7 c u r r en t so u r ce a d d r ess ; u 3 2 c h a n n el7 c u r r en tso u r ce ad d r ess = dr v p dm a _ get c u r r en tso u r ce a d d r ( edrvp dm a _ c h ann e l _ 7 ); drv p dm a _ ge tr e ma i ntra nsfe rcou nt p ro t o t y pe u in t3 2 _ t dr v p dm a _ get r e m ai n t r an s f er c o u n t( e _ dr vp dm a _ c h ann e l _ i nde x ec h an n el ) ; descript io n t h e f u n c tio n i s u s ed to g et c u r r en t r e m ai n ed b y te co u n t of s p e cif ied ch a n n el. p a ra m et er echa nn el [ in] sp ec if y e dr vp dm a _ c h a n ne l _ 0 ~8 i nclu de dr iv er /dr v p dm a . h ret urn va lue c u r r en t r e m ai n ed b y te co u n t . no t e i f u s er s e t tr an s f er b y te to 6 4 b y tes, t h e cu r r en t b y te co u n t w i ll b e 6 4 b y tes i n th e b eg in n i n g o f tr an s f er . af ter p dm a tr an s f er re d 4 b y te s to m e m o r y , u s er ca n is s u e t h is a p i an d w ill g et cu r r en t r e m a in ed b y te co u n t v alu e w h ich i s 6 0 b y te s . e x a m p le get c h a n n el0 c u r r en t r e m a in ed b y te co u n t u in t3 2 _ t u 3 2 c u r r en t r e m ain ed b y te c o u n t; u 3 2 c u r r en tr e m ai n ed b y tec o u n t = dr v p dm a _ get r e m ai n t r an s f er c o u n t( ed r vp dm a _ c h a nne l _ 0 ); drv p dm a _ ge tint e rna lbuf p ointer p ro t o t y pe u in t3 2 _ t dr v p dm a _ geti n ter n a lb u f p o in ter ( e _ dr vp dm a _ c h a nne l _ i nde x ec h an n el ) ; pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 378 - descript io n t h e f u n c tio n i s u s ed to g et i n t er n al b u f f er p o in ter f o r s p ec i f i ed ch an n e l p a ra m et er echa n nel [ in] sp ec if y e dr vp dm a _ c h a n ne l _ 0 ~8 i nclu de dr iv er /dr v p dm a . h ret urn va lue e _ dr vp dm a _ e r r _ p or t _ i nval i d : i n v a lid p o r t 0 x 0 1 : in ter n al p o in ter p o in t to b y te1 ( o n e b y te r e m ai n ed in p dm a b u f f er ) 0 x 0 3 : in ter n al p o in ter p o in t to b y te2 ( t w o b y te r e m a in ed i n p dm a b u f f er ) 0 x 0 7 : in ter n al p o in ter p o in t to b y te3 ( t h r ee b y te r e m ai n ed in p dm a b u f f er ) 0 x 0 f: in ter n al p o in ter p o in t to b y te4 ( t h er e is n o m o r e d ata r e m ai n ed in p dm a b u f f er ) e x a m p le /* get c h an n el0 in ter n al b u f f er d ata p o in t to k n o w h o w m a n y b y te s r e m ai n ed in p dm a s h a r ed b u f f er an d p r in t t h e in ter n al b u f f er v a lu e s . */ u in t3 2 _ t u 3 2 p d m ai n ter n a lb u f f er p o in t ; u in t3 2 _ t u 3 2 p d m as h ar ed b u f f er data ; u in t8 _ t a u 8 e f f ec ti v es h ar ed b u f f er data [ 4 ] ; u 3 2 p d m ai n ter n alb u f f er p o in t = dr v p dm a _ geti n ter n alb u f p o in ter ( edrvp dm a _ c h a n ne l _ 0 ) if ( u 3 2 p d m ai n ter n a lb u f f er p o in t== 0 x 0 1 ) { p r in tf ( ?? b ec a u s e t h e p d m a i n t er n al b u f er p o in t i s 0 x 0 1 w h ic h in d icate s th a t th er e is o n l y o n e b y te d ata r e m ain ed i n p dm a b u f f er ! ?? ) u 3 2 p d m as h ar ed b u f f er data = dr v p dm a _ get sh ar ed b u f dat a ( edrvp dm a _ c h a n ne l _ 0 ) ; au 8 e f f ec ti v es h ar ed b u f f er dat a [ 0 ] = ( u in t8 _ t) ( u 3 2 p d m as h a r ed b u f f er data & 0 x 0 0 0 0 0 0 ff ) ; p r in tf ( ?? p dm a s h ar ed b u f f er d ata is %x \ n ?? , a u 8 e f f ec ti v es h ar ed b u f f er data [ 0 ] ) ; } else if ( u 3 2 p d m ai n ter n alb u f f er p o in t== 0 x 0 3 ) { p r in tf ( ?? b ec a u s e t h e p d m a i n t er n al b u f er p o in t i s 0 x 0 3 w h ic h in d i ca te s th a t th er e is t w o b y tes d ata r em ai n ed in p dm a b u f f e r ! ?? ) u 3 2 p d m as h ar ed b u f f er data = dr v p dm a _ get sh ar ed b u f dat a ( edrvp dm a _ c h a n ne l _ 0 ) ; au 8 e f f ec ti v es h ar ed b u f f er dat a [ 0 ] = ( u in t8 _ t) ( u 3 2 p d m as h a r ed b u f f er data & 0 x 0 0 0 0 0 0 ff ) ; au 8 e f f ec ti v es h ar ed b u f f er dat a [ 1 ] = ( u in t8 _ t) ( u 3 2 p d m as h a r ed b u f f er data & 0 x 0 0 0 0 ff 0 0 ) ; pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 379 - p r in tf ( ?? p dm a s h ar ed b u f f er d ata ar e %x an d %x \ n ?? , au 8 e f f ec tiv e sh ar ed b u f f er data [ 0 ] , au 8 e f f ec ti v es h ar ed b u f f er dat a [ 1 ] ) ; } else if ( u 3 2 p d m ai n ter n alb u f f er p o in t== 0 x 0 7 ) { p r in tf ( " b ec au s e th e p d m a i n te r n al b u f er p o in t i s 0 x 0 7 w h ic h in d icate s t h at t h er e is th r ee b y tes d ata r em ai n ed in p dm a b u f f e r ! ?? ) u 3 2 p d m as h ar ed b u f f er data = dr v p dm a _ get sh ar ed b u f dat a ( edrvp dm a _ c h a n ne l _ 0 ) ; au 8 e f f ec ti v es h ar ed b u f f er dat a [ 0 ] = ( u in t8 _ t) ( u 3 2 p d m as h a r ed b u f f er data & 0 x 0 0 0 0 0 0 ff ) ; au 8 e f f ec ti v es h ar ed b u f f er dat a [ 1 ] = ( u in t8 _ t) ( u 3 2 p d m as h a r ed b u f f er data & 0 x 0 0 0 0 ff 0 0 ) ; au 8 e f f ec ti v es h ar ed b u f f er dat a [ 2 ] = ( u in t8 _ t) ( u 3 2 p d m as h a r ed b u f f er data & 0 x 0 0 ff 0 0 0 0 ) ; p r in tf ( " p dm a s h ar ed b u f f er d ata ar e %x , %x a n d %x \ n ?? , au 8 e f f ec ti v es h ar ed b u f f er data [ 0 ] , au 8 e f f ec ti v es h ar ed b u f f er dat a [ 1 ] , au 8 e f f ec t iv e sh ar ed b u f f er data [ 2 ] ) ; } else if ( u 3 2 p d m ai n ter n alb u f f er p o in t== 0 x 0 f) { p r in tf ( ?? b ec a u s e t h e p d m a i n t er n al b u f er p o in t i s 0 x 0 f w h ic h in d icate s th a t th er e is n o d ata in p dm a b u f f er ! ?? ) } drv p dm a _ ge tsha re d buf data p ro t o t y pe u in t3 2 _ t dr v p dm a _ get sh ar ed b u f dat a( e _ dr vp dm a _ c h ann e l _ i nde x ec h an n el, ) descript io n t h e f u n c tio n i s u s ed to g et s h a r ed b u f f er co n te n t f r o m s p ec i f i ed ch an n e l. p a ra m et er echa nn el [ in] sp ec if y e dr vp dm a _ c h a n ne l _ 0 ~8 i nclu de dr iv er /dr v p dm a . h ret urn va lue pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 380 - sh ar ed b u f f er d ata e x a m p le p lease r ef er to dr v p dm a _ ge ti n ter n alb u f p o in ter ( ) ex a m p le . drv p dm a _ ge tt ra nsf e rle ngt h p ro t o t y pe in t3 2 _ t dr v p dm a _ gett r an s f er l en g t h ( e _ dr vp dm a _ c h ann e l _ i nde x ec h an n el, u in t3 2 _ t* p u 3 2 t r an s f er l en g t h ) ; descript io n t h e f u n c tio n i s u s ed to g et c h a n n el tr a n s f er len g t h s et tin g . t h e u n it o f * p u 3 2 t r an s f er l en g th is b y te. p a ra m et er echa nn el [ in] sp ec if y e dr vp dm a _ c h a n ne l _ 0 ~8 pu 3 2 t ra ns f er l e ng t h [ in] t h e d ata p o in ter to s av e tr an s f er len g t h i nclu de dr iv er /dr v p dm a . h ret urn va lue e _ suc c e ss : s u cc es s e x a m p le / * get t h e tr an s f er b y te co u n t s etti n g o f c h a n n el0 . * / u in t3 2 _ t u 3 2 gett r an s f er b y te c o u n t sett in g ; dr v p dm a _ gett r an s f er l en g t h ( edrvp dm a _ c h a nne l _ 0 , & u 3 2 gett r an s f er b y tec o u n ts ettin g ) ; drv p dm a _ ge ts ourc e add re s s p ro t o t y pe u in t3 2 _ t pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 381 - dr v p dm a _ get so u r ce a d d r es s ( e _ dr vp dm a _ c h ann e l _ i nde x ec h an n el, ) descript io n t h e f u n c tio n i s u s ed to g et s o u r ce ad d r ess f o r s p ec if ied ch an n el. p a ra m et er echa nn el [ in] sp ec if y e dr vp dm a _ c h a n ne l _ 0 ~8 i nclu de dr iv er /dr v p dm a . h ret urn va lue so u r ce ad d r ess e x a m p le / * get t h e s o u r ce ad d r ess o f c h an n el0 */ u in t3 2 _ t u 3 2 getso u r ce a d d r ess ; u 3 2 getso u r ce a d d r ess = dr v p dm a _ get so u r ce a d d r ess ( ed r vp dm a _ c h a n ne l _ 0 ); drv p dm a _ ge td e s ta ddre s s p ro t o t y pe u in t3 2 _ t dr v p dm a _ get dest a d d r ess ( e _ dr vp dm a _ c h ann e l _ i nde x ec h an n el, ) descript io n t h e f u n c tio n i s u s e d to g et d es tin atio n ad d r ess f o r s p ec if ied c h an n el. p a ra m et er echa nn el [ in] sp ec if y e dr vp dm a _ c h a n ne l _ 0 ~8 i nclu de dr iv er /dr v p dm a . h ret urn va lue pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 382 - desti n atio n ad d r ess e x a m p le / * get t h e d esti n atio n ad d r ess o f ch a n n el0 */ u in t3 2 _ t u 3 2 getde s t a d d r ess ; u 3 2 getde s t a d d r ess = dr v p dm a _ get de s t a d d r ess ( ed r vp dm a _ c h a nne l _ 0 ); drv p dm a _ ins tall ca ll bac k p ro t o t y pe in t3 2 _ t dr v p dm a _ i n s tall c allb ac k ( e _ dr vp dm a _ c h ann e l _ i nde x ec h an n el, e _ dr vp dm a _ i nt _ e n a b l e ei n tso u r ce , p fn_ dr vp dm a _ c al l b a c k p f n ca llb ac k ) ; descript io n t h e f u n c tio n i s u s ed to in s tall ca ll b ac k f u n c tio n f o r s p ec if ie d ch an n e l an d i n ter r u p t so u r ce . p a ra m et er echa nn el [ in] sp ec if y e dr vp dm a _ c h a n ne l _ 0 ~8 ein t so urce [ in] : in ter r u p t so u r ce edrvp dm a _ t a b or t : r ea d / w r ite tar g et ab o r t edrvp dm a _ b l kd : b lo ck tr an s f er d o n e p f nca llb a c k [ in] t h e ca llb ac k f u n ctio n p o in ter i nclu de dr iv er /dr v p dm a . h ret urn va lue e _ suc c e ss : s u cc es s e x a m p le p lease r ef er to dr v p dm a _ op en ( ) s a m p le co d e. pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 383 - drv p dm a _ is ch busy p ro t o t y pe in t3 2 _ t dr v p dm a _ i s c hb u s y ( e _ dr vp dm a _ c h a nne l _ i nde x ec h an n el ) ; descript i on t h e f u n c tio n i s u s ed to get c h an n el e n ab le/di s ab le s tat u s p a ra m et er echa nn el [ in] sp ec if y e dr vp dm a _ c h a n ne l _ 0 ~8 i nclu de dr iv er /dr v p dm a . h ret urn va lue t r ue : t h e ch an n el i s b u s y f a l se: t h e ch an n el i s u n - u s ed . e _ dr vp dm a _ e r r _ p or t _ i nval i d : i n v alid p o r t n u m b er e x a m p le / * get ch a n n el0 b u s s tatu s . * / in t3 2 _ t i3 2 c h an n el0 b u s stat u s ; i3 2 c h an n el0 b u s stat u s = i f ( dr v p dm a _ i s c hb u s y ( ed r vp d ma _ c h a nne l _ 0 ) ; if ( i3 2 c h a n n el0 b u s stat u s == t r ue ) p r in tf ( c h a n n e l0 b u s is b u s y ! ! \ n ) ; else if ( i3 2 c h an n el0 b u s stat u s == false ) p r in tf ( c h a n n e l 0 b u s is n o t b u s y ! ! \ n ) ; else if ( i3 2 c h an n el0 b u s stat u s == e _ dr vp dm a _ e r r _ p or t _ i nva l i d ) p r in tf ( i n v a lid p o r t! ! \ n ) ; drv p dm a _ is intena bl e d p ro t o t y pe in t3 2 _ t pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 384 - dr v p dm a _ i s i n ten ab led ( e _ dr vp dm a _ c h ann e l _ i nde x ec h an n el, e _ dr vp dm a _ i nt _ e n a b l e ei n tso u r ce ) ; d escript io n t h e f u n c tio n i s u s ed to ch ec k i f th e s p ec if ied i n ter r u p t so u r ce is en ab led in s p ec i f ied ch a n n e l. p a ra m et er echa nn el [ in] sp ec if y e dr vp dm a _ c h a n ne l _ 0 ~8 ein t so urce [ in] i n t er r u p t so u r ce : edrvp d ma _ t a b or t /edrvp dm a_ b l kd i nclu de dr iv er /dr v p dm a . h ret urn va lue t r ue : t h e s p ec if ied in ter r u p t s o u r ce o f s p ec if ied ch an n el i s en ab le. f a l se: t h e s p ec if ied i n ter r u p t so u r ce o f s p ec if ied c h an n el is d is ab le. i nclu de dr iv er /dr v p dm a . h e x a m p le in t3 2 _ t i3 2 i s i n ten ab le; i3 2 i s i n ten ab le= dr v p dm a _ i s i n ten ab led ( edrvp dm a _ c h a n ne l _ 0 , edrvp dm a _ b l kd ) if ( i3 2 i s i n ten ab le == t r ue ) p r in tf ( c h a n n e l0 b lo ck tr an s f er do n e in ter r u p t is e n ab le! \ n ); else if ( i3 2 i s i n te n ab le == f al se ) p r in tf ( c h a n n e l0 b lo ck tr an s f er do n e in ter r u p t is d is ab le ! \ n ); drv p dm a _ ge tve r s io n p ro t o t y pe in t3 2 _ t dr v p dm a _ get ver s io n ( v o id ) ; descript io n r etu r n th e c u r r en t v er s io n n u m b er o f d r i v er . pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 385 - i nclu de dr iv er /dr v p dm a . h ret urn va lue pdma driver c urrent v ersion number : 31:24 23:16 15:8 7:0 00000000 major_num minor_num build_num e x a m p le / * get p dm a d r iv er cu r r en t v er s io n n u m b er * / in t3 2 _ t i3 2 p dm a ver s io n n u m ; i3 2 p dm a ver s io n n u m = dr v p dm a _ getve r s io n (); pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 386 - 16. i2 s driv er 16.1. i2s introduction t h is i 2 s c o n tr o ller co n s is ts o f i i s p r o t o co l to in ter f ac e w i th ex ter n al a u d io c ode c . t w o 8 w o r d d ee p fifo f o r r ea d p ath an d w r ite p ath r e s p ec tiv el y an d is ca p ab le o f h a n d lin g 8 - b it, 1 6 - b it, 2 4 - b it a n d 3 2 - b it d ata s ize. dm a co n tr o ller h an d le s th e d ata m o v e m e n t b et w ee n fi fo an d m e m o r y . 16.2. i2s feat ure ? op er ate as e ith er m a s ter m o d e o r s lav e m o d e . ? c ap ab le o f h an d li n g 8 , 1 6 , 2 4 , an d 3 2 b it d ata s ize. ? su p p o r t m o n o an d s ter eo au d i o d ata. ? su p p o r t i 2 s a n d msb j u s tif ie d d ata f o r m at. ? t w o 8 w o r d fifo d ata b u f f er s ar e p r o v id ed . on e f o r tr an s m it a n d o n e f o r r ec eiv e. ? gen er ate in ter r u p t r eq u est w h en t x /r x fifo le v el cr o s s es a p r o g r am m ab le b o u n d ar y . ? t w o dm a r eq u es ts . o n e f o r t r an s m it a n d o n e f o r r ec eiv e . pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 387 - 16.3. con s tan t de fin i tio n constant name value description drvi2s_databit_8 0x 0 0 data size is 8 bit drvi2s_databit_ 16 0x 01 data size is 16 bit drvi2s_databit_ 24 0x 02 data size is 24 bit drvi2s_databit_ 32 0x 03 data size is 32 bit drvi2s_mono 0x01 data is mono format drvi2s_ stereo 0x00 data is stereo format drvi2s_format_msb 0x01 msb justified data format drvi2s_format_ i2s 0x00 i2s data format drvi2s_mode_slave 0x01 i2s operates as slave mode drvi2s_mode_master 0x00 i2s operates as master mode drvi2s_fifo_level_word_0 0x 0 0 fifo threshold level is 0 word drvi2s_fifo_level_word_ 1 0x 01 fifo threshold level is 1 word drvi2s_fifo_level_word_ 2 0x 02 fifo threshold level is 2 word drvi2s_fifo_level_word_ 3 0x 03 fifo thresh old level is 3 word drvi2s_fifo_level_word_ 4 0x 04 fifo threshold level is 4 word drvi2s_fifo_level_word_ 5 0x 05 fifo threshold level is 5 word drvi2s_fifo_level_word_ 6 0x 06 fifo threshold level is 6 word drvi2s_fifo_level_word_ 7 0x 07 fifo threshold leve l is 7 word drvi2s_fifo_level_word_ 8 0x 08 fifo threshold level is 8 word drvi2s_ext_12m 0 i2s clock source is from external 12mhz crystal clock drvi2s_pll 1 i2s clock source is from pll clock drvi2s_hclk 2 i2s clock source is from hclk drvi2s_internal _22m 3 i2s clock source is from internal 22mhz rc clock pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 388 - 16.4. type definition e_i2s_channel enumeration identifier value description i2s_left_channel 0 i2s for left channel i2s_right_channel 1 i2s for right channel e_i2s_callback_type enumeration identifier value description i2s_rx_underflow 0 for rx fifo underflow interrupt i2s_rx_overflow 1 for rx fifo overflow interrupt i2s_rx_fifo_threshold 2 for rx fifo threshold level interrupt i2s_tx_underflow 8 for tx fifo underflow interrupt i2s_tx_overflow 9 fo r tx fifo overflow interrupt i2s_tx_fifo_threshold 10 for tx fifo threshold level interrupt i2s_tx_right_zero_cross 11 for tx right channel zero cross interrupt i2s_tx_left_zero_cross 12 for tx left channel zero cross interrupt 16.5. macr o f un c tio n s _ drv i 2s _write_tx_fifo p ro t o t y pe s tatic _ _ in li n e v o id _ dr v i 2 s _ w r i t e _ t x _ fifo ( u in t3 2 _ t u 3 2 data ) ; descript io n w r ite w o r d d ata to t x fifo . p a ra m et er u3 2 da t a [ in] w o r d d ata to t x fifo . i nclu de dr iv er /dr v i 2 s .h pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 389 - ret urn va lue no n e e x a m p le / * w r ite w o r d d ata 0 x 1 2 3 4 5 6 7 8 in to i 2 s t x fifo * / _ dr vi 2 s_ w r i t e _ t x _ fifo ( 0 x 1 2 3 4 5 6 7 8 ); _ dr v i2 s _ read _ rx_ fifo p ro t o t y pe s tatic _ _ in li n e u in t3 2 _ t _ dr v i 2 s _ r e a d_ r x_ fif o ( v o id ); descript io n r ea d o u t w o r d d ata f r o m r x f i fo . p a ra m et er no n e i nclu de dr iv er /dr v i 2 s .h ret urn va lue w o r d d ata f r o m r x fifo. e x a m p le u in t3 2 _ t u 3 2 d ata ; / * r ea d w o r d d ata f r o m i 2 s r x fifo * / u 3 2 d ata = _ dr v i 2 s _ r e a d_ r x_ fifo (); _ dr v i2 s _ read _ tx_ fifo_ lev e l p ro t o t y pe s tatic _ _ in li n e u in t3 2 _ t _ dr v i 2 s _ r e a d _ t x_ fifo_ l e ve l ( v o id ); pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 390 - descript io n get w o r d d ata n u m b er in t x f i fo . p a ra m et er no n e i nclu de dr iv er /dr v i 2 s .h ret urn va lue 0 ~8 : w o r d d ata in t x fifo e x a m p le u in t3 2 _ t u 3 2 len ; / * get w o r d d ata n u m b er i n t x fifo */ u 3 2 len = _ dr v i 2 s _ r e a d _ t x_ fifo_ l e ve l (); _ dr v i2 s _ read _ r x _ fifo_ lev e l p ro t o t y pe s tatic _ _ in li n e u in t3 2 _ t _d rv i 2 s _ r e a d _ r x_ fif o_ l e ve l ( v o id ); descript io n get w o r d d ata n u m b er in r x f i fo . p a ra m et er no n e i nclu de dr iv er /dr v i 2 s .h ret urn va lue 0 ~8 : w o r d d ata in r x fif o e x a m p le u in t3 2 _ t u 3 2 len ; / * get w o r d d ata n u m b er i n r x fifo */ u 3 2 len = _ dr v i 2 s _ r e a d _ r x_ fifo_ l e v el ( ); pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 391 - 16.6. functions drv i2 s _ ope n p ro t o t y pe in t3 2 _ t d r v i 2 s_ op en ( s_ dr vi 2 s_ da t a _ t * s p ar a m ) ; descript io n t h is f u n ctio n is u s ed to en ab le i 2 s c lo ck an d f u n ctio n , an d co n f i g u r e th e d ata len g t h /d ata f o r m at/ fifo t h r esh o ld le v el/b c l k ( b it c lo ck ) . t h e d ata an d au d io f o r m a ts ar e s h o w n i n i 2 s op er a tio n an d fifo op er atio n o f i 2 s sec tio n i n t r m . fo r m aster m o d e, i 2 s _ b c lk an d i 2 s _ lrcl k p in s ar e o u tp u t m o d e ; f o r s lav e m o d e, i 2 s _ b c lk an d i 2 s _ lrcl k p in s ar e in p u t m o d e . a l s o , th e i 2 s si g n al s ( i 2 s _ b c lk an d i 2 s _ lrcl k ) ar e s h o w n i n i 2 s b lo ck diag r a m o f i 2 s s ec tio n in t r m . p a ra m et er * s p a ra m [ in] i t in clu d es t h e f o llo w in g p ar am eter u3 2 sa m p ler a te : sa m p li n g r at e. t h e s ettin g ta k es e f f ec t w h e n i 2 s o p er ates a s m aster m o d e . u8 wo r d wid th : 8 , 1 6 , 2 4 , o r 3 2 b it d ata s ize - dr vi 2 s_ d at a b i t _ 8 / dr vi 2 s_ d a t a b i t _ 16 / dr vi 2 s_ da t a b i t _ 2 4 / dr vi 2 s_ d a t a b i t _ 32 u8 a ud io f o r m a t : su p p o r t m o n o o r s ter eo au d io d ata - dr vi 2 s_ mo no / dr vi 2 s_ st e r e o u8 da ta f o r m a t : su p p o r t i 2 s a n d msb j u s tifie d d ata f o r m at - dr vi 2 s_ fo r m a t _ i 2 s / dr vi 2 s_ for m a t _ msb u8 mo d e : op er ate as m a s ter o r s lav e m o d e - dr vi 2 s_ mo d e _ ma st e r / dr vi 2 s_ mo de _ s l a ve u8 t x f i f ot hr e s ho ld : t x fifo th r es h o ld lev el - dr vi 2 s_ f i fo_ l e ve l _ w or d_ 0 / dr vi 2 s_ fifo_ l e ve l _ w or d_ 1 / dr vi 2 s_ fifo_ l e ve l _ w or d_ 2 / dr vi 2 s_ fifo_ l e ve l _ w or d_ 3 / dr vi 2 s_ fifo_ l e ve l _ w or d_ 4 / dr vi 2 s_ fifo_ l e ve l _ w or d_ 5 / dr vi 2 s_ fifo_ l e ve l _ w or d_ 6 / dr vi 2 s_ fifo_ l e ve l _ w or d_ 7 u8 r x f i f ot h r es ho ld : rx fi fo th r es h o ld lev el - d r vi 2 s_ fifo_ l e ve l _ w or d_ 1 / dr vi 2 s_ fifo_ l e ve l _ w or d_ 2 / dr vi 2 s_ fifo_ l e ve l _ w or d_ 3 / dr vi 2 s_ fifo_ l e ve l _ w or d_ 4 / dr vi 2 s_ fifo_ l e ve l _ w or d_ 5 / dr vi 2 s_ fifo_ l e ve l _ w or d_ 6 / dr vi 2 s_ fifo_ l e ve l _ w or d_ 7 / dr vi 2 s_ fifo_ l e ve l _ w or d_ 8 pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 392 - i nclu de dr iv er / dr v i 2 s .h ret urn va lue 0 su cc es s e x a m p le s_ dr vi 2 s_ d a t a _ t s t; s t.u 3 2 sa m p le r ate = 1 6 0 0 0 ; /* sa m p li n g r ate is 1 6 k s p s */ s t.u 8 w o r d w id th = dr vi 2 s_ da t a b i t _ 1 6 ; /* data len g t h i s 1 6 - b it */ s t.u 8 au d io fo r m at = dr vi 2 s _ st e r e o; /* ster eo f o r m at */ s t.u 8 data fo r m at = dr vi 2 s_ for m a t _ i 2 s; /* i 2 s d ata f o r m at */ s t.u 8 mo d e = dr vi 2 s_ mo de _ ma st e r ; /* op er ate as m as ter m o d e */ /* t x fifo th r e s h o ld lev e l is 0 w o r d d ata * / s t.u 8 t x fifot h r esh o ld = dr vi 2 s_ fifo_ l e ve l _ w or d _ 0 ; /* r x fifo t h r es h o ld lev el i s 8 w o r d d ata */ s t.u 8 r x fif ot h r esh o ld = dr vi 2 s_ fifo_ l e ve l _ w or d _ 8 ; / * e n ab le i 2 s a n d co n f i g u r e it s s etti n g s */ dr v i 2 s_ op en ( & s t) ; drvi 2 s _ clos e p ro t o t y pe v o id dr v i 2 s _ c lo s e ( v o id ); descript io n c lo s e i 2 s c o n tr o ller an d d is ab le i 2 s c lo ck . i nclu de dr iv er /dr v i 2 s .h ret urn va lue no n e e x a m p le dr v i 2 s _ c lo s e ( ) ; /* di s ab le i 2 s */ drvi 2 s _ e nabl e int p ro t o t y pe in t3 2 _ t d r v i 2 s_ e n ab lei n t ( e _ i 2 s_ c al l b a c k_ t yp e t y p e, i 2 s_ c al l b ac k ca llb ac k f n ) ; pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 393 - descript io n t o en ab le i 2 s in te r r u p t f u n ct i o n an d in s tall r elati v e ca ll b ac k f u n ctio n i n i 2 s in ter r u p t h an d ler . p a ra m et er t y pe [ in] t h er e ar e eig h t t y p e s f o r ca ll b ac k f u n ctio n . i 2 s_ r x_ unde r f l ow : r x fifo u n d er f lo w i 2 s_ r x_ ove r f l ow : r x fi fo o v er f lo w . i 2 s_ r x_ fifo_ t hr e shol d : d ata w o r d in r x fifo is h i g h er t h an r x t h r es h o ld lev el. i 2 s_ t x_ unde r f l ow : t x fifo u n d er f lo w . i 2 s_ t x_ ove r flow : t x fifo o v er f lo w i 2 s_ t x_ fifo_ t hr e sho l d : d ata w o r d in t x fifo i s le s s t h an t x th r es h o ld lev el. i 2 s_ t x_ r i ght _ z e r o_ c r oss : t x r ig h t c h a n n el ze r o cr o s s . i 2 s_ t x_ l e ft _ z e r o_ c r o ss : t x lef t c h an n el ze r o cr o s s . ca llb a ck f n [ i n] c all b ac k f u n ctio n n a m e f o r s p ec if ied in ter r u p t e v en t. i nclu de dr iv er /dr v i 2 s. h ret urn va lue 0 : su cc ee d <0 : failed e x a m p le / * e n ab le r x t h r es h o ld lev el i n ter r u p t a n d i n s tal l its ca llb ac k f u n ctio n * / d r v i 2 s_ e n ab lei n t ( i 2 s_ r x_ f i fo_ t hr e shol d, r x _ t h r es h o ld c allb ac k f n ) ; / * e n ab le t x th r es h o ld lev el i n ter r u p t a n d i n s tal l its ca llb ac k f u n ctio n * / dr v i 2 s_ e n ab lei n t ( i 2 s_ t x_ f i fo_ t hr e shol d, t x _ th r es h o ld c allb ac k f n ) ; drvi 2 s _ dis a bl e int p ro t o t y pe in t3 2 _ t d r v i 2 s_ dis ab l ei n t ( e _ i 2 s_ c al l b ac k_ t yp e t y p e) ; descript io n t o d is ab le i 2 s in ter r u p t f u n cti o n an d u n i n s tall r elati v e ca ll b ac k f u n ctio n i n i 2 s in ter r u p t h an d ler . p a ra m et er pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 394 - t y pe [ in] t h er e ar e eig h t t y p e s f o r ca ll b ac k f u n ctio n . i 2 s_ r x_ unde r f l ow : r x fifo u n d er f lo w i 2 s_ r x _ ove r f l ow : r x fi fo o v er f lo w i 2 s_ r x_ fifo_ t hr e shol d : d ata w o r d in r x fifo is h i g h er t h an r x t h r es h o ld lev el. i 2 s_ t x_ unde r f l ow : t x fifo u n d er f lo w . i 2 s_ t x_ ove r flow : t x fifo o v er f lo w i 2 s_ t x_ fifo_ t hr e sho l d : d ata w o r d in t x fifo i s le s s t h an t x th r es h o ld lev el. i 2 s_ t x_ r i ght _ z e r o_ c r oss : t x r ig h t c h a n n el ze r o cr o s s . i 2 s_ t x_ l e ft _ z e r o_ c r o ss : t x lef t c h an n el ze r o cr o s s . i nclu de dr iv er /dr v i 2 s. h ret urn va lue 0 : su cc ee d <0 : failed e x a m p le / * dis ab le r x t h r es h o ld lev el i n ter r u p t a n d un i n s tall its ca l lb ac k f u n ctio n * / dr v i 2 s_ dis ab lei n t ( i 2 s_ r x_ fifo_ t hr e sho l d) ; /* dis able t x threshold level interrupt and un install its callback function */ drvi2s_disableint (i2s_tx_fifo_threshold); drvi 2 s _ ge tb clk fre q p ro t o t y pe u in t3 2 _ t d r v i 2 s_ getb c l k fre q ( v o id ) ; descript io n t o g et th e i 2 s b c l k ( b it c lo ck ) f r eq u e n c y . b cl k = i2 s s ou r c e c l oc k / (2 x ( b cl k d i v i d er + 1)) p a ra m et er no n e i nclu de dr iv er /dr v i 2 s. h ret urn va lue i 2 s b c l k f r eq u en c y . t h e u n i t is hz. pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 395 - e x a m p le u in t3 2 _ t u 3 2 clo ck ; u 3 2 clo ck = dr v i 2 s_ get b c l k fre q ( ); /* get i 2 s b c l k clo ck f r eq u e n c y * / drvi 2 s _ s e tb clk fre q p ro t o t y pe v o id dr v i 2 s_ setb c l k fre q ( u in t3 2 _ t u 3 2 b clk ) ; descript io n to co n f ig u r e b c l k ( b it c lo c k ) clo ck . t h e b c l k w il l w o r k w h e n i 2 s o p er ates in m a s ter m o d e. b cl k = i2 s s ou r c e c l oc k / (2 x b cl k d i v i d er + 1) ) p a ra m et er u3 2 b clk [ in ] i 2 s b c l k f r eq u en c y . t h e u n i t is hz. i nclu de dr iv er /dr v i 2 s. h ret urn va lue no n e e x a m p le dr v i 2 s_ s et b c l k fre q ( 5 1 2 0 0 0 ); /* set i 2 s b c l k clo c k f r eq u e n c y 5 1 2 khz */ drvi 2 s _ ge tm clk fre q p ro t o t y pe u in t3 2 _ t d r v i 2 s_ get m c l k fr eq ( v o id ) ; descript io n t o g et th e i 2 s mc l k ( ma s ter c lo ck ) f r eq u e n c y . mc l k = i2 s s ou r c e c l oc k / (2 x m cl k d i v i d er )) p a ra m et er no n e i nclu de dr iv er /dr v i 2 s. h ret urn va lue i 2 s m c l k f r eq u e n c y . t h e u n it is hz. pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 396 - e x a m p le u in t3 2 _ t u 3 2 clo ck ; u 3 2 clo ck = dr v i 2 s_ get m c l k fre q ( ); /* get i 2 s m c l k clo ck f r eq u e n c y * / drvi 2 s _ s e tm clk fre q p ro t o t y pe v o id dr v i 2 s_ set m c l k fre q ( u in t3 2 _ t u 3 2 m clk ) ; descript io n t o co n f ig u r e mc l k ( ma s ter c lo ck ) clo ck . mc l k = i2 s s ou r c e c l oc k / (2 x ( m c lk di v i de r )) p a ra m et er u3 2 m clk [ in] i 2 s m c l k f r eq u e n c y . t h e u n it is hz. i nclu de dr iv er /dr v i 2 s. h ret urn va lue no n e e x a m p le dr v i 2 s_ setmc l k fre q ( 1 2 0 0 0 0 0 0 ) ; /* set i 2 s m c l k cl o ck f r eq u e n c y 1 2 mh z * / drvi 2 s _ s e tc hanne lz e rocross dete c t p ro t o t y pe in t3 2 _ t d r v i 2 s_ setc h an n el z e r o c r o s s dete ct ( e _ i 2 s_ c han ne l ch a n n el, in t3 2 _ t i3 2 f lag ) ; descript io n t o en ab l e o r d is ab le r ig h t/lef t ch an n el ze r o cr o s s d etec t f u n c tio n . p a ra m et er cha nn el [ in] i 2 s_ l e ft _ c ha n ne l / i 2 s_ r i ght _ c ha n ne l i3 2 f la g [ in] t o en ab le o r d is ab le ze r o cr o s s d etec t f u n ctio n . ( 1 : e n ab le 0 : d is ab le ) i nclu de dr iv er /dr v i 2 s. h pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 397 - ret urn va lue 0 : su cc ee d <0 : failed e x a m p le / * e n ab le le f t c h a n n el ze r o cr o s s d etec t * / dr v i 2 s_ setc h an n el z er o c r o s s dete ct ( i 2 s_ l e ft _ c ha n ne l , 1 ) ; / * dis ab le r i g h t c h a n n el ze r o c r o s s d etec t * / dr v i 2 s_ setc h an n el z er o c r o s s dete ct ( i 2 s_ r i ght _ c ha nn e l , 0 ); drvi 2 s _ e nabl e txdma p ro t o t y pe v o id dr v i 2 s_ e n ab let x dm a ( v o id ); descript io n t o en ab le i 2 s t x dm a f u n cti o n . i 2 s r eq u ests dm a to tr an s f er d ata to t x fifo . p a ra m et er no n e i nclu de dr iv er /dr v i 2 s. h ret urn va lue no n e e x a m p le / * e n ab le i 2 s t x dm a f u n ct i o n */ dr v i 2 s_ e n ab let x dm a ( ) ; drvi 2 s _ dis a bl e txd ma p ro t o t y pe v o id dr v i 2 s_ dis ab let x dm a ( v o id ); descript io n t o d is ab le i 2 s t x dm a f u n ct io n . p a ra m et er no n e i nclu de pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 398 - dr iv er /dr v i 2 s. h ret urn va lue no n e e x a m p le / * dis ab le i 2 s t x dm a f u n c ti o n */ dr v i 2 s_ dis ab let x dm a ( ) ; drvi 2 s _ e nabl e rxdm a p ro t o t y pe v o id dr v i 2 s_ e n ab le r x dm a ( v o id ); descript io n t o en ab le i 2 s r x dm a f u n cti o n . i 2 s r eq u ests dm a to tr an s f er d ata f r o m r x fif o . p a ra m et er no n e i nclu de dr iv er /dr v i 2 s. h ret urn va lue no n e e x a m p le / * e n ab le i 2 s r x dm a f u n cti o n */ dr v i 2 s_ e n ab le r x dm a ( ) ; drvi 2 s _ dis a bl e rxdm a p ro t o t y pe v o id dr v i 2 s_ dis ab le r x d ma ( v o id ); descript io n t o d is ab le i 2 s r x dm a f u n c t io n . p a ra m et er no n e i nclu de dr iv er /dr v i 2 s. h ret urn va lue pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 399 - no n e e x a m p le / * dis ab le i 2 s r x dm a f u n ct io n */ dr v i 2 s_ dis ab le r x dm a ( ) ; drvi 2 s _ e nabl e tx p ro t o t y pe v o id dr v i 2 s_ e n ab let x ( v o id ); descript io n t o en ab le i 2 s t x f u n ctio n . p a ra m et er no n e i nclu de dr iv er /dr v i 2 s. h ret urn va lue no n e e x a m p le / * e n ab le i 2 s t x f u n ctio n */ dr v i 2 s_ e n ab let x ( ) ; drvi 2 s _ dis a bl e tx p ro t o t y pe v o id dr v i 2 s_ dis ab let x ( v o id ); descript io n t o d is ab le i 2 s t x f u n c tio n . p a ra m et er no n e i nclu de dr iv er /dr v i 2 s. h ret urn va lue no n e e x a m p le pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 400 - / * dis ab le i 2 s t x f u n ctio n */ dr v i 2 s_ dis ab let x ( ) ; drvi 2 s _ e nabl e rx p ro t o t y pe v o id dr v i 2 s_ e n ab le r x ( v o id ); descript io n t o en ab le i 2 s r x f u n ctio n . p a ra m et er no n e i nclu de dr i v er /dr v i 2 s. h ret urn va lue no n e e x a m p le / * e n ab le i 2 s r x f u n ctio n */ dr v i 2 s_ e n ab le r x ( ) ; drvi 2 s _ dis a bl e rx p ro t o t y pe v o id dr v i 2 s_ dis ab le r x ( v o id ); descript io n t o dis ab le i 2 s r x f u n ctio n . p a ra m et er no n e i nclu de dr iv er /dr v i 2 s. h ret urn va lue no n e e x a m p le /* dis ab le i 2 s r x f u n ctio n */ dr v i 2 s_ dis ab le r x ( ) ; pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 401 - drvi 2 s _ e nabl e txmut e p ro t o t y pe v o id dr v i 2 s_ e n ab let x mu te ( v o id ); descript io n t o en ab le i 2 s t x mu te f u n cti o n . p a ra m et er no n e i nclu de dr iv er /dr v i 2 s. h ret urn va lue no n e e x a m p le / * e n ab le i 2 s t x mu te f u n ctio n */ dr v i 2 s_ e n ab let x mu te ( ) ; drvi 2 s _ dis a bl e txmut e p ro t o t y pe v o id dr v i 2 s_ dis ab let x mu te ( v o id ); descript io n t o d is ab le i 2 s t x mu te f u n cti o n . p a ra m et er no n e i nclu de dr iv er /dr v i 2 s. h ret urn va lue no n e e x a m p le / * dis ab le i 2 s t x mu te f u n cti o n */ dr v i 2 s_ dis ab let x mu te ( ) ; drvi 2 s _ e nabl e m clk p ro t o t y pe pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 402 - v o id dr v i 2 s_ e n ab le mclk ( v o id ); descript io n t o en ab le i 2 s m c l k o u tp u t f r o m gp i o a p in 1 5 . p a ra m et er no n e i nclu de dr iv er /dr v i 2 s. h ret urn va lue no n e e x a m p le / * e n ab le m c l k o u tp u t */ dr v i 2 s_ e n ab le mc l k ( ) ; drvi 2 s _ dis a bl e m clk p ro t o t y pe v o id dr v i 2 s_ dis ab le mclk ( v o id ); descript io n t o d is ab le i 2 s m c l k o u tp u t f r o m gp i oa p i n 1 5 . p a ra m et er no n e i nclu de dr iv er /dr v i 2 s. h ret urn va lue no n e e x a m p le / * dis ab le m c l k o u tp u t */ dr v i 2 s_ dis ab le mc l k ( ) ; drvi 2 s _ cle a rt x fifo p ro t o t y pe v o id dr v i 2 s_ c lear t x fifo ( v o id ) ; descript io n pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 403 - t o clea r t x fifo. t h e in ter n a l p o in ter o f t x fifo is r eset t o s tar t p o in t. p a ra m et er no n e i nclu de dr iv er /dr v i 2 s. h ret urn va lue no n e e x a m p le dr v i 2 s_ c lear t x fifo ( ) ; / * c lear t x fifo */ drvi 2 s _ cle a r r x fifo p ro t o t y pe v o id dr v i 2 s_ c lear r x fif o ( v o id ) ; descript io n t o clea r r x fifo. t h e in ter n a l p o in ter o f r x fifo is r eset t o s tar t p o in t. p a ra m et er no n e i nclu de dr iv er /dr v i 2 s. h ret urn va lue no n e e x a m p le dr v i 2 s_ c lear r x fifo ( ) ; /* c lear r x fif o */ drvi 2 s _ s e l ect cloc k s our ce p ro t o t y pe v o id dr v i 2 s_ sel ect c lo ck s o u r ce ( u in t8 _ t u 8 c lk src sel) ; descript io n t o s elec t i 2 s c lo ck s o u r ce , in c lu d in g ex ter n al 1 2 m, p l l clo ck , hc l k a n d in ter n al 2 2 m . p a ra m et er u8 cl k srcse l [ in] t o s elec t i 2 s c lo ck s o u r ce . t h er e ar e f o u r s o u r ce s f o r i 2 s: pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 404 - dr vi 2 s_ e xt _ 1 2 m : e x ter n al 1 2 mh z cr y s tal clo c k dr vi 2 s_ p l l : p l l clo ck dr vi 2 s_ hc l k : h c l k. dr vi 2 s_ i nt e r nal _ 2 2 m : in ter n al 2 2 mh z o s cillato r clo ck i nclu de dr iv er /dr v i 2 s. h ret urn va lue no n e e x a m p le drvi2s_selclocksource ( drvi2s_ext_12m ); /* i2s clock source from exte rnal 12m */ drvi2s_selclocksource ( drvi2s_pll ); /* i2s clock source from pll clock */ drvi2s_selclocksource (drvi2s_hclk); /* i2 s clock source from hclk */ drvi 2 s _ ge tsourc e cl ock fre q p ro t o t y pe u in t3 2 _ t d r v i 2 s_ getso u r ce c l o ck fre q ( v o id ) ; descript io n t o g et i 2 s so u r ce clo ck f r eq u en c y . p a ra m et er no n e i nclu de dr iv er /dr v i 2 s. h ret urn va lue i 2 s c lo ck s o u r ce f r eq u e n c y . t h e u n it i s hz. e x a m p le u in t3 2 _ t u 3 2 clo ck ; u 3 2 clo ck = dr v i 2 s_ getso u r c ecl o ck ( ); /* get i 2 s s o u r ce clo ck f r eq u e n c y * / drvi 2 s _ ge tve rs ion p ro t o t y pe u in t3 2 _ t dr v i 2 s _ getve r s io n ( v o id ); descript io n get th i s m o d u le ? s v er s io n . pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 405 - p a ra m et er no n e i nclu de dr iv er /dr v i 2 s .h return value version number : 31:24 23:16 15:8 7:0 00000000 major_num minor_num build_num pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 406 - 17. ebi driver 17.1. ebi introduction t h e nu mic r o tm 100 s er ie s eq u ip s an e x ter n a l b u s i n ter f ac e ( e b i ) f o r ex ter n al d ev ice u s ed . t o s av e th e co n n ec tio n s b et w e en ex ter n al d ev ice a n d th i s ch i p , e b i s u p p o r t a d d r ess b u s an d d ata b u s m u ltip lex m o d e. an d , ad d r ess latch en ab le ( al e ) s i g n a l su p p o r ted d if f er en tiate t h e ad d r e s s an d d ata c y cle. on l y nuc1 x 0 x x x b x an d nu c 1 x 0 x x x c x s er ies s u p p o r t th i s f u n c tio n , e x : nuc1 4 0 r d2 b n an d nuc1 4 0 ve 3 c n. p lease r ef er to nu mic r o tm nuc1 0 0 ser ies p r o d u cts selec tio n gu id e o f a p p en d i x in d etails . 17.2. ebi fea tu re ? ? e xternal devices with max. 64k byte (8 bit data width)/128k byte (16 bit data width) supported . ? ? variable e xternal bus base clock (m clk) supported. ? ? 8 bit or 16 bit data widt h supported . ? ? var iab le d ata ac ce s s ti m e ( t ac c ) , address latch enable time (ta le) and address hold time (tahd) supported. ? ? a d d r ess b u s an d d ata b u s m u lt ip lex m o d e s u p p o r ted to s av e th e ad d r ess p in s . ? ? c o n f i g u r ab le id le c y cle s u p p o r ted f o r d if f er en e ac ce s s co n d i tio n : w r ite co m m a n d f in i s h ( w 2 x) , r ea d - to - r ea d ( r 2 r ) . pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 407 - ? ? r elati v e ti m in g co n tr o l w a v ef o r m s h o w n as b elo w , 17.3. t y pe defi nit i on e_drvebi_ data _width enumeration identifier value description e_ drvebi_ data _8bit 0x0 ebi data bus width is 8 bit e_ drvebi_ data _16bit 0x1 ebi data bus width is 16 bit e_drvebi_ addr _width enumeration identifier value description e_ drvebi_ addr _8bit 0x0 ebi address bus width is 8 bit e_ drvebi_ addr _16bit 0x1 ebi address bus width is 16 bit e_drvebi_mclkdiv enumeration identifier value description e_ drvebi_mclkdiv_1 0x0 ebi output cl ock is hclk/1 e_ drvebi_mclkdiv_2 0x1 ebi output clock is hclk/2 e_ drvebi_mclkdiv_4 0x2 ebi output clock is hclk/4 pdf create 8 trial www.nuance.com n c s a d [ 1 5 : 0 ] m c l k n r d t a c c t a s u t a h d n w r a d [ 1 5 : 0 ] a l e t a l e t l h d t a 2 d a d d r e s s o u t p u t [ 1 5 : 0 ] a d d r e s s o u t p u t [ 1 5 : 0 ] w d a t a o u t p u t [ 1 5 : 0 ] r d a t a i n p u t a d d r e s s o u t p u t [ 1 5 : 0 ] i d l e c y c l e a d d r e s s o u t p u t [ 1 5 : 0 ] x x t a s u t a l e
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 408 - e_ drvebi_mclkdiv_8 0x3 ebi output clock is hclk/8 e_ drvebi_mclkdiv_16 0x4 ebi output clock is hclk/16 e_ drvebi_mclkdiv_32 0x5 ebi output clock is hclk/32 e_ drvebi_mclkdiv_default 0x6 ebi output clock is hclk/1 17.4. api functions drv e bi _ ope n p ro t o t y pe int32_t drvebi_ open (drvebi_config_t sebiconfig) descript io n e n ab le e b i f u n c tio n a n d co n f i g u r e t h e r elativ e e b i c o n tr o l r eg i s ter s . p a ra m et er seb i co nfig [ in] i n p u t t h e g e n er al e b i c o n tr o l reg i s ter s etti n g s drveb i _ co nf i g _ t e da t a width: e _ dr ve b i _ da t a _ w i dt h , it c o u ld b e e_ dr ve b i _ da t a _ 8 b i t or e_ dr ve b i _ da t a _ 16 b i t . e addr wi dth: e _ dr ve b i _ a dd r _ w i dt h , it c o u ld b e e_ dr ve b i _ a ddr _ 8 b i t or e_ dr ve b i _ a dd r _ 16 b i t . u3 2 b a s eaddress : i f e a d d r w id th is 8 b its : 0 x 6 0 0 0 0 0 0 0 <= u 3 2 b asea d d r ess < 0 x 6 0 0 1 0 0 0 0 i f e a d d r w id th is 1 6 b its : 0 x 6 0 0 0 0 0 0 0 <= u 3 2 b asea d d r ess <0 x 6 0 0 2 0 0 0 0 u3 2 size : i f e a d d r w id th is 8 b its : 0 x 0 < u 3 2 size <= 0 x 1 0 0 0 0 i f e a d d r w id th is 1 6 b its : 0 x 0 < u 3 2 size <= 0 x 2 0 0 0 0 i nclu de dr iv er /dr v e b i .h ret urn va lue e _ suc c e ss : o p er atio n s u cc ess f u l e _ dr ve b i _ e r r _ ar gum e nt : i n v alid ar g u m en t pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 409 - e x a m p le / * op en t h e e b i d ev ice w it h 1 6 b it b u s w id t h . t h e s tar t ad d r ess o f th e d e v ice is at 0 x 6 0 0 0 0 0 0 0 an d th e s to r ag e s ize is 1 2 8 kb */ dr ve b i _ c onfi g_ t s e b i c o n f i g ; s e b i c o n f ig . e data w id t h = edrveb i _ da t a _16 b i t ; s e b i c o n f ig . e a d d r w id th = edrveb i _ a dd r _16 b i t ; s e b i c o n f ig . u 3 2 b asea d d r ess = 0 x 6 0 0 0 0 0 0 0 ; s e b i c o n f ig . u 3 2 size = 0 x 2 0 0 0 0 ; dr v e b i _ op en ( s e b i c o n f i g ); drv e bi _ clos e p ro t o t y pe v o id dr v e b i _ c lo s e ( v o id ) descript io n dis ab le e b i f u n ctio n a n d r elea s e th e r elati v e p in s f o r gp i o u s ed . p a ra m et er no n e i nclu de dr iv er /dr v e b i .h ret urn va lue no n e e x a m p le: / * c lo s e th e e b i d ev ice */ dr v e b i _ c lo s e (); drve bi_ s e tb usti m in g p ro t o t y pe v o id dr v e b i _ setb u s t i m in g ( dr ve b i _ t i m i ng_ t s e b i t i m i n g ) descript io n c o n f i g u r e t h e r elativ e e b i b u s t i m i n g . p a ra m et er s e b i t i m i ng [ in] drveb i _ t i m i ng _t em cl k div: e _ dr ve b i _ mcl kdi v , it c o u ld b e e_ dr ve b i _ mcl kdi v_ 1 , e_ dr ve b i _ mcl kdi v_ 2 , e _ dr ve b i _ mcl k di v_ 4 , pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 410 - e_ dr ve b i _ mcl kdi v_ 8 , e _ dr ve b i _ mcl k di v_ 1 6, e_ dr ve b i _ mcl kdi v_ 3 2 o r e _ dr ve b i _ mcl kdi v_ d e fau l t . u8 e x t t a l e : e x p a n d ti m e o f al e 0 ~7 , tal e = ( u 8 e x tt al e +1 ) * m c l k. u8 e x t i r2 r: i d le cy cle b et w e en r ea d - r ea d 0 ~1 5 , id le cy cl e = u 8 e x ti r 2 r * m c l k u8 e x t i w2 x : i d le cy cle a f ter w r ite 0 ~1 5 , id le cy cle = u 8 e x ti w 2 x* m c l k u8 e x t t ah d: e b i ad d r ess h o ld ti m e 0 ~7 , ta hd = ( u 8 e x tt ahd +1 ) * mc l k u8 e x t t a cc : e b i d ata ac ce s s ti m e 0 ~3 1 , ta hd = ( u 8 e x tt a c c +1 ) * m c l k i nclu de dr iv er /dr v e b i .h ret urn va lue no n e e x a m p le: / * set t h e r elati v e e b i b u s ti m in g */ dr ve b i _ t i m i ng_ t s e b i t i m i n g ; s e b i t im in g . em c l kdi v = edrveb i _ mclkd i v_ 1 ; s e b i t im in g . u 8 e x tt al e = 0 ; s e b i t im in g . u 8 e x ti r 2 r = 0 ; s e b i t im in g . u 8 e x ti w 2 x = 0 ; s e b i t im in g . u 8 e x tt a h d = 0 ; s e b i t im in g . u 8 e x tt ac c = 0 ; dr v e b i _ setb u s t i m in g ( s e b i t im i n g ) ; drve bi_ g e tb usti m in g p ro t o t y pe v o id dr v e b i _ g etb u s t im in g ( dr ve b i _ t i m i ng_ t * p s e b i t im i n g ) descript io n get th e cu r r e n t b u s t i m in g o f t h e e b i . p a ra m et er ps e b i t i m ing [ o ut ] drveb i _ t i m i ng _t , r ef er to dr v e b i _ setb u s t im i n g f o r d etail in f o r m atio n i nclu de dr iv er /dr v e b i .h ret urn va lue data b u f f er p o in ter th at s to r ed th e e b i b u s t i m i n g s ett in g s e x a m p le: pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 411 - / * get t h e cu r r en t e b i b u s ti m in g * / dr ve b i _ t i m i ng_ t s e b i t i m i n g ; dr v e b i _ getb u s t im in g ( & s e b i t im i n g ) ; drv e bi _ ge tv e rs ion p ro t o t y pe u in t3 2 _ t dr v e b i _ getve r s io n ( v o id ) descript io n get th e v er s io n n u m b er o f e b i d r iv er . i nclu de dr iv er /dr v e b i .h return value v ersion number : 31:24 23:16 15:8 7:0 00000000 major_num minor_num build_num e x a m p le / * get t h e cu r r en t v er s io n o f e b i dr iv er * / u 3 2 ver s io n = dr v e b i _ getve r s io n (); pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 412 - 18. appendi x 18.1. numicro tm nuc100 s eri es pr o du ct s se lec tio n g ui de nuc1 0 0 a d v a n ce l i n e select io n gu id e ( lo w d e n s i t y ) part number flash sram connectivity i2s pwm comp. adc timer rtc ebi isp icp pdma i/o package uart spi i2c nuc100lc1bn 32 kb 4 kb 2 1 2 1 4 1 8 x 12 - bit 4x 32 - bit v - v 1 up to 35 lqfp48 nuc100ld1bn 64 kb 4 kb 2 1 2 1 4 1 8 x 12 - bit 4x 32 - bit v - v 1 up to 35 lqfp48 nuc100ld2bn 64 kb 8 kb 2 1 2 1 4 1 8x12 - bit 4x 32 - bit v - v 1 up to 35 lqfp48 nuc100rc1bn 32 kb 4 kb 2 2 2 1 4 2 8 x 12 - bit 4x 32 - bit v v v 1 up to 49 lqfp64 n uc100rd1bn 64 kb 4 kb 2 2 2 1 4 2 8 x 12 - bit 4x 32 - bit v v v 1 up to 49 lqfp64 nuc100rd2bn 64 kb 8 kb 2 2 2 1 4 2 8x12 - bit 4x 32 - bit v v v 1 up to 49 lqfp64 nuc1 0 0 a d v a n ce l i n e select io n gu id e ( m ed i u m d en s i t y ) part number flash (kb) sram connectivity i2s pw m comp. adc timer rtc ebi isp icp pdma i/o package uart spi i2c nuc100ld3an 64 kb 16 kb 2 1 2 1 6 1 8x12 - bit 4x 32 - bit v - v 9 up to 35 lqfp48 nuc100le3an 128 kb 16 kb 2 1 2 1 6 1 8x12 - bit 4x 32 - bit v - v 9 up to 35 lqfp48 nuc100rd3an 64 kb 16 kb 3 2 2 1 6 2 8x12 - bit 4x 32 - bit v - v 9 up to 49 lqfp64 nuc100re3an 128 kb 16 kb 3 2 2 1 6 2 8x12 - bit 4x 32 - bit v - v 9 up to 49 lqfp64 nuc100vd2an 64 kb 8 kb 3 4 2 1 8 2 8x12 - bit 4x 32 - bit v - v 9 up to 80 lqfp100 nuc100vd3an 64 kb 16 kb 3 4 2 1 8 2 8x12 - bit 4x 32 - bit v - v 9 up to 80 lqfp100 nuc100ve3an 128 kb 16 kb 3 4 2 1 8 2 8x12 - bit 4x 32 - bit v - v 9 up to 80 lqfp100 nuc1 2 0 usb l in e selectio n gu id e ( lo w d en s it y ) part number flash sram connectivity i2s pwm comp. adc timer rtc ebi isp icp pdma i/ o package uart sp i i2c usb nuc120lc1bn 32 kb 4 kb 2 1 2 1 1 4 1 8 x 12 - bit 4x 32 - bit v - v 1 up to 31 lqfp48 nuc120ld1bn 64 kb 4 kb 2 1 2 1 1 4 1 8 x 12 - bit 4x 32 - bit v - v 1 up to 31 lqfp48 nuc120ld2bn 64 kb 8 kb 2 1 2 1 1 4 1 8x12 - bit 4x 32 - bi t v - v 1 up to 31 lqfp48 pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 413 - nuc120rc1bn 32 kb 4 kb 2 2 2 1 1 4 2 8 x 12 - bit 4x 32 - bit v v v 1 up to 45 lqfp64 nuc120rd1bn 64 kb 4 kb 2 2 2 1 1 4 2 8 x 12 - bit 4x 32 - bit v v v 1 up to 45 lqfp64 nuc120rd2bn 64 kb 8 kb 2 2 2 1 1 4 2 8x12 - bit 4x 32 - bit v v v 1 up to 45 lqfp64 nuc1 2 0 usb l in e selectio n gu id e ( m ed i u m d e n s it y ) part number flash sram connectivity i2s pwm comp. adc timer rtc ebi isp icp pdma i/o package uart spi i2c usb nuc120ld3an 64 kb 16 kb 2 1 2 1 1 4 1 8x12 - bit 4x 32 - bit v - v 9 up to 31 lqfp48 nuc120le3an 128 kb 16 kb 2 1 2 1 1 4 1 8x12 - bit 4x 32 - bit v - v 9 up to 31 lqfp48 nuc120rd3an 64 kb 16 kb 2 2 2 1 1 6 2 8x12 - bit 4x 32 - bit v - v 9 up to 45 lqfp64 nuc120re3an 128 kb 16 kb 2 2 2 1 1 6 2 8x12 - bit 4x 32 - bit v - v 9 up to 45 lqfp64 nuc120vd2an 64 kb 8 kb 3 4 2 1 1 8 2 8x12 - bit 4x 32 - bit v - v 9 up to 76 lqfp100 nuc120vd3an 64 kb 16 kb 3 4 2 1 1 8 2 8x12 - bit 4x 32 - bit v - v 9 up to 76 lqfp100 nuc120ve3an 128 kb 16 kb 3 4 2 1 1 8 2 8x12 - bit 4x 32 - bit v - v 9 up to 76 lqfp100 nuc1 3 0 au to m o ti v e l i n e sel ec tio n g u id e part number flash sram connectivity i2s pwm comp. adc timer rtc ebi isp icp pdma i/o package uart spi i2c lin can nuc130l c1c n 32 kb 4 kb 3 1 2 2 1 1 4 1 8x12 - bit 4x 32 - bit v - v 9 up to 35 lqfp48 nuc130ld2 c n 64 kb 8 kb 3 1 2 2 1 1 4 1 8x12 - bit 4x 32 - bit v - v 9 up to 35 lqfp48 nuc130le3cn 128kb 16kb 3 1 2 2 1 1 4 1 8x12 - bit 4x 32 - bit v - v 9 up to 35 lqfp48 nuc130r c1c n 32 kb 4 kb 3 2 2 2 1 1 6 2 8x12 - bit 4x 32 - bit v v v 9 up to 49 lqfp64 nuc130rd2 c n 64 kb 8 kb 3 2 2 2 1 1 6 2 8x12 - bit 4x 32 - bit v v v 9 up to 49 lqfp64 NUC130RE3CN 128kb 16kb 3 2 2 2 1 1 6 2 8x12 - bit 4x 32 - bit v v v 9 up to 49 lqfp64 nuc130ve3cn 128k b 16k b 3 4 2 2 1 1 8 2 8x12 - bit 4x 32 - bit v v v 9 up to 80 lqfp 100 nuc1 4 0 c o n n ec tiv it y l i n e s elec tio n gu id e part number flash sram connectivity i2s pwm comp. adc timer rtc ebi isp icp pdma i/o package uart spi i2c usb lin can nuc140l c1c n 32 kb 4 kb 2 1 2 1 2 1 1 4 1 8x12 - bit 4x 32 - bit v - v 9 up to 31 lqfp48 nuc140ld2 c n 64 kb 8 kb 2 1 2 1 2 1 1 4 1 8x12 - bit 4x 32 - bit v - v 9 up to 31 lqfp48 nuc140le3cn 128kb 16kb 2 1 2 1 2 1 1 4 1 8x12 - bit 4x 32 - bit v - v 9 up to 31 lqfp48 nuc140r c1c n 32 kb 4 kb 3 2 2 1 2 1 1 4 2 8x12 - bit 4x 32 - bit v v v 9 up to 45 lqfp64 nuc140rd2 c n 64 kb 8 kb 3 2 2 1 2 1 1 4 2 8x12 - bit 4x 32 - bit v v v 9 up to 45 lqfp64 nuc140re3cn 128kb 16kb 3 2 2 1 2 1 1 4 2 8x12 - bit 4x 32 - bit v v v 9 up to 45 lqfp 64 nuc140ve3cn 128kb 16kb 3 4 2 1 2 1 1 8 2 8x12 - bit 4x 32 - bit v v v 9 up to 76 lqfp 100 pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 41 4 - nuc1 0 1 selectio n g u id e part num ber flash sram connectivity i2s pwm comp. adc timer rtc isp icp i/o package uart spi i2c usb lin can nuc10 1 l c1 bn 32 kb 4 kb 1 2 1 1 - - 1 4 1 - 4x 32 - bit - v up to 31 lqfp48 nuc1 01 ld2bn 64 kb 8 kb 1 2 1 1 - - 1 4 1 - 4x 32 - bit - v up to 31 lqf p48 nuc10 1yc1 bn 32 kb 4 kb 1 2 1 1 - - 1 1 1 - 4x 32 - bit - v up to 31 qfp 36 nuc1 0 1y d2bn 64 kb 8 kb 1 2 1 1 - - 1 1 1 - 4x 32 - bit - v up to 31 qfp 3 6 18.2. p d id ta ble nuc100 advance line p d id list ( low density) part number pdid nuc100lc1bn 0x10010008 nuc100ld1bn 0x10010005 nuc100ld2bn 0x10010004 nuc100rc1bn 0x10010017 nuc100rd1bn 0x10010014 nuc100rd2bn 0x10010013 nuc1 0 0 a d v a n ce l i n e p d i d l is t ( m ed iu m d en s it y ) part number pdid nuc100ld3an 0x00010003 nuc100le3an 0x00010000 n u c 1 00rd3an 0x00010012 n u c 1 00re3an 0x00010009 n u c 1 00vd2an 0x00010022 n u c 1 00vd3an 0x00010021 n u c 1 00ve3an 0x00010018 nuc1 2 0 usb l in e p d i d l is t ( lo w d en s i t y ) part number pdid nuc120lc1bn 0x10012008 nuc120ld1bn 0x10012005 nuc120ld2bn 0x10012004 nuc120rc1bn 0x10012017 nuc 120rd1bn 0x10012014 nuc120rd2bn 0x10012013 nuc1 2 0 usb l in e p d i d l is t ( m ed i u m d en s i t y ) part number p d id nuc120ld3an 0x00012003 nuc120le3an 0x00012000 nuc120rd3an 0x00012012 nuc120re3an 0x00012009 nuc120vd2an 0x00012022 pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 415 - nuc120vd3an 0x00012021 nuc12 0ve3an 0x00012018 nuc1 3 0 au to m o ti v e l i n e p d i d l is t part number p d id nuc130l c1c n 0x20013008 nuc130ld2 c n 0x20013004 nuc130le3cn 0x20013000 nuc130r c1c n 0x20013017 nuc130rd2 c n 0x20013013 NUC130RE3CN 0x20013009 nuc130ve3cn 0x20013018 nuc1 4 0 c o n n ec tiv it y l i n e p d i d l is t part number p d id nuc140l c1c n 0x20014008 nuc140ld2 c n 0x20014004 nuc140le3cn 0x20014000 nuc140r c1c n 0x20014017 nuc140rd2 c n 0x20014013 nuc140re3cn 0x20014009 nuc140ve3cn 0x20014018 nuc1 0 1 p d i d l is t part number pdid nuc10 1 l c1 bn 0x1 0010108 nuc1 01 ld2bn 0x10010104 nuc10 1yc1 bn 0x10010147 nuc10 1y d2bn 0x10010143 pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 416 - 19. revision history version date description v1.0 0 .001 jan . 8 , 200 9 ? ? created v1.00.002 july. 30, 2010 ? ? f ix errors ? ? a dd example of api v1.0 3 .001 jan. 5, 2011 ? ? fix errors ? ? fix cloc k diagram error ? ? update api description according to nuc100 series bsp v.1.00 3 .001 v1.04.001 mar. 19, 2011 ? ? update can driver ? ? supports nuc130xxxcn and 140xxxcn v1.04.002 apr. 27, 2011 ? ? update clock diagram to add ebi clock tree v1.04.003 apr. 30, 2011 ? ? fix the deviation value of 10 k hz and 22.1184mhz oscillator ? ? fix the register name of can driver v1.05.001 june. 27, 2011 ? ? rename api name of can driver ? ? add some new api pdf create 8 trial www.nuance.com
nu m ic ro tm nu c10 0 s e ri e s dri v e r re fer e nce gui de v1 . 0 5 . 0 0 1 - 417 - important notice nuvoton products are not designed, intended, authorized or warranted fo r use as components in equipment or systems intended for surgical implantation, atomic energy control instruments, aircraft or spacecraft instruments, transportation instruments, traffic signal instruments, combustion control instruments, or for any other applications intended to support or sustain life. furthermore, nuvoton products are not intended for applications whereby failure could result or lead to personal injury, death or severe property or environmental damage. nuvoton customers using or selling these products for such applications do so at their own risk and agree to fully indemnify nuvoton for any damages resulting from their improper use or sales. pdf create 8 trial www.nuance.com

▲Up To Search▲

Price & Availability of NUC130RE3CN

	To Download NUC130RE3CN Datasheet File
If you can't view the Datasheet, Please click here to try to view without PDF Reader .