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 tfp_free(tfp->session->core_data);
219 tfp_free(tfp->session);
225 * Creates a Session Client on an existing Session.
228 * Pointer to TF handle
231 * Pointer to session client create parameters
234 * - (0) if successful.
235 * - (-EINVAL) on failure.
236 * - (-ENOMEM) if max session clients has been reached.
239 tf_session_client_create(struct tf *tfp,
240 struct tf_session_client_create_parms *parms)
243 struct tf_session *session = NULL;
244 struct tf_session_client *client;
245 struct tfp_calloc_parms cparms;
246 union tf_session_client_id session_client_id;
248 TF_CHECK_PARMS2(tfp, parms);
250 /* Using internal version as session client may not exist yet */
251 rc = tf_session_get_session_internal(tfp, &session);
254 "Failed to lookup session, rc:%s\n",
259 client = tf_session_find_session_client_by_name(session,
260 parms->ctrl_chan_name);
263 "Client %s, already registered with this session\n",
264 parms->ctrl_chan_name);
268 rc = tf_msg_session_client_register
271 parms->ctrl_chan_name,
272 &session_client_id.internal.fw_session_client_id);
275 "Failed to create client on session, rc:%s\n",
280 /* Create the local session client, initialize and attach to
284 cparms.size = sizeof(struct tf_session_client);
285 cparms.alignment = 0;
286 rc = tfp_calloc(&cparms);
289 "Failed to allocate session client, rc:%s\n",
293 client = cparms.mem_va;
295 /* Register FID with the client */
296 rc = tfp_get_fid(tfp, &client->fw_fid);
300 /* Build the Session Client ID by adding the fw_session_id */
301 rc = tf_session_get_fw_session_id
303 &session_client_id.internal.fw_session_id);
306 "Session Firmware id lookup failed, rc:%s\n",
311 tfp_memcpy(client->ctrl_chan_name,
312 parms->ctrl_chan_name,
313 TF_SESSION_NAME_MAX);
315 client->session_client_id.id = session_client_id.id;
317 ll_insert(&session->client_ll, &client->ll_entry);
319 session->ref_count++;
321 /* Build the return value */
322 parms->session_client_id->id = session_client_id.id;
325 /* TBD - Add code to unregister newly create client from fw */
332 * Destroys a Session Client on an existing Session.
335 * Pointer to TF handle
338 * Pointer to the session client destroy parameters
341 * - (0) if successful.
342 * - (-EINVAL) on failure.
343 * - (-ENOTFOUND) error, client not owned by the session.
344 * - (-ENOTSUPP) error, unable to destroy client as its the last
345 * client. Please use the tf_session_close().
348 tf_session_client_destroy(struct tf *tfp,
349 struct tf_session_client_destroy_parms *parms)
352 struct tf_session *tfs;
353 struct tf_session_client *client;
355 TF_CHECK_PARMS2(tfp, parms);
357 rc = tf_session_get_session(tfp, &tfs);
360 "Failed to lookup session, rc:%s\n",
365 /* Check session owns this client and that we're not the last client */
366 client = tf_session_get_session_client(tfs,
367 parms->session_client_id);
368 if (client == NULL) {
370 "Client %d, not found within this session\n",
371 parms->session_client_id.id);
375 /* If last client the request is rejected and cleanup should
376 * be done by session close.
378 if (tfs->ref_count == 1)
381 rc = tf_msg_session_client_unregister
384 parms->session_client_id.internal.fw_session_client_id);
386 /* Log error, but continue. If FW fails we do not really have
387 * a way to fix this but the client would no longer be valid
388 * thus we remove from the session.
392 "Client destroy on FW Failed, rc:%s\n",
396 ll_delete(&tfs->client_ll, &client->ll_entry);
398 /* Decrement the session ref_count */
407 tf_session_open_session(struct tf *tfp,
408 struct tf_session_open_session_parms *parms)
411 struct tf_session_client_create_parms scparms;
413 TF_CHECK_PARMS3(tfp, parms, parms->open_cfg->bp);
415 tfp->bp = parms->open_cfg->bp;
416 /* Decide if we're creating a new session or session client */
417 if (tfp->session == NULL) {
418 rc = tf_session_create(tfp, parms);
421 "Failed to create session, ctrl_chan_name:%s, rc:%s\n",
422 parms->open_cfg->ctrl_chan_name,
428 "Session created, session_client_id:%d, session_id:%d\n",
429 parms->open_cfg->session_client_id.id,
430 parms->open_cfg->session_id.id);
432 scparms.ctrl_chan_name = parms->open_cfg->ctrl_chan_name;
433 scparms.session_client_id = &parms->open_cfg->session_client_id;
435 /* Create the new client and get it associated with
438 rc = tf_session_client_create(tfp, &scparms);
441 "Failed to create client on session %d, rc:%s\n",
442 parms->open_cfg->session_id.id,
448 "Session Client:%d created on session:%d\n",
449 parms->open_cfg->session_client_id.id,
450 parms->open_cfg->session_id.id);
457 tf_session_attach_session(struct tf *tfp __rte_unused,
458 struct tf_session_attach_session_parms *parms __rte_unused)
460 int rc = -EOPNOTSUPP;
462 TF_CHECK_PARMS2(tfp, parms);
465 "Attach not yet supported, rc:%s\n",
471 tf_session_close_session(struct tf *tfp,
472 struct tf_session_close_session_parms *parms)
475 struct tf_session *tfs = NULL;
476 struct tf_session_client *client;
477 struct tf_dev_info *tfd = NULL;
478 struct tf_session_client_destroy_parms scdparms;
481 TF_CHECK_PARMS2(tfp, parms);
483 rc = tf_session_get_session(tfp, &tfs);
486 "Session lookup failed, rc:%s\n",
491 if (tfs->session_id.id == TF_SESSION_ID_INVALID) {
494 "Invalid session id, unable to close, rc:%s\n",
499 /* Get the client, we need it independently of the closure
500 * type (client or session closure).
502 * We find the client by way of the fid. Thus one cannot close
503 * a client on behalf of someone else.
505 rc = tfp_get_fid(tfp, &fid);
509 client = tf_session_find_session_client_by_fid(tfs,
514 "Client not part of the session, unable to close, rc:%s\n",
519 /* In case multiple clients we chose to close those first */
520 if (tfs->ref_count > 1) {
521 /* Linaro gcc can't static init this structure */
524 sizeof(struct tf_session_client_destroy_parms));
526 scdparms.session_client_id = client->session_client_id;
527 /* Destroy requested client so its no longer
528 * registered with this session.
530 rc = tf_session_client_destroy(tfp, &scdparms);
533 "Failed to unregister Client %d, rc:%s\n",
534 client->session_client_id.id,
540 "Closed session client, session_client_id:%d\n",
541 client->session_client_id.id);
544 "session_id:%d, ref_count:%d\n",
551 /* Record the session we're closing so the caller knows the
554 *parms->session_id = tfs->session_id;
556 rc = tf_session_get_device(tfs, &tfd);
559 "Device lookup failed, rc:%s\n",
564 /* Unbind the device */
565 rc = tf_dev_unbind(tfp, tfd);
569 "Device unbind failed, rc:%s\n",
573 rc = tf_msg_session_close(tfp, tfs);
577 "FW Session close failed, rc:%s\n",
581 /* Final cleanup as we're last user of the session thus we
582 * also delete the last client.
584 ll_delete(&tfs->client_ll, &client->ll_entry);
590 "Closed session, session_id:%d, ref_count:%d\n",
594 tfs->dev_init = false;
596 tfp_free(tfp->session->core_data);
597 tfp_free(tfp->session);
604 tf_session_is_fid_supported(struct tf_session *tfs,
607 struct ll_entry *c_entry;
608 struct tf_session_client *client;
610 for (c_entry = tfs->client_ll.head;
612 c_entry = c_entry->next) {
613 client = (struct tf_session_client *)c_entry;
614 if (client->fw_fid == fid)
622 tf_session_get_session_internal(struct tf *tfp,
623 struct tf_session **tfs)
627 /* Skip using the check macro as we want to control the error msg */
628 if (tfp->session == NULL || tfp->session->core_data == NULL) {
631 "Session not created, rc:%s\n",
636 *tfs = (struct tf_session *)(tfp->session->core_data);
642 tf_session_get_session(struct tf *tfp,
643 struct tf_session **tfs)
647 bool supported = false;
649 rc = tf_session_get_session_internal(tfp,
651 /* Logging done by tf_session_get_session_internal */
655 /* As session sharing among functions aka 'individual clients'
656 * is supported we have to assure that the client is indeed
657 * registered before we get deep in the TruFlow api stack.
659 rc = tfp_get_fid(tfp, &fw_fid);
662 "Internal FID lookup\n, rc:%s\n",
667 supported = tf_session_is_fid_supported(*tfs, fw_fid);
671 "Ctrl channel not registered with session\n, rc:%s\n",
679 struct tf_session_client *
680 tf_session_get_session_client(struct tf_session *tfs,
681 union tf_session_client_id session_client_id)
683 struct ll_entry *c_entry;
684 struct tf_session_client *client;
686 /* Skip using the check macro as we just want to return */
690 for (c_entry = tfs->client_ll.head;
692 c_entry = c_entry->next) {
693 client = (struct tf_session_client *)c_entry;
694 if (client->session_client_id.id == session_client_id.id)
701 struct tf_session_client *
702 tf_session_find_session_client_by_name(struct tf_session *tfs,
703 const char *ctrl_chan_name)
705 struct ll_entry *c_entry;
706 struct tf_session_client *client;
708 /* Skip using the check macro as we just want to return */
709 if (tfs == NULL || ctrl_chan_name == NULL)
712 for (c_entry = tfs->client_ll.head;
714 c_entry = c_entry->next) {
715 client = (struct tf_session_client *)c_entry;
716 if (strncmp(client->ctrl_chan_name,
718 TF_SESSION_NAME_MAX) == 0)
725 struct tf_session_client *
726 tf_session_find_session_client_by_fid(struct tf_session *tfs,
729 struct ll_entry *c_entry;
730 struct tf_session_client *client;
732 /* Skip using the check macro as we just want to return */
736 for (c_entry = tfs->client_ll.head;
738 c_entry = c_entry->next) {
739 client = (struct tf_session_client *)c_entry;
740 if (client->fw_fid == fid)
748 tf_session_get_device(struct tf_session *tfs,
749 struct tf_dev_info **tfd)
757 tf_session_get_fw_session_id(struct tf *tfp,
758 uint8_t *fw_session_id)
761 struct tf_session *tfs = NULL;
763 /* Skip using the check macro as we want to control the error msg */
764 if (tfp->session == NULL) {
767 "Session not created, rc:%s\n",
772 if (fw_session_id == NULL) {
775 "Invalid Argument(s), rc:%s\n",
780 rc = tf_session_get_session_internal(tfp, &tfs);
784 *fw_session_id = tfs->session_id.internal.fw_session_id;
790 tf_session_get_session_id(struct tf *tfp,
791 union tf_session_id *session_id)
794 struct tf_session *tfs = NULL;
796 if (tfp->session == NULL) {
799 "Session not created, rc:%s\n",
804 if (session_id == NULL) {
807 "Invalid Argument(s), rc:%s\n",
812 /* Using internal version as session client may not exist yet */
813 rc = tf_session_get_session_internal(tfp, &tfs);
817 *session_id = tfs->session_id;
823 tf_session_get_em_ext_db(struct tf *tfp,
824 void **em_ext_db_handle)
826 struct tf_session *tfs = NULL;
829 *em_ext_db_handle = NULL;
834 rc = tf_session_get_session_internal(tfp, &tfs);
838 *em_ext_db_handle = tfs->em_ext_db_handle;
843 tf_session_set_em_ext_db(struct tf *tfp,
844 void *em_ext_db_handle)
846 struct tf_session *tfs = NULL;
852 rc = tf_session_get_session_internal(tfp, &tfs);
856 tfs->em_ext_db_handle = em_ext_db_handle;
861 tf_session_get_db(struct tf *tfp,
862 enum tf_module_type type,
865 struct tf_session *tfs = NULL;
873 rc = tf_session_get_session_internal(tfp, &tfs);
878 case TF_MODULE_TYPE_IDENTIFIER:
879 if (tfs->id_db_handle)
880 *db_handle = tfs->id_db_handle;
884 case TF_MODULE_TYPE_TABLE:
885 if (tfs->tbl_db_handle)
886 *db_handle = tfs->tbl_db_handle;
891 case TF_MODULE_TYPE_TCAM:
892 if (tfs->tcam_db_handle)
893 *db_handle = tfs->tcam_db_handle;
897 case TF_MODULE_TYPE_EM:
898 if (tfs->em_db_handle)
899 *db_handle = tfs->em_db_handle;
912 tf_session_set_db(struct tf *tfp,
913 enum tf_module_type type,
916 struct tf_session *tfs = NULL;
922 rc = tf_session_get_session_internal(tfp, &tfs);
927 case TF_MODULE_TYPE_IDENTIFIER:
928 tfs->id_db_handle = db_handle;
930 case TF_MODULE_TYPE_TABLE:
931 tfs->tbl_db_handle = db_handle;
933 case TF_MODULE_TYPE_TCAM:
934 tfs->tcam_db_handle = db_handle;
936 case TF_MODULE_TYPE_EM:
937 tfs->em_db_handle = db_handle;