1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2019-2021 Broadcom
8 #include <rte_common.h>
10 #include "tf_session.h"
11 #include "tf_common.h"
16 struct tf_session_client_create_parms {
18 * [in] Pointer to the control channel name string
23 * [out] Firmware Session Client ID
25 union tf_session_client_id *session_client_id;
28 struct tf_session_client_destroy_parms {
30 * FW Session Client Identifier
32 union tf_session_client_id session_client_id;
36 * Creates a Session and the associated client.
39 * Pointer to TF handle
42 * Pointer to session client create parameters
45 * - (0) if successful.
46 * - (-EINVAL) on failure.
47 * - (-ENOMEM) if max session clients has been reached.
50 tf_session_create(struct tf *tfp,
51 struct tf_session_open_session_parms *parms)
54 struct tf_session *session = NULL;
55 struct tf_session_client *client;
56 struct tfp_calloc_parms cparms;
57 uint8_t fw_session_id;
58 uint8_t fw_session_client_id;
59 union tf_session_id *session_id;
60 struct tf_dev_info dev;
61 bool shared_session_creator;
65 TF_CHECK_PARMS2(tfp, parms);
67 tf_dev_bind_ops(parms->open_cfg->device_type,
70 /* Open FW session and get a new session_id */
71 rc = tf_msg_session_open(parms->open_cfg->bp,
72 parms->open_cfg->ctrl_chan_name,
74 &fw_session_client_id,
76 &shared_session_creator);
81 "Session is already open, rc:%s\n",
85 "Open message send failed, rc:%s\n",
88 parms->open_cfg->session_id.id = TF_FW_SESSION_ID_INVALID;
92 /* Allocate session */
94 cparms.size = sizeof(struct tf_session_info);
96 rc = tfp_calloc(&cparms);
100 "Failed to allocate session info, rc:%s\n",
104 tfp->session = (struct tf_session_info *)cparms.mem_va;
106 /* Allocate core data for the session */
108 cparms.size = sizeof(struct tf_session);
109 cparms.alignment = 0;
110 rc = tfp_calloc(&cparms);
114 "Failed to allocate session data, rc:%s\n",
118 tfp->session->core_data = cparms.mem_va;
119 session_id = &parms->open_cfg->session_id;
121 /* Update Session Info, which is what is visible to the caller */
122 tfp->session->ver.major = 0;
123 tfp->session->ver.minor = 0;
124 tfp->session->ver.update = 0;
126 tfp->session->session_id.internal.domain = session_id->internal.domain;
127 tfp->session->session_id.internal.bus = session_id->internal.bus;
128 tfp->session->session_id.internal.device = session_id->internal.device;
129 tfp->session->session_id.internal.fw_session_id = fw_session_id;
131 /* Initialize Session and Device, which is private */
132 session = (struct tf_session *)tfp->session->core_data;
133 session->ver.major = 0;
134 session->ver.minor = 0;
135 session->ver.update = 0;
137 session->session_id.internal.domain = session_id->internal.domain;
138 session->session_id.internal.bus = session_id->internal.bus;
139 session->session_id.internal.device = session_id->internal.device;
140 session->session_id.internal.fw_session_id = fw_session_id;
141 /* Return the allocated session id */
142 session_id->id = session->session_id.id;
144 session->shadow_copy = parms->open_cfg->shadow_copy;
146 /* Init session client list */
147 ll_init(&session->client_ll);
149 /* Create the local session client, initialize and attach to
153 cparms.size = sizeof(struct tf_session_client);
154 cparms.alignment = 0;
155 rc = tfp_calloc(&cparms);
159 "Failed to allocate session client, rc:%s\n",
163 client = cparms.mem_va;
165 /* Register FID with the client */
166 rc = tfp_get_fid(tfp, &client->fw_fid);
170 client->session_client_id.internal.fw_session_id = fw_session_id;
171 client->session_client_id.internal.fw_session_client_id =
172 fw_session_client_id;
174 tfp_memcpy(client->ctrl_chan_name,
175 parms->open_cfg->ctrl_chan_name,
176 TF_SESSION_NAME_MAX);
178 ll_insert(&session->client_ll, &client->ll_entry);
179 session->ref_count++;
181 /* Init session em_ext_db */
182 session->em_ext_db_handle = NULL;
184 /* Populate the request */
185 name_len = strnlen(parms->open_cfg->ctrl_chan_name,
186 TF_SESSION_NAME_MAX);
187 name = &parms->open_cfg->ctrl_chan_name[name_len - strlen("tf_shared")];
188 if (!strncmp(name, "tf_shared", strlen("tf_shared")))
189 session->shared_session = true;
191 if (session->shared_session && shared_session_creator) {
192 session->shared_session_creator = true;
193 parms->open_cfg->shared_session_creator = true;
196 rc = tf_dev_bind(tfp,
197 parms->open_cfg->device_type,
198 session->shadow_copy,
199 &parms->open_cfg->resources,
202 /* Logging handled by dev_bind */
206 if (session->dev.ops->tf_dev_get_mailbox == NULL) {
209 "No tf_dev_get_mailbox() defined for device\n");
213 session->dev_init = true;
218 rc = tf_msg_session_close(tfp,
220 dev.ops->tf_dev_get_mailbox());
224 "FW Session close failed, rc:%s\n",
228 tfp_free(tfp->session->core_data);
229 tfp_free(tfp->session);
235 * Creates a Session Client on an existing Session.
238 * Pointer to TF handle
241 * Pointer to session client create parameters
244 * - (0) if successful.
245 * - (-EINVAL) on failure.
246 * - (-ENOMEM) if max session clients has been reached.
249 tf_session_client_create(struct tf *tfp,
250 struct tf_session_client_create_parms *parms)
253 struct tf_session *session = NULL;
254 struct tf_session_client *client;
255 struct tfp_calloc_parms cparms;
256 union tf_session_client_id session_client_id;
258 TF_CHECK_PARMS2(tfp, parms);
260 /* Using internal version as session client may not exist yet */
261 rc = tf_session_get_session_internal(tfp, &session);
264 "Failed to lookup session, rc:%s\n",
269 client = tf_session_find_session_client_by_name(session,
270 parms->ctrl_chan_name);
273 "Client %s, already registered with this session\n",
274 parms->ctrl_chan_name);
278 rc = tf_msg_session_client_register
281 parms->ctrl_chan_name,
282 &session_client_id.internal.fw_session_client_id);
285 "Failed to create client on session, rc:%s\n",
290 /* Create the local session client, initialize and attach to
294 cparms.size = sizeof(struct tf_session_client);
295 cparms.alignment = 0;
296 rc = tfp_calloc(&cparms);
299 "Failed to allocate session client, rc:%s\n",
303 client = cparms.mem_va;
305 /* Register FID with the client */
306 rc = tfp_get_fid(tfp, &client->fw_fid);
310 /* Build the Session Client ID by adding the fw_session_id */
311 rc = tf_session_get_fw_session_id
313 &session_client_id.internal.fw_session_id);
316 "Session Firmware id lookup failed, rc:%s\n",
321 tfp_memcpy(client->ctrl_chan_name,
322 parms->ctrl_chan_name,
323 TF_SESSION_NAME_MAX);
325 client->session_client_id.id = session_client_id.id;
327 ll_insert(&session->client_ll, &client->ll_entry);
329 session->ref_count++;
331 /* Build the return value */
332 parms->session_client_id->id = session_client_id.id;
335 /* TBD - Add code to unregister newly create client from fw */
342 * Destroys a Session Client on an existing Session.
345 * Pointer to TF handle
348 * Pointer to the session client destroy parameters
351 * - (0) if successful.
352 * - (-EINVAL) on failure.
353 * - (-ENOTFOUND) error, client not owned by the session.
354 * - (-ENOTSUPP) error, unable to destroy client as its the last
355 * client. Please use the tf_session_close().
358 tf_session_client_destroy(struct tf *tfp,
359 struct tf_session_client_destroy_parms *parms)
362 struct tf_session *tfs;
363 struct tf_session_client *client;
365 TF_CHECK_PARMS2(tfp, parms);
367 rc = tf_session_get_session(tfp, &tfs);
370 "Failed to lookup session, rc:%s\n",
375 /* Check session owns this client and that we're not the last client */
376 client = tf_session_get_session_client(tfs,
377 parms->session_client_id);
378 if (client == NULL) {
380 "Client %d, not found within this session\n",
381 parms->session_client_id.id);
385 /* If last client the request is rejected and cleanup should
386 * be done by session close.
388 if (tfs->ref_count == 1)
391 rc = tf_msg_session_client_unregister
394 parms->session_client_id.internal.fw_session_client_id);
396 /* Log error, but continue. If FW fails we do not really have
397 * a way to fix this but the client would no longer be valid
398 * thus we remove from the session.
402 "Client destroy on FW Failed, rc:%s\n",
406 ll_delete(&tfs->client_ll, &client->ll_entry);
408 /* Decrement the session ref_count */
417 tf_session_open_session(struct tf *tfp,
418 struct tf_session_open_session_parms *parms)
421 struct tf_session_client_create_parms scparms;
423 TF_CHECK_PARMS3(tfp, parms, parms->open_cfg->bp);
425 tfp->bp = parms->open_cfg->bp;
426 /* Decide if we're creating a new session or session client */
427 if (tfp->session == NULL) {
428 rc = tf_session_create(tfp, parms);
431 "Failed to create session, ctrl_chan_name:%s, rc:%s\n",
432 parms->open_cfg->ctrl_chan_name,
438 "Session created, session_client_id:%d,"
439 "session_id:0x%08x, fw_session_id:%d\n",
440 parms->open_cfg->session_client_id.id,
441 parms->open_cfg->session_id.id,
442 parms->open_cfg->session_id.internal.fw_session_id);
444 scparms.ctrl_chan_name = parms->open_cfg->ctrl_chan_name;
445 scparms.session_client_id = &parms->open_cfg->session_client_id;
447 /* Create the new client and get it associated with
450 rc = tf_session_client_create(tfp, &scparms);
453 "Failed to create client on session 0x%x, rc:%s\n",
454 parms->open_cfg->session_id.id,
460 "Session Client:%d registered on session:0x%8x\n",
461 scparms.session_client_id->internal.fw_session_client_id,
462 tfp->session->session_id.id);
469 tf_session_attach_session(struct tf *tfp __rte_unused,
470 struct tf_session_attach_session_parms *parms __rte_unused)
472 int rc = -EOPNOTSUPP;
474 TF_CHECK_PARMS2(tfp, parms);
477 "Attach not yet supported, rc:%s\n",
483 tf_session_close_session(struct tf *tfp,
484 struct tf_session_close_session_parms *parms)
487 struct tf_session *tfs = NULL;
488 struct tf_session_client *client;
489 struct tf_dev_info *tfd = NULL;
490 struct tf_session_client_destroy_parms scdparms;
492 uint8_t fw_session_id = 1;
495 TF_CHECK_PARMS2(tfp, parms);
497 rc = tf_session_get_session(tfp, &tfs);
500 "Session lookup failed, rc:%s\n",
505 if (tfs->session_id.id == TF_SESSION_ID_INVALID) {
508 "Invalid session id, unable to close, rc:%s\n",
513 /* Get the client, we need it independently of the closure
514 * type (client or session closure).
516 * We find the client by way of the fid. Thus one cannot close
517 * a client on behalf of someone else.
519 rc = tfp_get_fid(tfp, &fid);
523 client = tf_session_find_session_client_by_fid(tfs,
528 "Client not part of the session, unable to close, rc:%s\n",
533 /* In case multiple clients we chose to close those first */
534 if (tfs->ref_count > 1) {
535 /* Linaro gcc can't static init this structure */
538 sizeof(struct tf_session_client_destroy_parms));
540 scdparms.session_client_id = client->session_client_id;
541 /* Destroy requested client so its no longer
542 * registered with this session.
544 rc = tf_session_client_destroy(tfp, &scdparms);
547 "Failed to unregister Client %d, rc:%s\n",
548 client->session_client_id.id,
554 "Closed session client, session_client_id:%d\n",
555 client->session_client_id.id);
558 "session_id:0x%08x, ref_count:%d\n",
565 /* Record the session we're closing so the caller knows the
568 *parms->session_id = tfs->session_id;
570 rc = tf_session_get_device(tfs, &tfd);
573 "Device lookup failed, rc:%s\n",
578 mailbox = tfd->ops->tf_dev_get_mailbox();
580 rc = tf_session_get_fw_session_id(tfp, &fw_session_id);
583 "Unable to lookup FW id, rc:%s\n",
588 /* Unbind the device */
589 rc = tf_dev_unbind(tfp, tfd);
593 "Device unbind failed, rc:%s\n",
597 rc = tf_msg_session_close(tfp, fw_session_id, mailbox);
601 "FW Session close failed, rc:%s\n",
605 /* Final cleanup as we're last user of the session thus we
606 * also delete the last client.
608 ll_delete(&tfs->client_ll, &client->ll_entry);
614 "Closed session, session_id:0x%08x, ref_count:%d\n",
618 tfs->dev_init = false;
620 tfp_free(tfp->session->core_data);
621 tfp_free(tfp->session);
628 tf_session_is_fid_supported(struct tf_session *tfs,
631 struct ll_entry *c_entry;
632 struct tf_session_client *client;
634 for (c_entry = tfs->client_ll.head;
636 c_entry = c_entry->next) {
637 client = (struct tf_session_client *)c_entry;
638 if (client->fw_fid == fid)
646 tf_session_get_session_internal(struct tf *tfp,
647 struct tf_session **tfs)
651 /* Skip using the check macro as we want to control the error msg */
652 if (tfp->session == NULL || tfp->session->core_data == NULL) {
655 "Session not created, rc:%s\n",
660 *tfs = (struct tf_session *)(tfp->session->core_data);
666 tf_session_get_session(struct tf *tfp,
667 struct tf_session **tfs)
671 bool supported = false;
673 rc = tf_session_get_session_internal(tfp,
675 /* Logging done by tf_session_get_session_internal */
679 /* As session sharing among functions aka 'individual clients'
680 * is supported we have to assure that the client is indeed
681 * registered before we get deep in the TruFlow api stack.
683 rc = tfp_get_fid(tfp, &fw_fid);
686 "Internal FID lookup\n, rc:%s\n",
691 supported = tf_session_is_fid_supported(*tfs, fw_fid);
695 "Ctrl channel not registered with session\n, rc:%s\n",
703 struct tf_session_client *
704 tf_session_get_session_client(struct tf_session *tfs,
705 union tf_session_client_id session_client_id)
707 struct ll_entry *c_entry;
708 struct tf_session_client *client;
710 /* Skip using the check macro as we just want to return */
714 for (c_entry = tfs->client_ll.head;
716 c_entry = c_entry->next) {
717 client = (struct tf_session_client *)c_entry;
718 if (client->session_client_id.id == session_client_id.id)
725 struct tf_session_client *
726 tf_session_find_session_client_by_name(struct tf_session *tfs,
727 const char *ctrl_chan_name)
729 struct ll_entry *c_entry;
730 struct tf_session_client *client;
732 /* Skip using the check macro as we just want to return */
733 if (tfs == NULL || ctrl_chan_name == NULL)
736 for (c_entry = tfs->client_ll.head;
738 c_entry = c_entry->next) {
739 client = (struct tf_session_client *)c_entry;
740 if (strncmp(client->ctrl_chan_name,
742 TF_SESSION_NAME_MAX) == 0)
749 struct tf_session_client *
750 tf_session_find_session_client_by_fid(struct tf_session *tfs,
753 struct ll_entry *c_entry;
754 struct tf_session_client *client;
756 /* Skip using the check macro as we just want to return */
760 for (c_entry = tfs->client_ll.head;
762 c_entry = c_entry->next) {
763 client = (struct tf_session_client *)c_entry;
764 if (client->fw_fid == fid)
772 tf_session_get_device(struct tf_session *tfs,
773 struct tf_dev_info **tfd)
781 tf_session_get_fw_session_id(struct tf *tfp,
782 uint8_t *fw_session_id)
785 struct tf_session *tfs = NULL;
787 /* Skip using the check macro as we want to control the error msg */
788 if (tfp->session == NULL) {
791 "Session not created, rc:%s\n",
796 if (fw_session_id == NULL) {
799 "Invalid Argument(s), rc:%s\n",
804 rc = tf_session_get_session_internal(tfp, &tfs);
808 *fw_session_id = tfs->session_id.internal.fw_session_id;
814 tf_session_get_session_id(struct tf *tfp,
815 union tf_session_id *session_id)
818 struct tf_session *tfs = NULL;
820 if (tfp->session == NULL) {
823 "Session not created, rc:%s\n",
828 if (session_id == NULL) {
831 "Invalid Argument(s), rc:%s\n",
836 /* Using internal version as session client may not exist yet */
837 rc = tf_session_get_session_internal(tfp, &tfs);
841 *session_id = tfs->session_id;
847 tf_session_get_em_ext_db(struct tf *tfp,
848 void **em_ext_db_handle)
850 struct tf_session *tfs = NULL;
853 *em_ext_db_handle = NULL;
858 rc = tf_session_get_session_internal(tfp, &tfs);
862 *em_ext_db_handle = tfs->em_ext_db_handle;
867 tf_session_set_em_ext_db(struct tf *tfp,
868 void *em_ext_db_handle)
870 struct tf_session *tfs = NULL;
876 rc = tf_session_get_session_internal(tfp, &tfs);
880 tfs->em_ext_db_handle = em_ext_db_handle;
885 tf_session_get_db(struct tf *tfp,
886 enum tf_module_type type,
889 struct tf_session *tfs = NULL;
897 rc = tf_session_get_session_internal(tfp, &tfs);
902 case TF_MODULE_TYPE_IDENTIFIER:
903 if (tfs->id_db_handle)
904 *db_handle = tfs->id_db_handle;
908 case TF_MODULE_TYPE_TABLE:
909 if (tfs->tbl_db_handle)
910 *db_handle = tfs->tbl_db_handle;
915 case TF_MODULE_TYPE_TCAM:
916 if (tfs->tcam_db_handle)
917 *db_handle = tfs->tcam_db_handle;
921 case TF_MODULE_TYPE_EM:
922 if (tfs->em_db_handle)
923 *db_handle = tfs->em_db_handle;
936 tf_session_set_db(struct tf *tfp,
937 enum tf_module_type type,
940 struct tf_session *tfs = NULL;
946 rc = tf_session_get_session_internal(tfp, &tfs);
951 case TF_MODULE_TYPE_IDENTIFIER:
952 tfs->id_db_handle = db_handle;
954 case TF_MODULE_TYPE_TABLE:
955 tfs->tbl_db_handle = db_handle;
957 case TF_MODULE_TYPE_TCAM:
958 tfs->tcam_db_handle = db_handle;
960 case TF_MODULE_TYPE_EM:
961 tfs->em_db_handle = db_handle;
971 #ifdef TF_TCAM_SHARED
974 tf_session_get_tcam_shared_db(struct tf *tfp,
975 void **tcam_shared_db_handle)
977 struct tf_session *tfs = NULL;
980 *tcam_shared_db_handle = NULL;
985 rc = tf_session_get_session_internal(tfp, &tfs);
989 *tcam_shared_db_handle = tfs->tcam_shared_db_handle;
994 tf_session_set_tcam_shared_db(struct tf *tfp,
995 void *tcam_shared_db_handle)
997 struct tf_session *tfs = NULL;
1003 rc = tf_session_get_session_internal(tfp, &tfs);
1007 tfs->tcam_shared_db_handle = tcam_shared_db_handle;
1010 #endif /* TF_TCAM_SHARED */