-
Notifications
You must be signed in to change notification settings - Fork 3k
/
fsl_enet.c
1746 lines (1532 loc) · 61.4 KB
/
fsl_enet.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright (c) 2015, Freescale Semiconductor, Inc.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
*
* o Redistributions of source code must retain the above copyright notice, this list
* of conditions and the following disclaimer.
*
* o Redistributions in binary form must reproduce the above copyright notice, this
* list of conditions and the following disclaimer in the documentation and/or
* other materials provided with the distribution.
*
* o Neither the name of Freescale Semiconductor, Inc. nor the names of its
* contributors may be used to endorse or promote products derived from this
* software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#include "fsl_enet.h"
/*******************************************************************************
* Definitions
******************************************************************************/
/*! @brief IPv4 PTP message IP version offset. */
#define ENET_PTP1588_IPVERSION_OFFSET 0x0EU
/*! @brief IPv4 PTP message UDP protocol offset. */
#define ENET_PTP1588_IPV4_UDP_PROTOCOL_OFFSET 0x17U
/*! @brief IPv4 PTP message UDP port offset. */
#define ENET_PTP1588_IPV4_UDP_PORT_OFFSET 0x24U
/*! @brief IPv4 PTP message UDP message type offset. */
#define ENET_PTP1588_IPV4_UDP_MSGTYPE_OFFSET 0x2AU
/*! @brief IPv4 PTP message UDP version offset. */
#define ENET_PTP1588_IPV4_UDP_VERSION_OFFSET 0x2BU
/*! @brief IPv4 PTP message UDP clock id offset. */
#define ENET_PTP1588_IPV4_UDP_CLKID_OFFSET 0x3EU
/*! @brief IPv4 PTP message UDP sequence id offset. */
#define ENET_PTP1588_IPV4_UDP_SEQUENCEID_OFFSET 0x48U
/*! @brief IPv4 PTP message UDP control offset. */
#define ENET_PTP1588_IPV4_UDP_CTL_OFFSET 0x4AU
/*! @brief IPv6 PTP message UDP protocol offset. */
#define ENET_PTP1588_IPV6_UDP_PROTOCOL_OFFSET 0x14U
/*! @brief IPv6 PTP message UDP port offset. */
#define ENET_PTP1588_IPV6_UDP_PORT_OFFSET 0x38U
/*! @brief IPv6 PTP message UDP message type offset. */
#define ENET_PTP1588_IPV6_UDP_MSGTYPE_OFFSET 0x3EU
/*! @brief IPv6 PTP message UDP version offset. */
#define ENET_PTP1588_IPV6_UDP_VERSION_OFFSET 0x3FU
/*! @brief IPv6 PTP message UDP clock id offset. */
#define ENET_PTP1588_IPV6_UDP_CLKID_OFFSET 0x52U
/*! @brief IPv6 PTP message UDP sequence id offset. */
#define ENET_PTP1588_IPV6_UDP_SEQUENCEID_OFFSET 0x5CU
/*! @brief IPv6 PTP message UDP control offset. */
#define ENET_PTP1588_IPV6_UDP_CTL_OFFSET 0x5EU
/*! @brief PTPv2 message Ethernet packet type offset. */
#define ENET_PTP1588_ETHL2_PACKETTYPE_OFFSET 0x0CU
/*! @brief PTPv2 message Ethernet message type offset. */
#define ENET_PTP1588_ETHL2_MSGTYPE_OFFSET 0x0EU
/*! @brief PTPv2 message Ethernet version type offset. */
#define ENET_PTP1588_ETHL2_VERSION_OFFSET 0X0FU
/*! @brief PTPv2 message Ethernet clock id offset. */
#define ENET_PTP1588_ETHL2_CLOCKID_OFFSET 0x22
/*! @brief PTPv2 message Ethernet sequence id offset. */
#define ENET_PTP1588_ETHL2_SEQUENCEID_OFFSET 0x2c
/*! @brief Packet type Ethernet IEEE802.3 for PTPv2. */
#define ENET_ETHERNETL2 0x88F7U
/*! @brief Packet type IPv4. */
#define ENET_IPV4 0x0800U
/*! @brief Packet type IPv6. */
#define ENET_IPV6 0x86ddU
/*! @brief Packet type VLAN. */
#define ENET_8021QVLAN 0x8100U
/*! @brief UDP protocol type. */
#define ENET_UDPVERSION 0x0011U
/*! @brief Packet IP version IPv4. */
#define ENET_IPV4VERSION 0x0004U
/*! @brief Packet IP version IPv6. */
#define ENET_IPV6VERSION 0x0006U
/*! @brief Ethernet mac address length. */
#define ENET_FRAME_MACLEN 6U
/*! @brief Ethernet Frame header length. */
#define ENET_FRAME_HEADERLEN 14U
/*! @brief Ethernet VLAN header length. */
#define ENET_FRAME_VLAN_HEADERLEN 18U
/*! @brief MDC frequency. */
#define ENET_MDC_FREQUENCY 2500000U
/*! @brief NanoSecond in one second. */
#define ENET_NANOSECOND_ONE_SECOND 1000000000U
/*! @brief Define a common clock cycle delays used for time stamp capture. */
#define ENET_1588TIME_DELAY_COUNT 10U
/*! @brief Defines the macro for converting constants from host byte order to network byte order. */
#define ENET_HTONS(n) __REV16(n)
#define ENET_HTONL(n) __REV(n)
#define ENET_NTOHS(n) __REV16(n)
#define ENET_NTOHL(n) __REV(n)
/* Typedef for interrupt handler. */
typedef void (*enet_isr_t)(ENET_Type *base, enet_handle_t *handle);
/*******************************************************************************
* Prototypes
******************************************************************************/
/*!
* @brief Get the ENET instance from peripheral base address.
*
* @param base ENET peripheral base address.
* @return ENET instance.
*/
uint32_t ENET_GetInstance(ENET_Type *base);
/*!
* @brief Set ENET MAC controller with the configuration.
*
* @param base ENET peripheral base address.
* @param config ENET Mac configuration.
* @param bufferConfig ENET buffer configuration.
* @param macAddr ENET six-byte mac address.
* @param srcClock_Hz ENET module clock source, normally it's system clock.
*/
static void ENET_SetMacController(ENET_Type *base,
const enet_config_t *config,
const enet_buffer_config_t *bufferConfig,
uint8_t *macAddr,
uint32_t srcClock_Hz);
/*!
* @brief Set ENET handler.
*
* @param base ENET peripheral base address.
* @param handle The ENET handle pointer.
* @param config ENET configuration stucture pointer.
* @param bufferConfig ENET buffer configuration.
*/
static void ENET_SetHandler(ENET_Type *base,
enet_handle_t *handle,
const enet_config_t *config,
const enet_buffer_config_t *bufferConfig);
/*!
* @brief Set ENET MAC transmit buffer descriptors.
*
* @param txBdStartAlign The aligned start address of ENET transmit buffer descriptors.
* is recommended to evenly divisible by 16.
* @param txBuffStartAlign The aligned start address of ENET transmit buffers, must be evenly divisible by 16.
* @param txBuffSizeAlign The aligned ENET transmit buffer size, must be evenly divisible by 16.
* @param txBdNumber The number of ENET transmit buffers.
*/
static void ENET_SetTxBufferDescriptors(volatile enet_tx_bd_struct_t *txBdStartAlign,
uint8_t *txBuffStartAlign,
uint32_t txBuffSizeAlign,
uint32_t txBdNumber);
/*!
* @brief Set ENET MAC receive buffer descriptors.
*
* @param rxBdStartAlign The aligned start address of ENET receive buffer descriptors.
* is recommended to evenly divisible by 16.
* @param rxBuffStartAlign The aligned start address of ENET receive buffers, must be evenly divisible by 16.
* @param rxBuffSizeAlign The aligned ENET receive buffer size, must be evenly divisible by 16.
* @param rxBdNumber The number of ENET receive buffers.
* @param enableInterrupt Enable/disables to generate the receive byte and frame interrupt.
* It's used for ENET_ENHANCEDBUFFERDESCRIPTOR_MODE enabled case.
*/
static void ENET_SetRxBufferDescriptors(volatile enet_rx_bd_struct_t *rxBdStartAlign,
uint8_t *rxBuffStartAlign,
uint32_t rxBuffSizeAlign,
uint32_t rxBdNumber,
bool enableInterrupt);
/*!
* @brief Updates the ENET read buffer descriptors.
*
* @param base ENET peripheral base address.
* @param handle The ENET handle pointer.
*/
static void ENET_UpdateReadBuffers(ENET_Type *base, enet_handle_t *handle);
#ifdef ENET_ENHANCEDBUFFERDESCRIPTOR_MODE
/*!
* @brief Parses the ENET frame for time-stamp process of PTP 1588 frame.
*
* @param data The ENET read data for frame parse.
* @param ptpTsData The ENET PTP message and time-stamp data pointer.
* @param isFastEnabled The fast parse flag.
* - true , Fast processing, only check if this is a PTP message.
* - false, Store the PTP message data after check the PTP message.
*/
static bool ENET_Ptp1588ParseFrame(uint8_t *data, enet_ptp_time_data_t *ptpTsData, bool isFastEnabled);
/*!
* @brief Updates the new PTP 1588 time-stamp to the time-stamp buffer ring.
*
* @param ptpTsDataRing The PTP message and time-stamp data ring pointer.
* @param ptpTimeData The new PTP 1588 time-stamp data pointer.
*/
static status_t ENET_Ptp1588UpdateTimeRing(enet_ptp_time_data_ring_t *ptpTsDataRing, enet_ptp_time_data_t *ptpTimeData);
/*!
* @brief Search up the right PTP 1588 time-stamp from the time-stamp buffer ring.
*
* @param ptpTsDataRing The PTP message and time-stamp data ring pointer.
* @param ptpTimeData The find out right PTP 1588 time-stamp data pointer with the specific PTP message.
*/
static status_t ENET_Ptp1588SearchTimeRing(enet_ptp_time_data_ring_t *ptpTsDataRing, enet_ptp_time_data_t *ptpTimedata);
/*!
* @brief Store the transmit time-stamp for event PTP frame in the time-stamp buffer ring.
*
* @param base ENET peripheral base address.
* @param handle The ENET handle pointer.
*/
static status_t ENET_StoreTxFrameTime(ENET_Type *base, enet_handle_t *handle);
/*!
* @brief Store the receive time-stamp for event PTP frame in the time-stamp buffer ring.
*
* @param base ENET peripheral base address.
* @param handle The ENET handle pointer.
* @param ptpTimeData The PTP 1588 time-stamp data pointer.
*/
static status_t ENET_StoreRxFrameTime(ENET_Type *base, enet_handle_t *handle, enet_ptp_time_data_t *ptpTimeData);
#endif /* ENET_ENHANCEDBUFFERDESCRIPTOR_MODE */
/*******************************************************************************
* Variables
******************************************************************************/
/*! @brief Pointers to enet handles for each instance. */
static enet_handle_t *s_ENETHandle[FSL_FEATURE_SOC_ENET_COUNT] = {NULL};
#if !(defined(FSL_SDK_DISABLE_DRIVER_CLOCK_CONTROL) && FSL_SDK_DISABLE_DRIVER_CLOCK_CONTROL)
/*! @brief Pointers to enet clocks for each instance. */
const clock_ip_name_t s_enetClock[] = ENET_CLOCKS;
#endif /* FSL_SDK_DISABLE_DRIVER_CLOCK_CONTROL */
/*! @brief Pointers to enet transmit IRQ number for each instance. */
static const IRQn_Type s_enetTxIrqId[] = ENET_Transmit_IRQS;
/*! @brief Pointers to enet receive IRQ number for each instance. */
static const IRQn_Type s_enetRxIrqId[] = ENET_Receive_IRQS;
#if defined(ENET_ENHANCEDBUFFERDESCRIPTOR_MODE) && ENET_ENHANCEDBUFFERDESCRIPTOR_MODE
/*! @brief Pointers to enet timestamp IRQ number for each instance. */
static const IRQn_Type s_enetTsIrqId[] = ENET_1588_Timer_IRQS;
#endif /* ENET_ENHANCEDBUFFERDESCRIPTOR_MODE */
/*! @brief Pointers to enet error IRQ number for each instance. */
static const IRQn_Type s_enetErrIrqId[] = ENET_Error_IRQS;
/*! @brief Pointers to enet bases for each instance. */
static ENET_Type *const s_enetBases[] = ENET_BASE_PTRS;
/* ENET ISR for transactional APIs. */
static enet_isr_t s_enetTxIsr;
static enet_isr_t s_enetRxIsr;
static enet_isr_t s_enetErrIsr;
/*******************************************************************************
* Code
******************************************************************************/
uint32_t ENET_GetInstance(ENET_Type *base)
{
uint32_t instance;
/* Find the instance index from base address mappings. */
for (instance = 0; instance < FSL_FEATURE_SOC_ENET_COUNT; instance++)
{
if (s_enetBases[instance] == base)
{
break;
}
}
assert(instance < FSL_FEATURE_SOC_ENET_COUNT);
return instance;
}
void ENET_GetDefaultConfig(enet_config_t *config)
{
/* Checks input parameter. */
assert(config);
/* Initializes the MAC configure structure to zero. */
memset(config, 0, sizeof(enet_config_t));
/* Sets MII mode, full duplex, 100Mbps for MAC and PHY data interface. */
config->miiMode = kENET_RmiiMode;
config->miiSpeed = kENET_MiiSpeed100M;
config->miiDuplex = kENET_MiiFullDuplex;
/* Sets the maximum receive frame length. */
config->rxMaxFrameLen = ENET_FRAME_MAX_FRAMELEN;
}
void ENET_Init(ENET_Type *base,
enet_handle_t *handle,
const enet_config_t *config,
const enet_buffer_config_t *bufferConfig,
uint8_t *macAddr,
uint32_t srcClock_Hz)
{
/* Checks input parameters. */
assert(handle);
assert(config);
assert(bufferConfig);
assert(bufferConfig->rxBdStartAddrAlign);
assert(bufferConfig->txBdStartAddrAlign);
assert(bufferConfig->rxBufferAlign);
assert(macAddr);
#if !(defined(FSL_SDK_DISABLE_DRIVER_CLOCK_CONTROL) && FSL_SDK_DISABLE_DRIVER_CLOCK_CONTROL)
uint32_t instance = ENET_GetInstance(base);
/* Ungate ENET clock. */
CLOCK_EnableClock(s_enetClock[instance]);
#endif /* FSL_SDK_DISABLE_DRIVER_CLOCK_CONTROL */
/* Reset ENET module. */
ENET_Reset(base);
/* Initializes the ENET transmit buffer descriptors. */
ENET_SetTxBufferDescriptors(bufferConfig->txBdStartAddrAlign, bufferConfig->txBufferAlign,
bufferConfig->txBuffSizeAlign, bufferConfig->txBdNumber);
/* Initializes the ENET receive buffer descriptors. */
ENET_SetRxBufferDescriptors(bufferConfig->rxBdStartAddrAlign, bufferConfig->rxBufferAlign,
bufferConfig->rxBuffSizeAlign, bufferConfig->rxBdNumber,
!!(config->interrupt & (kENET_RxFrameInterrupt | kENET_RxBufferInterrupt)));
/* Initializes the ENET MAC controller. */
ENET_SetMacController(base, config, bufferConfig, macAddr, srcClock_Hz);
/* Set all buffers or data in handler for data transmit/receive process. */
ENET_SetHandler(base, handle, config, bufferConfig);
}
void ENET_Deinit(ENET_Type *base)
{
/* Disable interrupt. */
base->EIMR = 0;
/* Disable ENET. */
base->ECR &= ~ENET_ECR_ETHEREN_MASK;
#if !(defined(FSL_SDK_DISABLE_DRIVER_CLOCK_CONTROL) && FSL_SDK_DISABLE_DRIVER_CLOCK_CONTROL)
/* Disables the clock source. */
CLOCK_DisableClock(s_enetClock[ENET_GetInstance(base)]);
#endif /* FSL_SDK_DISABLE_DRIVER_CLOCK_CONTROL */
}
void ENET_SetCallback(enet_handle_t *handle, enet_callback_t callback, void *userData)
{
assert(handle);
/* Set callback and userData. */
handle->callback = callback;
handle->userData = userData;
}
static void ENET_SetHandler(ENET_Type *base,
enet_handle_t *handle,
const enet_config_t *config,
const enet_buffer_config_t *bufferConfig)
{
uint32_t instance = ENET_GetInstance(base);
memset(handle, 0, sizeof(enet_handle_t));
handle->rxBdBase = bufferConfig->rxBdStartAddrAlign;
handle->rxBdCurrent = bufferConfig->rxBdStartAddrAlign;
handle->txBdBase = bufferConfig->txBdStartAddrAlign;
handle->txBdCurrent = bufferConfig->txBdStartAddrAlign;
handle->txBdDirty = bufferConfig->txBdStartAddrAlign;
handle->rxBuffSizeAlign = bufferConfig->rxBuffSizeAlign;
handle->txBuffSizeAlign = bufferConfig->txBuffSizeAlign;
/* Save the handle pointer in the global variables. */
s_ENETHandle[instance] = handle;
/* Set the IRQ handler when the interrupt is enabled. */
if (config->interrupt & ENET_TX_INTERRUPT)
{
s_enetTxIsr = ENET_TransmitIRQHandler;
EnableIRQ(s_enetTxIrqId[instance]);
}
if (config->interrupt & ENET_RX_INTERRUPT)
{
s_enetRxIsr = ENET_ReceiveIRQHandler;
EnableIRQ(s_enetRxIrqId[instance]);
}
if (config->interrupt & ENET_ERR_INTERRUPT)
{
s_enetErrIsr = ENET_ErrorIRQHandler;
EnableIRQ(s_enetErrIrqId[instance]);
}
}
static void ENET_SetMacController(ENET_Type *base,
const enet_config_t *config,
const enet_buffer_config_t *bufferConfig,
uint8_t *macAddr,
uint32_t srcClock_Hz)
{
uint32_t rcr = 0;
uint32_t tcr = 0;
uint32_t ecr = 0;
uint32_t macSpecialConfig = config->macSpecialConfig;
ENET_GetInstance(base);
/* Configures MAC receive controller with user configure structure. */
rcr = ENET_RCR_NLC(!!(macSpecialConfig & kENET_ControlRxPayloadCheckEnable)) |
ENET_RCR_CFEN(!!(macSpecialConfig & kENET_ControlFlowControlEnable)) |
ENET_RCR_FCE(!!(macSpecialConfig & kENET_ControlFlowControlEnable)) |
ENET_RCR_PADEN(!!(macSpecialConfig & kENET_ControlRxPadRemoveEnable)) |
ENET_RCR_BC_REJ(!!(macSpecialConfig & kENET_ControlRxBroadCastRejectEnable)) |
ENET_RCR_PROM(!!(macSpecialConfig & kENET_ControlPromiscuousEnable)) | ENET_RCR_MII_MODE(1) |
ENET_RCR_RMII_MODE(config->miiMode) | ENET_RCR_RMII_10T(!config->miiSpeed) |
ENET_RCR_MAX_FL(config->rxMaxFrameLen) | ENET_RCR_CRCFWD(1);
/* Receive setting for half duplex. */
if (config->miiDuplex == kENET_MiiHalfDuplex)
{
rcr |= ENET_RCR_DRT(1);
}
/* Sets internal loop only for MII mode. */
if ((config->macSpecialConfig & kENET_ControlMIILoopEnable) && (config->miiMode == kENET_MiiMode))
{
rcr |= ENET_RCR_LOOP(1);
rcr &= ~ENET_RCR_DRT_MASK;
}
base->RCR = rcr;
/* Configures MAC transmit controller: duplex mode, mac address insertion. */
tcr = base->TCR & ~(ENET_TCR_FDEN_MASK | ENET_TCR_ADDINS_MASK);
tcr |= ENET_TCR_FDEN(config->miiDuplex) | ENET_TCR_ADDINS(!!(macSpecialConfig & kENET_ControlMacAddrInsert));
base->TCR = tcr;
/* Configures receive and transmit accelerator. */
base->TACC = config->txAccelerConfig;
base->RACC = config->rxAccelerConfig;
/* Sets the pause duration and FIFO threshold for the flow control enabled case. */
if (macSpecialConfig & kENET_ControlFlowControlEnable)
{
uint32_t reemReg;
base->OPD = config->pauseDuration;
reemReg = ENET_RSEM_RX_SECTION_EMPTY(config->rxFifoEmptyThreshold);
#if FSL_FEATURE_ENET_HAS_RECEIVE_STATUS_THRESHOLD
reemReg |= ENET_RSEM_STAT_SECTION_EMPTY(config->rxFifoStatEmptyThreshold);
#endif /* FSL_FEATURE_ENET_HAS_RECEIVE_STATUS_THRESHOLD */
base->RSEM = reemReg;
}
/* FIFO threshold setting for store and forward enable/disable case. */
if (macSpecialConfig & kENET_ControlStoreAndFwdDisable)
{
/* Transmit fifo watermark settings. */
base->TFWR = config->txFifoWatermark & ENET_TFWR_TFWR_MASK;
/* Receive fifo full threshold settings. */
base->RSFL = config->rxFifoFullThreshold & ENET_RSFL_RX_SECTION_FULL_MASK;
}
else
{
/* Transmit fifo watermark settings. */
base->TFWR = ENET_TFWR_STRFWD_MASK;
base->RSFL = 0;
}
/* Enable store and forward when accelerator is enabled */
if (config->txAccelerConfig & (kENET_TxAccelIpCheckEnabled | kENET_TxAccelProtoCheckEnabled))
{
base->TFWR = ENET_TFWR_STRFWD_MASK;
}
if (config->rxAccelerConfig & (kENET_RxAccelIpCheckEnabled | kENET_RxAccelProtoCheckEnabled))
{
base->RSFL = 0;
}
/* Initializes transmit buffer descriptor rings start address, two start address should be aligned. */
base->TDSR = (uint32_t)bufferConfig->txBdStartAddrAlign;
base->RDSR = (uint32_t)bufferConfig->rxBdStartAddrAlign;
/* Initializes the maximum buffer size, the buffer size should be aligned. */
base->MRBR = bufferConfig->rxBuffSizeAlign;
/* Configures the Mac address. */
ENET_SetMacAddr(base, macAddr);
/* Initialize the SMI if uninitialized. */
if (!ENET_GetSMI(base))
{
ENET_SetSMI(base, srcClock_Hz, !!(config->macSpecialConfig & kENET_ControlSMIPreambleDisable));
}
/* Enables Ethernet interrupt and NVIC. */
ENET_EnableInterrupts(base, config->interrupt);
/* ENET control register setting. */
ecr = base->ECR;
#ifdef ENET_ENHANCEDBUFFERDESCRIPTOR_MODE
/* Sets the 1588 enhanced feature. */
ecr |= ENET_ECR_EN1588_MASK;
#endif /* ENET_ENHANCEDBUFFERDESCRIPTOR_MODE */
/* Enables Ethernet module after all configuration except the buffer descriptor active. */
ecr |= ENET_ECR_ETHEREN_MASK | ENET_ECR_DBSWP_MASK;
base->ECR = ecr;
}
static void ENET_SetTxBufferDescriptors(volatile enet_tx_bd_struct_t *txBdStartAlign,
uint8_t *txBuffStartAlign,
uint32_t txBuffSizeAlign,
uint32_t txBdNumber)
{
assert(txBdStartAlign);
uint32_t count;
volatile enet_tx_bd_struct_t *curBuffDescrip = txBdStartAlign;
for (count = 0; count < txBdNumber; count++)
{
if (txBuffStartAlign != NULL)
{
/* Set data buffer address. */
curBuffDescrip->buffer = (uint8_t *)((uint32_t)&txBuffStartAlign[count * txBuffSizeAlign]);
}
else
{
/* User should provide the transmit buffer at a later time */
curBuffDescrip->buffer = NULL;
}
/* Initializes data length. */
curBuffDescrip->length = 0;
/* Sets the crc. */
curBuffDescrip->control = ENET_BUFFDESCRIPTOR_TX_TRANMITCRC_MASK;
/* Sets the last buffer descriptor with the wrap flag. */
if (count == txBdNumber - 1)
{
curBuffDescrip->control |= ENET_BUFFDESCRIPTOR_TX_WRAP_MASK;
}
#ifdef ENET_ENHANCEDBUFFERDESCRIPTOR_MODE
/* Enable transmit interrupt for store the transmit timestamp. */
curBuffDescrip->controlExtend1 |= ENET_BUFFDESCRIPTOR_TX_INTERRUPT_MASK;
#endif /* ENET_ENHANCEDBUFFERDESCRIPTOR_MODE */
/* Increase the index. */
curBuffDescrip++;
}
}
static void ENET_SetRxBufferDescriptors(volatile enet_rx_bd_struct_t *rxBdStartAlign,
uint8_t *rxBuffStartAlign,
uint32_t rxBuffSizeAlign,
uint32_t rxBdNumber,
bool enableInterrupt)
{
assert(rxBdStartAlign);
assert(rxBuffStartAlign);
volatile enet_rx_bd_struct_t *curBuffDescrip = rxBdStartAlign;
uint32_t count = 0;
/* Initializes receive buffer descriptors. */
for (count = 0; count < rxBdNumber; count++)
{
/* Set data buffer and the length. */
curBuffDescrip->buffer = (uint8_t *)(*((uint32_t *)(rxBuffStartAlign + count * 4)));
curBuffDescrip->length = 0;
/* Initializes the buffer descriptors with empty bit. */
curBuffDescrip->control = ENET_BUFFDESCRIPTOR_RX_EMPTY_MASK;
/* Sets the last buffer descriptor with the wrap flag. */
if (count == rxBdNumber - 1)
{
curBuffDescrip->control |= ENET_BUFFDESCRIPTOR_RX_WRAP_MASK;
}
#ifdef ENET_ENHANCEDBUFFERDESCRIPTOR_MODE
if (enableInterrupt)
{
/* Enable receive interrupt. */
curBuffDescrip->controlExtend1 |= ENET_BUFFDESCRIPTOR_RX_INTERRUPT_MASK;
}
else
{
curBuffDescrip->controlExtend1 = 0;
}
#endif /* ENET_ENHANCEDBUFFERDESCRIPTOR_MODE */
/* Increase the index. */
curBuffDescrip++;
}
}
void ENET_SetMII(ENET_Type *base, enet_mii_speed_t speed, enet_mii_duplex_t duplex)
{
uint32_t rcr = base->RCR;
uint32_t tcr = base->TCR;
/* Sets speed mode. */
if (kENET_MiiSpeed10M == speed)
{
rcr |= ENET_RCR_RMII_10T_MASK;
}
else
{
rcr &= ~ENET_RCR_RMII_10T_MASK;
}
/* Set duplex mode. */
if (duplex == kENET_MiiHalfDuplex)
{
rcr |= ENET_RCR_DRT_MASK;
tcr &= ~ENET_TCR_FDEN_MASK;
}
else
{
rcr &= ~ENET_RCR_DRT_MASK;
tcr |= ENET_TCR_FDEN_MASK;
}
base->RCR = rcr;
base->TCR = tcr;
}
void ENET_SetMacAddr(ENET_Type *base, uint8_t *macAddr)
{
uint32_t address;
/* Set physical address lower register. */
address = (uint32_t)(((uint32_t)macAddr[0] << 24U) | ((uint32_t)macAddr[1] << 16U) | ((uint32_t)macAddr[2] << 8U) |
(uint32_t)macAddr[3]);
base->PALR = address;
/* Set physical address high register. */
address = (uint32_t)(((uint32_t)macAddr[4] << 8U) | ((uint32_t)macAddr[5]));
base->PAUR = address << ENET_PAUR_PADDR2_SHIFT;
}
void ENET_GetMacAddr(ENET_Type *base, uint8_t *macAddr)
{
assert(macAddr);
uint32_t address;
/* Get from physical address lower register. */
address = base->PALR;
macAddr[0] = 0xFFU & (address >> 24U);
macAddr[1] = 0xFFU & (address >> 16U);
macAddr[2] = 0xFFU & (address >> 8U);
macAddr[3] = 0xFFU & address;
/* Get from physical address high register. */
address = (base->PAUR & ENET_PAUR_PADDR2_MASK) >> ENET_PAUR_PADDR2_SHIFT;
macAddr[4] = 0xFFU & (address >> 8U);
macAddr[5] = 0xFFU & address;
}
void ENET_SetSMI(ENET_Type *base, uint32_t srcClock_Hz, bool isPreambleDisabled)
{
assert(srcClock_Hz);
uint32_t clkCycle = 0;
uint32_t speed = 0;
uint32_t mscr = 0;
/* Calculate the MII speed which controls the frequency of the MDC. */
speed = srcClock_Hz / (2 * ENET_MDC_FREQUENCY);
/* Calculate the hold time on the MDIO output. */
clkCycle = (10 + ENET_NANOSECOND_ONE_SECOND / srcClock_Hz - 1) / (ENET_NANOSECOND_ONE_SECOND / srcClock_Hz) - 1;
/* Build the configuration for MDC/MDIO control. */
mscr = ENET_MSCR_MII_SPEED(speed) | ENET_MSCR_DIS_PRE(isPreambleDisabled) | ENET_MSCR_HOLDTIME(clkCycle);
base->MSCR = mscr;
}
void ENET_StartSMIWrite(ENET_Type *base, uint32_t phyAddr, uint32_t phyReg, enet_mii_write_t operation, uint32_t data)
{
uint32_t mmfr = 0;
/* Build MII write command. */
mmfr = ENET_MMFR_ST(1) | ENET_MMFR_OP(operation) | ENET_MMFR_PA(phyAddr) | ENET_MMFR_RA(phyReg) | ENET_MMFR_TA(2) |
(data & 0xFFFF);
base->MMFR = mmfr;
}
void ENET_StartSMIRead(ENET_Type *base, uint32_t phyAddr, uint32_t phyReg, enet_mii_read_t operation)
{
uint32_t mmfr = 0;
/* Build MII read command. */
mmfr = ENET_MMFR_ST(1) | ENET_MMFR_OP(operation) | ENET_MMFR_PA(phyAddr) | ENET_MMFR_RA(phyReg) | ENET_MMFR_TA(2);
base->MMFR = mmfr;
}
void ENET_GetRxErrBeforeReadFrame(enet_handle_t *handle, enet_data_error_stats_t *eErrorStatic)
{
assert(handle);
assert(handle->rxBdCurrent);
assert(eErrorStatic);
uint16_t control = 0;
volatile enet_rx_bd_struct_t *curBuffDescrip = handle->rxBdCurrent;
do
{
/* The last buffer descriptor of a frame. */
if (curBuffDescrip->control & ENET_BUFFDESCRIPTOR_RX_LAST_MASK)
{
control = curBuffDescrip->control;
if (control & ENET_BUFFDESCRIPTOR_RX_TRUNC_MASK)
{
/* The receive truncate error. */
eErrorStatic->statsRxTruncateErr++;
}
if (control & ENET_BUFFDESCRIPTOR_RX_OVERRUN_MASK)
{
/* The receive over run error. */
eErrorStatic->statsRxOverRunErr++;
}
if (control & ENET_BUFFDESCRIPTOR_RX_LENVLIOLATE_MASK)
{
/* The receive length violation error. */
eErrorStatic->statsRxLenGreaterErr++;
}
if (control & ENET_BUFFDESCRIPTOR_RX_NOOCTET_MASK)
{
/* The receive alignment error. */
eErrorStatic->statsRxAlignErr++;
}
if (control & ENET_BUFFDESCRIPTOR_RX_CRC_MASK)
{
/* The receive CRC error. */
eErrorStatic->statsRxFcsErr++;
}
#ifdef ENET_ENHANCEDBUFFERDESCRIPTOR_MODE
uint16_t controlExt = curBuffDescrip->controlExtend1;
if (controlExt & ENET_BUFFDESCRIPTOR_RX_MACERR_MASK)
{
/* The MAC error. */
eErrorStatic->statsRxMacErr++;
}
if (controlExt & ENET_BUFFDESCRIPTOR_RX_PHYERR_MASK)
{
/* The PHY error. */
eErrorStatic->statsRxPhyErr++;
}
if (controlExt & ENET_BUFFDESCRIPTOR_RX_COLLISION_MASK)
{
/* The receive collision error. */
eErrorStatic->statsRxCollisionErr++;
}
#endif /* ENET_ENHANCEDBUFFERDESCRIPTOR_MODE */
break;
}
/* Increase the buffer descriptor, if it is the last one, increase to first one of the ring buffer. */
if (curBuffDescrip->control & ENET_BUFFDESCRIPTOR_RX_WRAP_MASK)
{
curBuffDescrip = handle->rxBdBase;
}
else
{
curBuffDescrip++;
}
} while (curBuffDescrip != handle->rxBdCurrent);
}
status_t ENET_GetRxFrameSize(enet_handle_t *handle, uint32_t *length)
{
assert(handle);
assert(handle->rxBdCurrent);
assert(length);
/* Reset the length to zero. */
*length = 0;
uint16_t validLastMask = ENET_BUFFDESCRIPTOR_RX_LAST_MASK | ENET_BUFFDESCRIPTOR_RX_EMPTY_MASK;
volatile enet_rx_bd_struct_t *curBuffDescrip = handle->rxBdCurrent;
/* Check the current buffer descriptor's empty flag. if empty means there is no frame received. */
if (curBuffDescrip->control & ENET_BUFFDESCRIPTOR_RX_EMPTY_MASK)
{
return kStatus_ENET_RxFrameEmpty;
}
do
{
/* Find the last buffer descriptor. */
if ((curBuffDescrip->control & validLastMask) == ENET_BUFFDESCRIPTOR_RX_LAST_MASK)
{
/* The last buffer descriptor in the frame check the status of the received frame. */
if ((curBuffDescrip->control & ENET_BUFFDESCRIPTOR_RX_ERR_MASK)
#ifdef ENET_ENHANCEDBUFFERDESCRIPTOR_MODE
|| (curBuffDescrip->controlExtend1 & ENET_BUFFDESCRIPTOR_RX_EXT_ERR_MASK)
#endif /* ENET_ENHANCEDBUFFERDESCRIPTOR_MODE */
)
{
return kStatus_ENET_RxFrameError;
}
/* FCS is removed by MAC. */
*length = curBuffDescrip->length;
return kStatus_Success;
}
/* Increase the buffer descriptor, if it is the last one, increase to first one of the ring buffer. */
if (curBuffDescrip->control & ENET_BUFFDESCRIPTOR_RX_WRAP_MASK)
{
curBuffDescrip = handle->rxBdBase;
}
else
{
curBuffDescrip++;
}
} while (curBuffDescrip != handle->rxBdCurrent);
/* The frame is on processing - set to empty status to make application to receive it next time. */
return kStatus_ENET_RxFrameEmpty;
}
status_t ENET_ReadFrame(ENET_Type *base, enet_handle_t *handle, uint8_t *data, uint32_t length)
{
assert(handle);
assert(handle->rxBdCurrent);
uint32_t len = 0;
uint32_t offset = 0;
uint16_t control;
bool isLastBuff = false;
volatile enet_rx_bd_struct_t *curBuffDescrip = handle->rxBdCurrent;
status_t result = kStatus_Success;
/* For data-NULL input, only update the buffer descriptor. */
if (!data)
{
do
{
/* Update the control flag. */
control = handle->rxBdCurrent->control;
/* Updates the receive buffer descriptors. */
ENET_UpdateReadBuffers(base, handle);
/* Find the last buffer descriptor for the frame. */
if (control & ENET_BUFFDESCRIPTOR_RX_LAST_MASK)
{
break;
}
} while (handle->rxBdCurrent != curBuffDescrip);
return result;
}
else
{
/* A frame on one buffer or several receive buffers are both considered. */
#ifdef ENET_ENHANCEDBUFFERDESCRIPTOR_MODE
enet_ptp_time_data_t ptpTimestamp;
bool isPtpEventMessage = false;
/* Parse the PTP message according to the header message. */
isPtpEventMessage = ENET_Ptp1588ParseFrame(curBuffDescrip->buffer, &ptpTimestamp, false);
#endif /* ENET_ENHANCEDBUFFERDESCRIPTOR_MODE */
while (!isLastBuff)
{
/* The last buffer descriptor of a frame. */
if (curBuffDescrip->control & ENET_BUFFDESCRIPTOR_RX_LAST_MASK)
{
/* This is a valid frame. */
isLastBuff = true;
if (length == curBuffDescrip->length)
{
/* Copy the frame to user's buffer without FCS. */
len = curBuffDescrip->length - offset;
memcpy(data + offset, curBuffDescrip->buffer, len);
#ifdef ENET_ENHANCEDBUFFERDESCRIPTOR_MODE
/* Store the PTP 1588 timestamp for received PTP event frame. */
if (isPtpEventMessage)
{
/* Set the timestamp to the timestamp ring. */
ptpTimestamp.timeStamp.nanosecond = curBuffDescrip->timestamp;
result = ENET_StoreRxFrameTime(base, handle, &ptpTimestamp);
}
#endif /* ENET_ENHANCEDBUFFERDESCRIPTOR_MODE */
/* Updates the receive buffer descriptors. */
ENET_UpdateReadBuffers(base, handle);
return result;
}
else
{
/* Updates the receive buffer descriptors. */
ENET_UpdateReadBuffers(base, handle);
}
}
else
{
/* Store a frame on several buffer descriptors. */
isLastBuff = false;
/* Length check. */
if (offset >= length)
{
break;
}
memcpy(data + offset, curBuffDescrip->buffer, handle->rxBuffSizeAlign);
offset += handle->rxBuffSizeAlign;
/* Updates the receive buffer descriptors. */
ENET_UpdateReadBuffers(base, handle);
}
/* Get the current buffer descriptor. */
curBuffDescrip = handle->rxBdCurrent;
}
}
return kStatus_ENET_RxFrameFail;
}
static void ENET_UpdateReadBuffers(ENET_Type *base, enet_handle_t *handle)
{
assert(handle);
/* Clears status. */
handle->rxBdCurrent->control &= ENET_BUFFDESCRIPTOR_RX_WRAP_MASK;
/* Sets the receive buffer descriptor with the empty flag. */
handle->rxBdCurrent->control |= ENET_BUFFDESCRIPTOR_RX_EMPTY_MASK;
/* Increase current buffer descriptor to the next one. */
if (handle->rxBdCurrent->control & ENET_BUFFDESCRIPTOR_RX_WRAP_MASK)
{
handle->rxBdCurrent = handle->rxBdBase;
}
else
{
handle->rxBdCurrent++;
}
/* Actives the receive buffer descriptor. */
base->RDAR = ENET_RDAR_RDAR_MASK;
}
status_t ENET_SendFrame(ENET_Type *base, enet_handle_t *handle, uint8_t *data, uint32_t length)
{
assert(handle);
assert(handle->txBdCurrent);
assert(data);
assert(length <= (ENET_FRAME_MAX_VALNFRAMELEN - 4));
volatile enet_tx_bd_struct_t *curBuffDescrip = handle->txBdCurrent;
uint32_t len = 0;
uint32_t sizeleft = 0;
/* Check if the transmit buffer is ready. */
if (curBuffDescrip->control & ENET_BUFFDESCRIPTOR_TX_READY_MASK)
{
return kStatus_ENET_TxFrameBusy;
}
#ifdef ENET_ENHANCEDBUFFERDESCRIPTOR_MODE
bool isPtpEventMessage = false;
/* Check PTP message with the PTP header. */
isPtpEventMessage = ENET_Ptp1588ParseFrame(data, NULL, true);
#endif /* ENET_ENHANCEDBUFFERDESCRIPTOR_MODE */
/* One transmit buffer is enough for one frame. */
if (handle->txBuffSizeAlign >= length)
{
/* Copy data to the buffer for uDMA transfer. */
memcpy(curBuffDescrip->buffer, data, length);
/* Set data length. */
curBuffDescrip->length = length;
#ifdef ENET_ENHANCEDBUFFERDESCRIPTOR_MODE
/* For enable the timestamp. */
if (isPtpEventMessage)
{
curBuffDescrip->controlExtend1 |= ENET_BUFFDESCRIPTOR_TX_TIMESTAMP_MASK;
}
else
{
curBuffDescrip->controlExtend1 &= ~ENET_BUFFDESCRIPTOR_TX_TIMESTAMP_MASK;
}
#endif /* ENET_ENHANCEDBUFFERDESCRIPTOR_MODE */
curBuffDescrip->control |= (ENET_BUFFDESCRIPTOR_TX_READY_MASK | ENET_BUFFDESCRIPTOR_TX_LAST_MASK);
/* Increase the buffer descriptor address. */
if (curBuffDescrip->control & ENET_BUFFDESCRIPTOR_TX_WRAP_MASK)
{
handle->txBdCurrent = handle->txBdBase;
}
else
{
handle->txBdCurrent++;
}
/* Active the transmit buffer descriptor. */
base->TDAR = ENET_TDAR_TDAR_MASK;
return kStatus_Success;
}