1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /******************************************************************************
4 * (C)Copyright 1998,1999 SysKonnect,
5 * a business unit of Schneider & Koch & Co. Datensysteme GmbH.
7 * See the file "skfddi.c" for further information.
9 * The information in this file is provided "AS IS" without warranty.
11 ******************************************************************************/
14 * *******************************************************************
15 * This SBA code implements the Synchronous Bandwidth Allocation
16 * functions described in the "FDDI Synchronous Forum Implementer's
17 * Agreement" dated December 1th, 1993.
18 * *******************************************************************
20 * PURPOSE: The purpose of this function is to control
21 * synchronous allocations on a single FDDI segment.
22 * Allocations are limited to the primary FDDI ring.
23 * The SBM provides recovery mechanisms to recover
24 * unused bandwidth also resolves T_Neg and
25 * reconfiguration changes. Many of the SBM state
26 * machine inputs are sourced by the underlying
27 * FDDI sub-system supporting the SBA application.
29 * *******************************************************************
43 static const char ID_sccs
[] = "@(#)ess.c 1.10 96/02/23 (C) SK" ;
46 #define LINT_USE(x) (x)=(x)
48 #define MS2BCLK(x) ((x)*12500L)
51 -------------------------------------------------------------
53 -------------------------------------------------------------
56 static const u_short plist_raf_alc_res
[] = { SMT_P0012
, SMT_P320B
, SMT_P320F
,
57 SMT_P3210
, SMT_P0019
, SMT_P001A
,
60 static const u_short plist_raf_chg_req
[] = { SMT_P320B
, SMT_P320F
, SMT_P3210
,
63 static const struct fddi_addr smt_sba_da
= {{0x80,0x01,0x43,0x00,0x80,0x0C}} ;
64 static const struct fddi_addr null_addr
= {{0,0,0,0,0,0}} ;
67 -------------------------------------------------------------
69 -------------------------------------------------------------
74 -------------------------------------------------------------
76 -------------------------------------------------------------
79 static void ess_send_response(struct s_smc
*smc
, struct smt_header
*sm
,
81 static void ess_config_fifo(struct s_smc
*smc
);
82 static void ess_send_alc_req(struct s_smc
*smc
);
83 static void ess_send_frame(struct s_smc
*smc
, SMbuf
*mb
);
86 -------------------------------------------------------------
88 -------------------------------------------------------------
92 -------------------------------------------------------------
94 -------------------------------------------------------------
97 void ess_timer_poll(struct s_smc
*smc
);
98 void ess_para_change(struct s_smc
*smc
);
99 int ess_raf_received_pack(struct s_smc
*smc
, SMbuf
*mb
, struct smt_header
*sm
,
101 static int process_bw_alloc(struct s_smc
*smc
, long int payload
, long int overhead
);
105 * --------------------------------------------------------------------------
106 * End Station Support (ESS)
107 * --------------------------------------------------------------------------
111 * evaluate the RAF frame
113 int ess_raf_received_pack(struct s_smc
*smc
, SMbuf
*mb
, struct smt_header
*sm
,
116 void *p
; /* universal pointer */
117 struct smt_p_0016
*cmd
; /* para: command for the ESS */
119 u_long msg_res_type
; /* recource type */
120 u_long payload
, overhead
;
125 * Message Processing Code
127 local
= ((fs
& L_INDICATOR
) != 0) ;
130 * get the resource type
132 if (!(p
= (void *) sm_to_para(smc
,sm
,SMT_P0015
))) {
133 DB_ESS("ESS: RAF frame error, parameter type not found");
136 msg_res_type
= ((struct smt_p_0015
*)p
)->res_type
;
139 * get the pointer to the ESS command
141 if (!(cmd
= (struct smt_p_0016
*) sm_to_para(smc
,sm
,SMT_P0016
))) {
143 * error in frame: para ESS command was not found
145 DB_ESS("ESS: RAF frame error, parameter command not found");
149 DB_ESSN(2, "fc %x ft %x", sm
->smt_class
, sm
->smt_type
);
150 DB_ESSN(2, "ver %x tran %x", sm
->smt_version
, sm
->smt_tid
);
151 DB_ESSN(2, "stn_id %s", addr_to_string(&sm
->smt_source
));
153 DB_ESSN(2, "infolen %x res %lx", sm
->smt_len
, msg_res_type
);
154 DB_ESSN(2, "sbacmd %x", cmd
->sba_cmd
);
157 * evaluate the ESS command
159 switch (cmd
->sba_cmd
) {
162 * Process an ESS Allocation Request
164 case REQUEST_ALLOCATION
:
166 * check for an RAF Request (Allocation Request)
168 if (sm
->smt_type
== SMT_REQUEST
) {
170 * process the Allocation request only if the frame is
171 * local and no static allocation is used
173 if (!local
|| smc
->mib
.fddiESSPayload
)
176 p
= (void *) sm_to_para(smc
,sm
,SMT_P0019
) ;
177 for (i
= 0; i
< 5; i
++) {
178 if (((struct smt_p_0019
*)p
)->alloc_addr
.a
[i
]) {
184 * Note: The Application should send a LAN_LOC_FRAME.
185 * The ESS do not send the Frame to the network!
187 smc
->ess
.alloc_trans_id
= sm
->smt_tid
;
188 DB_ESS("ESS: save Alloc Req Trans ID %x", sm
->smt_tid
);
189 p
= (void *) sm_to_para(smc
,sm
,SMT_P320F
) ;
190 ((struct smt_p_320f
*)p
)->mib_payload
=
191 smc
->mib
.a
[PATH0
].fddiPATHSbaPayload
;
192 p
= (void *) sm_to_para(smc
,sm
,SMT_P3210
) ;
193 ((struct smt_p_3210
*)p
)->mib_overhead
=
194 smc
->mib
.a
[PATH0
].fddiPATHSbaOverhead
;
195 sm
->smt_dest
= smt_sba_da
;
197 if (smc
->ess
.local_sba_active
)
198 return fs
| I_INDICATOR
;
200 if (!(db
= smt_get_mbuf(smc
)))
203 db
->sm_len
= mb
->sm_len
;
204 db
->sm_off
= mb
->sm_off
;
205 memcpy(((char *)(db
->sm_data
+db
->sm_off
)),(char *)sm
,
208 (struct smt_header
*)(db
->sm_data
+db
->sm_off
),
210 smt_send_frame(smc
,db
,FC_SMT_INFO
,0) ;
215 * The RAF frame is an Allocation Response !
216 * check the parameters
218 if (smt_check_para(smc
,sm
,plist_raf_alc_res
)) {
219 DB_ESS("ESS: RAF with para problem, ignoring");
224 * VERIFY THE FRAME IS WELL BUILT:
226 * 1. path index = primary ring only
227 * 2. resource type = sync bw only
228 * 3. trans action id = alloc_trans_id
229 * 4. reason code = success
231 * If any are violated, discard the RAF frame
233 if ((((struct smt_p_320b
*)sm_to_para(smc
,sm
,SMT_P320B
))->path_index
235 (msg_res_type
!= SYNC_BW
) ||
236 (((struct smt_p_reason
*)sm_to_para(smc
,sm
,SMT_P0012
))->rdf_reason
237 != SMT_RDF_SUCCESS
) ||
238 (sm
->smt_tid
!= smc
->ess
.alloc_trans_id
)) {
240 DB_ESS("ESS: Allocation Response not accepted");
245 * Extract message parameters
247 p
= (void *) sm_to_para(smc
,sm
,SMT_P320F
) ;
249 printk(KERN_ERR
"ESS: sm_to_para failed");
252 payload
= ((struct smt_p_320f
*)p
)->mib_payload
;
253 p
= (void *) sm_to_para(smc
,sm
,SMT_P3210
) ;
255 printk(KERN_ERR
"ESS: sm_to_para failed");
258 overhead
= ((struct smt_p_3210
*)p
)->mib_overhead
;
260 DB_ESSN(2, "payload= %lx overhead= %lx",
264 * process the bandwidth allocation
266 (void)process_bw_alloc(smc
,(long)payload
,(long)overhead
) ;
269 /* end of Process Allocation Request */
272 * Process an ESS Change Request
274 case CHANGE_ALLOCATION
:
276 * except only replies
278 if (sm
->smt_type
!= SMT_REQUEST
) {
279 DB_ESS("ESS: Do not process Change Responses");
284 * check the para for the Change Request
286 if (smt_check_para(smc
,sm
,plist_raf_chg_req
)) {
287 DB_ESS("ESS: RAF with para problem, ignoring");
292 * Verify the path index and resource
293 * type are correct. If any of
294 * these are false, don't process this
295 * change request frame.
297 if ((((struct smt_p_320b
*)sm_to_para(smc
,sm
,SMT_P320B
))->path_index
298 != PRIMARY_RING
) || (msg_res_type
!= SYNC_BW
)) {
299 DB_ESS("ESS: RAF frame with para problem, ignoring");
304 * Extract message queue parameters
306 p
= (void *) sm_to_para(smc
,sm
,SMT_P320F
) ;
307 payload
= ((struct smt_p_320f
*)p
)->mib_payload
;
308 p
= (void *) sm_to_para(smc
,sm
,SMT_P3210
) ;
309 overhead
= ((struct smt_p_3210
*)p
)->mib_overhead
;
311 DB_ESSN(2, "ESS: Change Request from %s",
312 addr_to_string(&sm
->smt_source
));
313 DB_ESSN(2, "payload= %lx overhead= %lx",
317 * process the bandwidth allocation
319 if(!process_bw_alloc(smc
,(long)payload
,(long)overhead
))
323 * send an RAF Change Reply
325 ess_send_response(smc
,sm
,CHANGE_ALLOCATION
) ;
328 /* end of Process Change Request */
331 * Process Report Response
333 case REPORT_ALLOCATION
:
335 * except only requests
337 if (sm
->smt_type
!= SMT_REQUEST
) {
338 DB_ESS("ESS: Do not process a Report Reply");
342 DB_ESSN(2, "ESS: Report Request from %s",
343 addr_to_string(&sm
->smt_source
));
346 * verify that the resource type is sync bw only
348 if (msg_res_type
!= SYNC_BW
) {
349 DB_ESS("ESS: ignoring RAF with para problem");
354 * send an RAF Change Reply
356 ess_send_response(smc
,sm
,REPORT_ALLOCATION
) ;
359 /* end of Process Report Request */
365 DB_ESS("ESS: ignoring RAF with bad sba_cmd");
373 * determines the synchronous bandwidth, set the TSYNC register and the
374 * mib variables SBAPayload, SBAOverhead and fddiMACT-NEG.
376 static int process_bw_alloc(struct s_smc
*smc
, long int payload
, long int overhead
)
379 * determine the synchronous bandwidth (sync_bw) in bytes per T-NEG,
380 * if the payload is greater than zero.
381 * For the SBAPayload and the SBAOverhead we have the following
385 * SBAPayload = | 8000 ------ |
390 * SBAOverhead = | ------ |
394 * T-NEG is described by the equation:
397 * T-NEG = -------------------
400 * The number of bytes we are able to send is the payload
403 * bytes T-NEG SBAPayload 8000 bytes/s
404 * sync_bw = SBAOverhead ------ + -----------------------------
409 * sync_bw = SBAOverhead + ---- (-)fddiMACT-NEG * SBAPayload
415 * set the mib attributes fddiPATHSbaOverhead, fddiPATHSbaPayload
417 /* if (smt_set_obj(smc,SMT_P320F,payload,S_SET)) {
418 DB_ESS("ESS: SMT does not accept the payload value");
421 if (smt_set_obj(smc,SMT_P3210,overhead,S_SET)) {
422 DB_ESS("ESS: SMT does not accept the overhead value");
427 if (payload
> MAX_PAYLOAD
|| overhead
> 5000) {
428 DB_ESS("ESS: payload / overhead not accepted");
433 * start the iterative allocation process if the payload or the overhead
434 * are smaller than the parsed values
436 if (smc
->mib
.fddiESSPayload
&&
437 ((u_long
)payload
!= smc
->mib
.fddiESSPayload
||
438 (u_long
)overhead
!= smc
->mib
.fddiESSOverhead
)) {
439 smc
->ess
.raf_act_timer_poll
= TRUE
;
440 smc
->ess
.timer_count
= 0 ;
444 * evulate the Payload
447 DB_ESSN(2, "ESS: turn SMT_ST_SYNC_SERVICE bit on");
448 smc
->ess
.sync_bw_available
= TRUE
;
450 smc
->ess
.sync_bw
= overhead
-
451 (long)smc
->mib
.m
[MAC0
].fddiMACT_Neg
*
455 DB_ESSN(2, "ESS: turn SMT_ST_SYNC_SERVICE bit off");
456 smc
->ess
.sync_bw_available
= FALSE
;
457 smc
->ess
.sync_bw
= 0 ;
461 smc
->mib
.a
[PATH0
].fddiPATHSbaPayload
= payload
;
462 smc
->mib
.a
[PATH0
].fddiPATHSbaOverhead
= overhead
;
465 DB_ESSN(2, "tsync = %lx", smc
->ess
.sync_bw
);
467 ess_config_fifo(smc
) ;
468 set_formac_tsync(smc
,smc
->ess
.sync_bw
) ;
472 static void ess_send_response(struct s_smc
*smc
, struct smt_header
*sm
,
475 struct smt_sba_chg
*chg
;
480 * get and initialize the response frame
482 if (sba_cmd
== CHANGE_ALLOCATION
) {
483 if (!(mb
=smt_build_frame(smc
,SMT_RAF
,SMT_REPLY
,
484 sizeof(struct smt_sba_chg
))))
488 if (!(mb
=smt_build_frame(smc
,SMT_RAF
,SMT_REPLY
,
489 sizeof(struct smt_sba_rep_res
))))
493 chg
= smtod(mb
,struct smt_sba_chg
*) ;
494 chg
->smt
.smt_tid
= sm
->smt_tid
;
495 chg
->smt
.smt_dest
= sm
->smt_source
;
498 chg
->s_type
.para
.p_type
= SMT_P0015
;
499 chg
->s_type
.para
.p_len
= sizeof(struct smt_p_0015
) - PARA_LEN
;
500 chg
->s_type
.res_type
= SYNC_BW
;
503 chg
->cmd
.para
.p_type
= SMT_P0016
;
504 chg
->cmd
.para
.p_len
= sizeof(struct smt_p_0016
) - PARA_LEN
;
505 chg
->cmd
.sba_cmd
= sba_cmd
;
508 chg
->path
.para
.p_type
= SMT_P320B
;
509 chg
->path
.para
.p_len
= sizeof(struct smt_p_320b
) - PARA_LEN
;
510 chg
->path
.mib_index
= SBAPATHINDEX
;
511 chg
->path
.path_pad
= 0;
512 chg
->path
.path_index
= PRIMARY_RING
;
515 chg
->payload
.para
.p_type
= SMT_P320F
;
516 chg
->payload
.para
.p_len
= sizeof(struct smt_p_320f
) - PARA_LEN
;
517 chg
->payload
.mib_index
= SBAPATHINDEX
;
518 chg
->payload
.mib_payload
= smc
->mib
.a
[PATH0
].fddiPATHSbaPayload
;
521 chg
->overhead
.para
.p_type
= SMT_P3210
;
522 chg
->overhead
.para
.p_len
= sizeof(struct smt_p_3210
) - PARA_LEN
;
523 chg
->overhead
.mib_index
= SBAPATHINDEX
;
524 chg
->overhead
.mib_overhead
= smc
->mib
.a
[PATH0
].fddiPATHSbaOverhead
;
526 if (sba_cmd
== CHANGE_ALLOCATION
) {
528 chg
->cat
.para
.p_type
= SMT_P001A
;
529 chg
->cat
.para
.p_len
= sizeof(struct smt_p_001a
) - PARA_LEN
;
530 p
= (void *) sm_to_para(smc
,sm
,SMT_P001A
) ;
531 chg
->cat
.category
= ((struct smt_p_001a
*)p
)->category
;
533 dump_smt(smc
,(struct smt_header
*)chg
,"RAF") ;
534 ess_send_frame(smc
,mb
) ;
537 void ess_timer_poll(struct s_smc
*smc
)
539 if (!smc
->ess
.raf_act_timer_poll
)
542 DB_ESSN(2, "ESS: timer_poll");
544 smc
->ess
.timer_count
++ ;
545 if (smc
->ess
.timer_count
== 10) {
546 smc
->ess
.timer_count
= 0 ;
547 ess_send_alc_req(smc
) ;
551 static void ess_send_alc_req(struct s_smc
*smc
)
553 struct smt_sba_alc_req
*req
;
557 * send never allocation request where the requested payload and
558 * overhead is zero or deallocate bandwidth when no bandwidth is
561 if (!smc
->mib
.fddiESSPayload
) {
562 smc
->mib
.fddiESSOverhead
= 0 ;
565 if (!smc
->mib
.fddiESSOverhead
)
566 smc
->mib
.fddiESSOverhead
= DEFAULT_OV
;
569 if (smc
->mib
.fddiESSOverhead
==
570 smc
->mib
.a
[PATH0
].fddiPATHSbaOverhead
&&
571 smc
->mib
.fddiESSPayload
==
572 smc
->mib
.a
[PATH0
].fddiPATHSbaPayload
){
573 smc
->ess
.raf_act_timer_poll
= FALSE
;
574 smc
->ess
.timer_count
= 7 ; /* next RAF alc req after 3 s */
579 * get and initialize the response frame
581 if (!(mb
=smt_build_frame(smc
,SMT_RAF
,SMT_REQUEST
,
582 sizeof(struct smt_sba_alc_req
))))
584 req
= smtod(mb
,struct smt_sba_alc_req
*) ;
585 req
->smt
.smt_tid
= smc
->ess
.alloc_trans_id
= smt_get_tid(smc
) ;
586 req
->smt
.smt_dest
= smt_sba_da
;
589 req
->s_type
.para
.p_type
= SMT_P0015
;
590 req
->s_type
.para
.p_len
= sizeof(struct smt_p_0015
) - PARA_LEN
;
591 req
->s_type
.res_type
= SYNC_BW
;
594 req
->cmd
.para
.p_type
= SMT_P0016
;
595 req
->cmd
.para
.p_len
= sizeof(struct smt_p_0016
) - PARA_LEN
;
596 req
->cmd
.sba_cmd
= REQUEST_ALLOCATION
;
599 * set the parameter type and parameter length of all used
604 req
->path
.para
.p_type
= SMT_P320B
;
605 req
->path
.para
.p_len
= sizeof(struct smt_p_320b
) - PARA_LEN
;
606 req
->path
.mib_index
= SBAPATHINDEX
;
607 req
->path
.path_pad
= 0;
608 req
->path
.path_index
= PRIMARY_RING
;
611 req
->pl_req
.para
.p_type
= SMT_P0017
;
612 req
->pl_req
.para
.p_len
= sizeof(struct smt_p_0017
) - PARA_LEN
;
613 req
->pl_req
.sba_pl_req
= smc
->mib
.fddiESSPayload
-
614 smc
->mib
.a
[PATH0
].fddiPATHSbaPayload
;
617 req
->ov_req
.para
.p_type
= SMT_P0018
;
618 req
->ov_req
.para
.p_len
= sizeof(struct smt_p_0018
) - PARA_LEN
;
619 req
->ov_req
.sba_ov_req
= smc
->mib
.fddiESSOverhead
-
620 smc
->mib
.a
[PATH0
].fddiPATHSbaOverhead
;
623 req
->payload
.para
.p_type
= SMT_P320F
;
624 req
->payload
.para
.p_len
= sizeof(struct smt_p_320f
) - PARA_LEN
;
625 req
->payload
.mib_index
= SBAPATHINDEX
;
626 req
->payload
.mib_payload
= smc
->mib
.a
[PATH0
].fddiPATHSbaPayload
;
629 req
->overhead
.para
.p_type
= SMT_P3210
;
630 req
->overhead
.para
.p_len
= sizeof(struct smt_p_3210
) - PARA_LEN
;
631 req
->overhead
.mib_index
= SBAPATHINDEX
;
632 req
->overhead
.mib_overhead
= smc
->mib
.a
[PATH0
].fddiPATHSbaOverhead
;
635 req
->a_addr
.para
.p_type
= SMT_P0019
;
636 req
->a_addr
.para
.p_len
= sizeof(struct smt_p_0019
) - PARA_LEN
;
637 req
->a_addr
.sba_pad
= 0;
638 req
->a_addr
.alloc_addr
= null_addr
;
641 req
->cat
.para
.p_type
= SMT_P001A
;
642 req
->cat
.para
.p_len
= sizeof(struct smt_p_001a
) - PARA_LEN
;
643 req
->cat
.category
= smc
->mib
.fddiESSCategory
;
646 req
->tneg
.para
.p_type
= SMT_P001B
;
647 req
->tneg
.para
.p_len
= sizeof(struct smt_p_001b
) - PARA_LEN
;
648 req
->tneg
.max_t_neg
= smc
->mib
.fddiESSMaxTNeg
;
651 req
->segm
.para
.p_type
= SMT_P001C
;
652 req
->segm
.para
.p_len
= sizeof(struct smt_p_001c
) - PARA_LEN
;
653 req
->segm
.min_seg_siz
= smc
->mib
.fddiESSMinSegmentSize
;
655 dump_smt(smc
,(struct smt_header
*)req
,"RAF") ;
656 ess_send_frame(smc
,mb
) ;
659 static void ess_send_frame(struct s_smc
*smc
, SMbuf
*mb
)
662 * check if the frame must be send to the own ESS
664 if (smc
->ess
.local_sba_active
) {
666 * Send the Change Reply to the local SBA
668 DB_ESS("ESS:Send to the local SBA");
669 if (!smc
->ess
.sba_reply_pend
)
670 smc
->ess
.sba_reply_pend
= mb
;
672 DB_ESS("Frame is lost - another frame was pending");
673 smt_free_mbuf(smc
,mb
) ;
678 * Send the SBA RAF Change Reply to the network
680 DB_ESS("ESS:Send to the network");
681 smt_send_frame(smc
,mb
,FC_SMT_INFO
,0) ;
685 void ess_para_change(struct s_smc
*smc
)
687 (void)process_bw_alloc(smc
,(long)smc
->mib
.a
[PATH0
].fddiPATHSbaPayload
,
688 (long)smc
->mib
.a
[PATH0
].fddiPATHSbaOverhead
) ;
691 static void ess_config_fifo(struct s_smc
*smc
)
694 * if nothing to do exit
696 if (smc
->mib
.a
[PATH0
].fddiPATHSbaPayload
) {
697 if (smc
->hw
.fp
.fifo
.fifo_config_mode
& SYNC_TRAFFIC_ON
&&
698 (smc
->hw
.fp
.fifo
.fifo_config_mode
&SEND_ASYNC_AS_SYNC
) ==
699 smc
->mib
.fddiESSSynchTxMode
) {
704 if (!(smc
->hw
.fp
.fifo
.fifo_config_mode
& SYNC_TRAFFIC_ON
)) {
710 * split up the FIFO and reinitialize the queues
712 formac_reinit_tx(smc
) ;
717 #endif /* no SLIM_SMT */